@azure/storage-file-datalake package

仅在NODE.JS运行时中可用。

这是一个帮助程序类，用于构造表示 AccountSAS 授予的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该作的权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 AccountSASSignatureValues 对象的权限字段。 可以构造不带此类的权限字符串，但权限的顺序是特定的，此类保证正确性。

仅在NODE.JS运行时中可用。

这是一个帮助程序类，用于构造表示 AccountSAS 可访问的资源的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该资源类型的访问权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 AccountSASSignatureValues 对象上的资源字段。 可以构造没有此类的资源字符串，但资源的顺序是特定的，此类保证正确性。

仅在NODE.JS运行时中可用。

这是一个帮助程序类，用于构造表示 AccountSAS 可访问的服务的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该服务的访问权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 AccountSASSignatureValues 对象的服务字段。 可以构造没有此类的服务字符串，但服务的顺序是特定的，此类保证正确性。

AnonymousCredential 提供 credentialPolicyCreator 成员，用于创建 AnonymousCredentialPolicy 对象。 AnonymousCredentialPolicy 与 HTTP（S） 请求一起使用，这些请求读取公共资源或用于共享访问签名（SAS）。

AnonymousCredentialPolicy 与 HTTP（S） 请求一起使用，这些请求读取公共资源或用于共享访问签名（SAS）。

从中派生所有请求策略的基类。

凭据是 Azure 存储 HTTP 请求签名的抽象类。 此类将托管生成 CredentialPolicy 的 credentialPolicyCreator 工厂。

用于在发送之前对 HTTP（S） 请求进行签名的凭据策略。 这是一个抽象类。

作中断时引发的错误，以后可以继续。

DataLakeDirectoryClient 表示 Azure 存储目录的 URL。

DataLakeFileClient 表示 Azure 存储文件的 URL。

DataLakeFileSystemClient 表示 Azure 存储文件系统的 URL，允许你作其目录和文件。

DataLakePathClient 表示 Azure 存储路径（目录或文件）的 URL。

仅在NODE.JS运行时中可用。

这是一个帮助程序类，用于构造表示 ServiceSAS 授予的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该作的权限。 设置所有值后，应使用 toString 序列化此值，并将其设置为 DataLakeSASSignatureValues 对象的权限字段。 可以构造不带此类的权限字符串，但权限的顺序是特定的，此类保证正确性。

DataLakeServiceClient 允许你作 Azure Data Lake 服务资源和文件系统。 存储帐户为 Data Lake 服务提供顶级命名空间。

这是一个帮助程序类，用于构造表示 ServiceSAS 授予目录的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该作的权限。 设置所有值后，应使用 toString 序列化此值，并将其设置为 DataLakeSASSignatureValues 对象的权限字段。 可以构造不带此类的权限字符串，但权限的顺序是特定的，此类保证正确性。

这是一个帮助程序类，用于构造表示 ServiceSAS 授予给容器的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该作的权限。 设置所有值后，应使用 toString 序列化此值，并将其设置为 DataLakeSASSignatureValues 对象的权限字段。 可以构造不带此类的权限字符串，但权限的顺序是特定的，此类保证正确性。

包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 newPipeline来创建默认管道。 或者，可以通过管道构造函数创建自己的策略的管道。

在实施自定义管道之前，请参阅 newPipeline 和提供的策略。

表示构成 Azure 存储 SAS 查询参数的组件。 此类型不是由用户直接构造的;它仅由 AccountSASSignatureValues 和 <xref:BlobSASSignatureValues> 类型生成。 生成后，可以将其编码为 toString() 并直接追加到 URL（不过，如果存在现有的查询参数，这可能会影响追加这些查询参数的适当方式），应谨慎使用。

注意：此类的实例是不可变的。

StorageBrowserPolicy 将处理 Node.js 和浏览器运行时之间的差异，包括：

1. 浏览器通过添加条件标头（如“IF_MODIFIED_SINCE”）来缓存 GET/HEAD 请求。 StorageBrowserPolicy 是一种策略，用于将时间戳查询添加到 GET/HEAD 请求 URL，从而避免浏览器缓存。

