通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

BlobBatchClient class

  • 参考
包:
@azure/storage-blob

BlobBatchClient 允许对 Azure 存储 Blob 服务发出批处理请求。

请参阅https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

构造函数

BlobBatchClient(string, PipelineLike)

创建 BlobBatchClient 的实例。
BlobBatchClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

创建 BlobBatchClient 的实例。

方法

createBatch()

创建 BlobBatch。 BlobBatch 表示对 Blob 的一组聚合操作。
deleteBlobs(BlobClient[], BlobDeleteOptions)

创建多个删除操作以标记要删除的指定 Blob 或快照。 请注意，要删除 Blob，必须删除其所有快照。 可以同时删除这两者。 请参阅 删除操作详细信息。 将使用指定的凭据对 (子请求) 的操作进行身份验证和授权。 请参阅 Blob 批处理授权详细信息。
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

创建多个删除操作以标记要删除的指定 Blob 或快照。 请注意，要删除 Blob，必须删除其所有快照。 可以同时删除这两者。 请参阅 删除操作详细信息。 将使用指定的凭据对操作进行身份验证和授权。 请参阅 Blob 批处理授权详细信息。
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

创建多个设置层操作以在 Blob 上设置层。 在高级存储帐户中的页 Blob 上和 blob 存储帐户中的块 blob 上允许此操作， (本地冗余存储仅) 。 高级页 Blob 的层确定 Blob 允许的大小、IOPS 和带宽。 块 Blob 的层确定热/冷/存档存储类型。 此操作不会更新 Blob 的 ETag。 请参阅 设置 Blob 层详细信息。 将使用指定的凭据对 (子请求) 的操作进行身份验证和授权。请参阅 Blob 批处理授权详细信息。
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

创建多个设置层操作以在 Blob 上设置层。 在高级存储帐户中的页 Blob 上和 blob 存储帐户中的块 blob 上允许此操作， (本地冗余存储仅) 。 高级页 Blob 的层确定 Blob 允许的大小、IOPS 和带宽。 块 Blob 的层确定热/冷/存档存储类型。 此操作不会更新 Blob 的 ETag。 请参阅 设置 Blob 层详细信息。 将使用指定的凭据对 (子请求) 的操作进行身份验证和授权。请参阅 Blob 批处理授权详细信息。
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

提交包含多个子请求的批处理请求。

在运行代码片段之前获取 blobBatchClient 和其他详细信息。 blobServiceClient.getBlobBatchClient() 为 blobBatchClient

用法示例：

