你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
@azure/storage-blob 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) 。 |
AppendBlobClient |
AppendBlobClient 定义了一组适用于追加 blob 的操作。 |
BaseRequestPolicy |
派生所有请求策略的基类。 |
BlobBatch |
BlobBatch 表示对 Blob 的一组聚合操作。
目前仅 |
BlobBatchClient |
BlobBatchClient 允许对 Azure 存储 Blob 服务发出批处理请求。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch |
BlobClient |
BlobClient 表示 Azure 存储 Blob 的 URL;blob 可以是块 Blob、追加 blob 或页 Blob。 |
BlobLeaseClient |
管理 ContainerClient 或 BlobClient 的租约的客户端。 |
BlobSASPermissions |
仅在 NODE.JS RUNTIME 中可用。 这是一个帮助程序类,用于构造表示 ServiceSAS 授予 Blob 的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后,应使用 toString 进行序列化,并将其设置为 BlobSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串,但权限的顺序是特定的,此类可以保证正确性。 |
BlobServiceClient |
BlobServiceClient 表示 Azure 存储 Blob 服务的客户端,允许你操作 Blob 容器。 |
BlockBlobClient |
BlockBlobClient 定义了一组适用于块 Blob 的操作。 |
ContainerClient |
ContainerClient 表示 Azure 存储容器的 URL,可用于操作其 Blob。 |
ContainerSASPermissions |
这是一个帮助程序类,用于构造表示 ServiceSAS 授予容器的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该操作的权限。 设置所有值后,应使用 toString 进行序列化,并将其设置为 BlobSASSignatureValues 对象上的权限字段。 可以在没有此类的情况下构造权限字符串,但权限的顺序是特定的,此类保证正确性。 |
Credential |
Credential 是 Azure 存储 HTTP 请求签名的抽象类。 此类将托管一个生成 CredentialPolicy 的 credentialPolicyCreator 工厂。 |
CredentialPolicy |
用于在发送请求之前对 HTTP (S) 请求进行签名的凭据策略。 这是一个抽象类。 |
HttpHeaders |
HTTP 标头键/值对的集合。 |
PageBlobClient |
PageBlobClient 定义一组适用于页 Blob 的操作。 |
Pipeline |
包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 newPipeline 创建默认管道。 或者,可以通过 Pipeline 的构造函数使用自己的策略创建管道。 在实现自定义管道之前,请参阅 newPipeline 和提供的策略。 |
RequestPolicyOptions |
创建 RequestPolicy 时可以使用的可选属性。 |
RestError |
向服务终结点发出 HTTP 请求导致的错误。 |
SASQueryParameters |
表示构成 Azure 存储 SAS 查询参数的组件。 此类型不是由用户直接构造的;它仅由 AccountSASSignatureValues 和 BlobSASSignatureValues 类型生成。 生成后,可以将其编码为 toString() ,并直接 (追加到 URL 中,但如果存在现有的查询参数,则此处应小心,这可能会影响将这些查询参数追加到) 的适当方法。 注意:此类的实例是不可变的。 |
StorageBrowserPolicy |
StorageBrowserPolicy 将处理 Node.js 和浏览器运行时之间的差异,包括:
|
StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory 是一个工厂类,可帮助生成 StorageBrowserPolicy 对象。 |
StorageRetryPolicy |
实现指数重试和线性重试的重试策略。 |
StorageRetryPolicyFactory |
StorageRetryPolicyFactory 是一个工厂类,可帮助生成 StorageRetryPolicy 对象。 |
StorageSharedKeyCredential |
仅在 NODE.JS RUNTIME 中可用。 用于 Azure 存储服务的帐户密钥授权的 StorageSharedKeyCredential。 |
StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy 是一种策略,用于使用共享密钥对 HTTP 请求进行签名。 |
WebResource |
创建新的 WebResource 对象。 此类通过与库/实现无关并包装启动请求所需的属性来对 REST 调用进行抽象。 |
接口
类型别名
枚举
BlockBlobTier |
表示 Blob 上的访问层。 有关块 Blob 级别分层的详细信息 ,请参阅热、冷和存档存储层。 |
KnownEncryptionAlgorithmType |
服务接受的 EncryptionAlgorithmType 的已知值。 |
PremiumPageBlobTier |
指定要将 Blob 设置为的页 Blob 层。 这仅适用于高级存储帐户上的页 Blob。 有关每个 PageBlobTier 的相应 IOPS 和吞吐量的详细信息,请参阅 此处 。 |
SASProtocol |
生成的 SAS 的协议。 |
StorageBlobAudience |
定义存储的已知云受众。 |
StorageRetryPolicyType |
RetryPolicy 类型。 |
函数
deserialization |
创建一个新的序列化 RequestPolicyCreator,它将在 HTTP 请求正文通过 HTTP 管道时序列化这些正文。 |
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 & 权限。 在运行以下代码片段之前,请填写所需的详细信息。 用法示例:
使用标识符的示例:
使用 Blob 名称的示例:
|
generate |
仅在 NODE.JS RUNTIME 中可用。 创建 SASQueryParameters 的实例。 警告:生成用户委托 SAS 时,将忽略标识符,需要权限和 expiresOn。 用法示例:
|
get |
|
is |
用于确定给定参数是否满足管道协定的帮助程序 |
new |
使用提供的凭据创建新的 Pipeline 对象。 |
函数详细信息
deserializationPolicy(DeserializationContentTypes, SerializerOptions)
创建一个新的序列化 RequestPolicyCreator,它将在 HTTP 请求正文通过 HTTP 管道时序列化这些正文。
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory
参数
- deserializationContentTypes
- DeserializationContentTypes
- parsingOptions
- SerializerOptions
返回
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
返回
generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)
仅在 NODE.JS RUNTIME 中可用。
创建 SASQueryParameters 的实例。
仅接受创建 SAS 所需的设置。 对于可选设置,请直接设置相应的属性,例如 permissions、startsOn 和 identifier。
警告:如果未提供标识符,则需要权限和 expiresOn。 如果最初使用此构造函数,则必须将值分配给 identifier 或 expiresOn & 权限。
在运行以下代码片段之前,请填写所需的详细信息。
用法示例:
// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
containerName, // 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 container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
{
accessPolicy: {
expiresOn: new Date(new Date().valueOf() + 86400), // Date type
permissions: ContainerSASPermissions.parse("racwdl").toString(),
startsOn: new Date() // Date type
},
id: identifier
}
]);
const containerSAS = generateBlobSASQueryParameters(
{
containerName, // Required
identifier // Required
},
sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
使用 Blob 名称的示例:
// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
containerName, // Required
blobName, // Required
permissions: BlobSASPermissions.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 generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
参数
- blobSASSignatureValues
- BlobSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
返回
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)
仅在 NODE.JS RUNTIME 中可用。
创建 SASQueryParameters 的实例。 警告:生成用户委托 SAS 时,将忽略标识符,需要权限和 expiresOn。
用法示例:
// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
containerName, // Required
permissions: ContainerSASPermissions.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 generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters
参数
- blobSASSignatureValues
- BlobSASSignatureValues
- userDelegationKey
- UserDelegationKey
的返回值 blobServiceClient.getUserDelegationKey()
- accountName
-
string
返回
getBlobServiceAccountAudience(string)
function getBlobServiceAccountAudience(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 对象。