2. 删除 Cookie 标头以安全

3. 删除内容长度标头以避免浏览器警告

StorageBrowserPolicyFactory 是帮助生成 StorageBrowserPolicy 对象的工厂类。

实现指数重试和线性重试的重试策略。

StorageRetryPolicyFactory 是一个工厂类，可帮助生成 StorageRetryPolicy 对象。

仅在NODE.JS运行时中可用。

Azure 存储服务的帐户密钥授权的 StorageSharedKeyCredential。

StorageSharedKeyCredentialPolicy 是用于使用共享密钥对 HTTP 请求进行签名的策略。

AccessControlChangeCounters 包含以递归方式更改访问控制列表的作计数。

表示在 setAccessControlRecursive、updateAccessControlRecursive 和 removeAccessControlRecursive期间未能更新访问控制列表的条目。

AccessControlChanges 包含以递归方式更改访问控制列表的作的批处理和累积计数。 此外，它还公开这些作进行时未能更新的路径条目。

仅在NODE.JS运行时中可用。

AccountSASSignatureValues 用于为 Azure 存储帐户生成共享访问签名（SAS）。 正确设置此处的所有值后，调用 生成AccountSASQueryParameters 以获取 SAS 的表示形式，该 SAS 实际上可应用于 Data Lake URL。 注意：此类和 SASQueryParameters 存在，因为前者是可变的，逻辑表示形式，而后者是不可变的，用于生成实际的 REST 请求。

有关 SAS 的更多概念性信息，请参阅 https://learn.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas，了解参数的说明，包括所需的参数

Azure 存储 Blob

Blob 的属性

FileSystemGenerateSasUrlOptions、DirectoryGenerateSasUrlOptions 和 FileGenerateSasUrlOptions的常见选项。

每个远程作通用选项的接口。

参数组

参数组

仅在NODE.JS运行时中可用。

DataLakeSASSignatureValues 用于帮助为容器、Blob、文件系统、目录和文件生成 Blob 和 DataLake 服务 SAS 令牌。

存储服务属性。

每个远程作通用选项的接口。

包含 createIfNotExists作的响应数据。

用于配置 generateSasUrl作的选项。

每个远程作通用选项的接口。

每个远程作通用选项的接口。

包含 createIfNotExists作的响应数据。

每个远程作通用选项的接口。

每个远程作通用选项的接口。

用于配置 generateSasUrl作的选项。

Data Lake 文件的选项接口 - 上传作

看：

• 上传
• uploadFile
• uploadStream

使用 CSV 格式查询文件的选项。

文件查询错误类型。

用于查询 JSON 格式的文件的选项。

Data Lake 文件的选项接口 - 查询作

看：

• 查询

使用 Parquet 格式查询文件的选项。

Data Lake 文件的选项接口 - readToBuffer作

看：

• readToBuffer

定义Path_setExpiry作的标头。

setExpiry作的选项接口。

包含 createIfNotExists作的响应数据。

包含 deleteIfExists作的响应数据。

每个远程作通用选项的接口。

用于在文件系统上指定加密范围的选项。

Data Lake 文件系统的选项接口存在作

看：

• 存在

用于配置 generateSasUrl作的选项。

每个远程作通用选项的接口。

每个远程作通用选项的接口。

定义FileSystem_listBlobHierarchySegment作的标头。

定义FileSystem_listPaths作的标头。

每个远程作通用选项的接口。

每个远程作通用选项的接口。

每个远程作通用选项的接口。

HTTP 标头键/值对的集合。

与 core-v1（core-http）兼容的 Http 响应。

core-http 请求策略的兼容接口

特定租约的详细信息。

参数组

配置租约作。

Blob 的枚举

每个远程作通用选项的接口。

每个远程作通用选项的接口。

每个远程作通用选项的接口。

每个远程作通用选项的接口。

定义Path_appendData作的标头。

setAccessControlRecursive、updateAccessControlRecursive 和 removeAccessControlRecursive的选项类型。

setAccessControlRecursive、updateAccessControlRecursive 和 removeAccessControlRecursive的响应类型。

