你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
@azure/storage-file-datalake package
类
| AccountSASPermissions |
仅在 NODE.JS RUNTIME 中可用。 这是一个帮助程序类，用于构造表示 AccountSAS 授予的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后，应使用 toString 对此进行序列化，并将其设置为 AccountSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串，但权限的顺序是特定的，此类可以保证正确性。 |
| AccountSASResourceTypes |
仅在 NODE.JS RUNTIME 中可用。 这是一个帮助程序类，用于构造表示 AccountSAS 可访问的资源的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该资源类型的访问权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 AccountSASSignatureValues 对象上的资源字段。 可以在没有此类的情况下构造资源字符串，但资源的顺序是特定的，此类保证正确性。 |
| AccountSASServices |
仅在 NODE.JS RUNTIME 中可用。 这是一个帮助程序类，用于构造表示 AccountSAS 可访问的服务的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该服务的访问权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 AccountSASSignatureValues 对象的服务字段。 可以在没有此类的情况下构造服务字符串，但服务的顺序是特殊的，此类保证正确性。 |
| AnonymousCredential |
AnonymousCredential 提供 credentialPolicyCreator 成员，用于创建 AnonymousCredentialPolicy 对象。 AnonymousCredentialPolicy 与 HTTP (S) 请求一起使用，这些请求读取公共资源或用于共享访问签名 (SAS) 。 |
| AnonymousCredentialPolicy |
AnonymousCredentialPolicy 与 HTTP (S) 请求一起使用，这些请求读取公共资源或用于共享访问签名 (SAS) 。 |
| BaseRequestPolicy |
派生所有请求策略的基类。 |
| Credential |
Credential 是 Azure 存储 HTTP 请求签名的抽象类。 此类将托管生成 CredentialPolicy 的 credentialPolicyCreator 工厂。 |
| CredentialPolicy |
用于在发送请求之前对 HTTP (S) 签名的凭据策略。 这是一个抽象类。 |
| DataLakeAclChangeFailedError |
操作中断时引发的错误，以后可以继续操作。 |
| DataLakeDirectoryClient |
DataLakeDirectoryClient 表示 Azure 存储目录的 URL。 |
| DataLakeFileClient |
DataLakeFileClient 表示 Azure 存储文件的 URL。 |
| DataLakeFileSystemClient |
DataLakeFileSystemClient 表示 Azure 存储文件系统的 URL，可用于操作其目录和文件。 |
| DataLakeLeaseClient | |
| DataLakePathClient |
DataLakePathClient 表示 Azure 存储路径 (目录或文件) 的 URL。 |
| DataLakeSASPermissions |
仅在 NODE.JS RUNTIME 中可用。 这是一个帮助程序类，用于构造表示 ServiceSAS 授予的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 DataLakeSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串，但权限的顺序是特定的，此类可以保证正确性。 |
| DataLakeServiceClient |
DataLakeServiceClient 允许你操作 Azure Data Lake 服务资源和文件系统。 存储帐户为 Azure Data Lake 服务提供顶级命名空间。 |
| DirectorySASPermissions |
这是一个帮助程序类，用于构造表示 ServiceSAS 授予目录的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 DataLakeSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串，但权限的顺序是特定的，此类可以保证正确性。 |
| FileSystemSASPermissions |
这是一个帮助程序类，用于构造表示 ServiceSAS 授予容器的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后，应使用 toString 进行序列化，并将其设置为 DataLakeSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串，但权限的顺序是特定的，此类可以保证正确性。 |
| Pipeline |
包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 newPipeline 创建默认管道。 或者，可以通过 Pipeline 的构造函数使用自己的策略创建管道。 在实现自定义管道之前，请参阅 newPipeline 和提供的策略。 |
| RestError |
失败管道请求的自定义错误类型。 |
| SASQueryParameters |
表示构成 Azure 存储 SAS 查询参数的组件。 此类型不是由用户直接构造的;它仅由 AccountSASSignatureValues 和 <xref:BlobSASSignatureValues> 类型生成。 生成后，可以将其编码为 toString() ，并直接 (追加到 URL 中，但如果存在现有的查询参数，则此处应小心，这可能会影响将这些查询参数追加到) 的适当方法。 注意：此类的实例是不可变的。 |
| StorageBrowserPolicy |
StorageBrowserPolicy 将处理 Node.js 和浏览器运行时之间的差异，包括：
|
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory 是一个工厂类，可帮助生成 StorageBrowserPolicy 对象。 |
| StorageRetryPolicy |
实现指数重试和线性重试的重试策略。 |
| StorageRetryPolicyFactory |
StorageRetryPolicyFactory 是一个工厂类，可帮助生成 StorageRetryPolicy 对象。 |
| StorageSharedKeyCredential |
仅在 NODE.JS RUNTIME 中可用。 用于 Azure 存储服务的帐户密钥授权的 StorageSharedKeyCredential。 |
| StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy 是一种策略，用于使用共享密钥对 HTTP 请求进行签名。 |
接口
类型别名
枚举
| PathGetPropertiesAction |
定义 PathGetPropertiesAction 的值。 可能的值包括：“getAccessControl”、“getStatus” |
| PathRenameMode |
定义 PathRenameMode 的值。 可能的值包括：“legacy”、“posix” |
| PathResourceType |
定义 PathResourceType 的值。 可能的值包括：“directory”、“file” |
| SASProtocol |
生成的 SAS 的协议。 |
| StorageDataLakeAudience |
定义存储的已知云受众。 |
| StorageRetryPolicyType |
RetryPolicy 类型。 |
函数
| generate |
仅在 NODE.JS RUNTIME 中可用。 生成 SASQueryParameters 对象，该对象包含发出实际 REST 请求所需的所有 SAS 查询参数。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas |
| generate |
仅在 NODE.JS RUNTIME 中可用。 创建 SASQueryParameters 的实例。 仅接受创建 SAS 所需的设置。 对于可选设置，请直接设置相应的属性，例如 permissions、startsOn 和 identifier。 警告：如果未提供标识符，则需要权限和 expiresOn。 如果最初使用此构造函数，则必须将值分配给 identifier 或 expiresOn & 权限。 在运行以下代码片段之前，请填写所需的详细信息。 示例 在运行代码片段之前，请填写所需的详细信息。 示例 |
| generate |
仅在 NODE.JS RUNTIME 中可用。 创建 SASQueryParameters 的实例。 警告：生成用户委托 SAS 时，将忽略标识符，需要权限和 expiresOn。 示例 |
| get |
获取 datalake 服务的存储帐户的 OAuth 受众。 |
| is |
用于确定给定参数是否满足管道协定的帮助程序 |
| new |
使用提供的凭据创建新的 Pipeline 对象。 |
函数详细信息
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
仅在 NODE.JS RUNTIME 中可用。
生成 SASQueryParameters 对象，该对象包含发出实际 REST 请求所需的所有 SAS 查询参数。
请参见https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters参数
- accountSASSignatureValues
- AccountSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
返回
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)
仅在 NODE.JS RUNTIME 中可用。
创建 SASQueryParameters 的实例。
仅接受创建 SAS 所需的设置。 对于可选设置，请直接设置相应的属性，例如 permissions、startsOn 和 identifier。
警告：如果未提供标识符，则需要权限和 expiresOn。 如果最初使用此构造函数，则必须将值分配给 identifier 或 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();
function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters参数
- dataLakeSASSignatureValues
- DataLakeSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
返回
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)
仅在 NODE.JS RUNTIME 中可用。
创建 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();
function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters参数
- dataLakeSASSignatureValues
- DataLakeSASSignatureValues
- userDelegationKey
- UserDelegationKey
的返回值 blobServiceClient.getUserDelegationKey()
- accountName
-
string
返回
getDataLakeServiceAccountAudience(string)
获取 datalake 服务的存储帐户的 OAuth 受众。
function getDataLakeServiceAccountAudience(storageAccountName: string): string参数
- storageAccountName
-
string
返回
string
isPipelineLike(unknown)
用于确定给定参数是否满足管道协定的帮助程序
function isPipelineLike(pipeline: unknown): pipeline参数
- pipeline
-
unknown
可能是管道的参数
返回
pipeline
当参数满足管道协定时为 true
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
使用提供的凭据创建新的 Pipeline 对象。
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline参数
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
例如 AnonymousCredential、StorageSharedKeyCredential 或包中 @azure/identity 用于对服务请求进行身份验证的任何凭据。 还可以提供实现 TokenCredential 接口的对象。 如果未指定，则使用 AnonymousCredential。
- pipelineOptions
- StoragePipelineOptions
可选。 选项。
返回
一个新的 Pipeline 对象。