let batchRequest = new BlobBatch();
await batchRequest.deleteBlob(urlInString0, credential0);
await batchRequest.deleteBlob(urlInString1, credential1, {
 deleteSnapshots: "include"
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

使用租约的示例：

let batchRequest = new BlobBatch();
await batchRequest.setBlobAccessTier(blockBlobClient0, "Cool");
await batchRequest.setBlobAccessTier(blockBlobClient1, "Cool", {
 conditions: { leaseId: leaseId }
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

请参见https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

构造函数详细信息

BlobBatchClient(string, PipelineLike)

创建 BlobBatchClient 的实例。

new BlobBatchClient(url: string, pipeline: PipelineLike)

参数

url

string

指向 Azure 存储 Blob 服务的 URL，例如“https://myaccount.blob.core.windows.net"”。 如果使用 AnonymousCredential，则可以追加 SAS，例如“https://myaccount.blob.core.windows.net?sasString"”。

pipeline
PipelineLike

调用 newPipeline () 以创建默认管道或提供自定义管道。

BlobBatchClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

创建 BlobBatchClient 的实例。

new BlobBatchClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

参数

url

string

指向 Azure 存储 Blob 服务的 URL，例如“https://myaccount.blob.core.windows.net"”。 如果使用 AnonymousCredential，则可以追加 SAS，例如“https://myaccount.blob.core.windows.net?sasString"”。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

例如 AnonymousCredential、StorageSharedKeyCredential 或包中的任何 @azure/identity 凭据，用于对服务的请求进行身份验证。 还可以提供实现 TokenCredential 接口的对象。 如果未指定，则使用 AnonymousCredential。

options
StoragePipelineOptions

用于配置 HTTP 管道的选项。

方法详细信息

createBatch()

创建 BlobBatch。 BlobBatch 表示对 Blob 的一组聚合操作。

function createBatch(): BlobBatch

返回

BlobBatch

deleteBlobs(BlobClient[], BlobDeleteOptions)

创建多个删除操作以标记要删除的指定 Blob 或快照。 请注意，要删除 Blob，必须删除其所有快照。 可以同时删除这两者。 请参阅 删除操作详细信息。 将使用指定的凭据对 (子请求) 的操作进行身份验证和授权。 请参阅 Blob 批处理授权详细信息。

function deleteBlobs(blobClients: BlobClient[], options?: BlobDeleteOptions): Promise<BlobBatchSubmitBatchResponse>

参数

blobClients

BlobClient[]

要删除的 Blob 的 BlobClients。

options
BlobDeleteOptions

返回

Promise<BlobBatchSubmitBatchResponse>

deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

创建多个删除操作以标记要删除的指定 Blob 或快照。 请注意，要删除 Blob，必须删除其所有快照。 可以同时删除这两者。 请参阅 删除操作详细信息。 将使用指定的凭据对操作进行身份验证和授权。 请参阅 Blob 批处理授权详细信息。

function deleteBlobs(urls: string[], credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobDeleteOptions): Promise<BlobBatchSubmitBatchResponse>

参数

urls

string[]

要删除的 Blob 资源的 URL。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

例如 AnonymousCredential、StorageSharedKeyCredential 或包中的任何 @azure/identity 凭据，用于对服务的请求进行身份验证。 还可以提供实现 TokenCredential 接口的对象。 如果未指定，则使用 AnonymousCredential。

options
BlobDeleteOptions

返回

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

创建多个设置层操作以在 Blob 上设置层。 在高级存储帐户中的页 Blob 上和 blob 存储帐户中的块 blob 上允许此操作， (本地冗余存储仅) 。 高级页 Blob 的层确定 Blob 允许的大小、IOPS 和带宽。 块 Blob 的层确定热/冷/存档存储类型。 此操作不会更新 Blob 的 ETag。 请参阅 设置 Blob 层详细信息。 将使用指定的凭据对 (子请求) 的操作进行身份验证和授权。请参阅 Blob 批处理授权详细信息。

function setBlobsAccessTier(blobClients: BlobClient[], tier: AccessTier, options?: BlobSetTierOptions): Promise<BlobBatchSubmitBatchResponse>

参数

blobClients

BlobClient[]

应具有新层集的 Blob 的 BlobClients。

tier
AccessTier
options
BlobSetTierOptions

返回

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

创建多个设置层操作以在 Blob 上设置层。 在高级存储帐户中的页 Blob 上和 blob 存储帐户中的块 blob 上允许此操作， (本地冗余存储仅) 。 高级页 Blob 的层确定 Blob 允许的大小、IOPS 和带宽。 块 Blob 的层确定热/冷/存档存储类型。 此操作不会更新 Blob 的 ETag。 请参阅 设置 Blob 层详细信息。 将使用指定的凭据对 (子请求) 的操作进行身份验证和授权。请参阅 Blob 批处理授权详细信息。

function setBlobsAccessTier(urls: string[], credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, tier: AccessTier, options?: BlobSetTierOptions): Promise<BlobBatchSubmitBatchResponse>

参数

urls

string[]

要删除的 Blob 资源的 URL。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

例如 AnonymousCredential、StorageSharedKeyCredential 或包中的任何 @azure/identity 凭据，用于对服务的请求进行身份验证。 还可以提供实现 TokenCredential 接口的对象。 如果未指定，则使用 AnonymousCredential。

tier
AccessTier
options
BlobSetTierOptions

返回

Promise<BlobBatchSubmitBatchResponse>

submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

提交包含多个子请求的批处理请求。

在运行代码片段之前获取 blobBatchClient 和其他详细信息。 blobServiceClient.getBlobBatchClient() 为 blobBatchClient

用法示例：

let batchRequest = new BlobBatch();
await batchRequest.deleteBlob(urlInString0, credential0);
await batchRequest.deleteBlob(urlInString1, credential1, {
 deleteSnapshots: "include"
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

使用租约的示例：

let batchRequest = new BlobBatch();
await batchRequest.setBlobAccessTier(blockBlobClient0, "Cool");
await batchRequest.setBlobAccessTier(blockBlobClient1, "Cool", {
 conditions: { leaseId: leaseId }
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

请参见https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

function submitBatch(batchRequest: BlobBatch, options?: BlobBatchSubmitBatchOptionalParams): Promise<BlobBatchSubmitBatchResponse>

参数

batchRequest
BlobBatch

一组 Delete 或 SetTier 操作。

options
BlobBatchSubmitBatchOptionalParams

返回

Promise<BlobBatchSubmitBatchResponse>