定义Path_create作的标头。

每个远程作通用选项的接口。

包含 createIfNotExists作的响应数据。

每个远程作通用选项的接口。

定义Path_delete作的标头。

包含 deleteIfExists作的响应数据。

每个远程作通用选项的接口。

Data Lake 目录/文件的选项接口存在作

看：

• 存在

定义Path_flushData作的标头。

每个远程作通用选项的接口。

定义Path_getProperties作的标头。

每个远程作通用选项的接口。

每个远程作通用选项的接口。

定义Path_setAccessControl作的标头。

每个远程作通用选项的接口。

每个远程作通用选项的接口。

每个远程作通用选项的接口。

每个远程作通用选项的接口。

定义Path_undelete作的标头。

定义Path_update作的标头。

包含 HTTP 请求策略的 Pipeline 类的接口。 可以通过调用 newPipeline来创建默认管道。 或者，可以通过管道构造函数创建自己的策略的管道。

在实施自定义管道之前，请参阅 newPipeline 和提供的策略。

管道构造函数的选项接口。

与 core-http 的 RequestPolicyFactory 兼容的接口

与 RequestPolicy 兼容的接口

失败管道请求的自定义错误类型。

用于构造 SASQueryParameters的选项。

SAS 允许的 IP 范围。

@azure/core-http ServiceClientOptions 的子集

用于配置 generateAccountSasUrl作的选项。

每个远程作通用选项的接口。

用于配置 undeleteFileSystem的选项。

newPipeline 函数的选项接口。

存储 Blob 重试选项接口。

用户委派密钥

要向远程服务器发出的 HTTP 请求的说明。

包含 getProperties作的响应数据。

定义 EncryptionAlgorithmType 的值。
<xref:KnownEncryptionAlgorithmType> 可与 EncryptionAlgorithmType 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

无
AES256

定义 PathExpiryOptions 的值。

使用 Apache Arrow 格式查询文件的选项。 仅适用于 outputTextConfiguration。

包含 <xref:DataLakeServiceClient.renameFileSystem>作的响应数据。

包含 undeleteFileSystem作的响应数据。

请求支持的类型。 NodeJS.ReadableStream 和 （） => NodeJS.ReadableStream 仅是 Node。 Blob、ReadableStream 和 （） => ReadableStream 仅浏览器。

包含创建、修改或删除租约的作的响应数据。

请参阅 <xref:BlobLeaseClient>。

定义 PathGetPropertiesAction 的值。

定义 PathRenameMode 的值。

定义 PathResourceType 的值。

包含 listContainersSegment作的响应数据。

用于配置 <xref:DataLakeServiceClient.renameFileSystem>的选项。

定义 PathGetPropertiesAction 的值。 可能的值包括：“getAccessControl”、“getStatus”

定义 PathRenameMode 的值。 可能的值包括：“legacy”、“posix”

定义 PathResourceType 的值。 可能的值包括：“directory”、“file”

生成的 SAS 的协议。

定义存储的已知云受众。

RetryPolicy 类型。

仅在NODE.JS运行时中可用。

生成 SASQueryParameters 对象，该对象包含发出实际 REST 请求所需的所有 SAS 查询参数。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

仅在NODE.JS运行时中可用。

创建 SASQueryParameters 的实例。

仅接受创建 SAS 所需的设置。 对于可选设置，请直接设置相应的属性，例如权限、startsOn 和标识符。

警告：如果未提供标识符，则需要权限和 expiresOn。 如果最初使用此构造函数，则必须将值分配给标识符或 expiresOn & 权限。

在运行以下代码片段之前填写所需的详细信息。

示例

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

在运行代码片段之前填写所需的详细信息。

示例

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

仅在NODE.JS运行时中可用。

创建 SASQueryParameters 的实例。 警告：生成用户委派 SAS、权限和 expiresOn 时，将忽略标识符。

示例

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();

获取 Datalake 服务的存储帐户的 OAuth 受众。

确定给定参数是否满足管道协定的帮助程序

使用提供的凭据创建新的 Pipeline 对象。