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

BlobBatch class

BlobBatch 表示对 Blob 的一组聚合操作。 目前仅 delete 支持 和 setAccessTier

方法

deleteBlob(BlobClient, BlobDeleteOptions)

deleteBlob 操作标记要删除的指定 Blob 或快照。 该 Blob 将在稍后的垃圾回收期间删除。 每个批处理请求只允许一种操作。

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

deleteBlob(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

deleteBlob 操作标记要删除的指定 Blob 或快照。 该 Blob 将在稍后的垃圾回收期间删除。 每个批处理请求只允许一种操作。

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

getHttpRequestBody()

获取子请求的已组合 HTTP 请求正文。

getMultiPartContentType()

获取批处理请求的 Content-Type 值。 该值必须是多部分/与批处理边界混合的。 示例:多部分/混合;boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252

getSubRequests()

获取添加到批处理请求中的子请求。

setBlobAccessTier(BlobClient, AccessTier, BlobSetTierOptions)

setBlobAccessTier 操作设置 Blob 上的层。 允许对 Blob 存储或常规用途 v2 帐户中的块 Blob 执行该操作。 每个批处理请求只允许一种操作。

块 Blob 的层确定热/冷/存档存储类型。 此操作不会更新 Blob 的 ETag。 有关块 Blob 级别分层的详细信息 ,请参阅热、冷和存档访问层。 将使用指定的凭据对操作进行身份验证和授权。 请参阅 Blob 批处理授权详细信息

setBlobAccessTier(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

setBlobAccessTier 操作设置 Blob 上的层。 允许对 Blob 存储或常规用途 v2 帐户中的块 Blob 执行该操作。 每个批处理请求只允许一种操作。

块 Blob 的层确定热/冷/存档存储类型。 此操作不会更新 Blob 的 ETag。 有关块 Blob 级别分层的详细信息 ,请参阅热、冷和存档访问层。 将使用指定的凭据对操作进行身份验证和授权。 请参阅 Blob 批处理授权详细信息

方法详细信息

deleteBlob(BlobClient, BlobDeleteOptions)

deleteBlob 操作标记要删除的指定 Blob 或快照。 该 Blob 将在稍后的垃圾回收期间删除。 每个批处理请求只允许一种操作。

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

function deleteBlob(blobClient: BlobClient, options?: BlobDeleteOptions): Promise<void>

参数

blobClient
BlobClient

BlobClient。

返回

Promise<void>

deleteBlob(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

deleteBlob 操作标记要删除的指定 Blob 或快照。 该 Blob 将在稍后的垃圾回收期间删除。 每个批处理请求只允许一种操作。

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

function deleteBlob(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobDeleteOptions): Promise<void>

参数

url

string

要删除的 Blob 资源的 URL。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

返回

Promise<void>

getHttpRequestBody()

获取子请求的已组合 HTTP 请求正文。

function getHttpRequestBody(): string

返回

string

getMultiPartContentType()

获取批处理请求的 Content-Type 值。 该值必须是多部分/与批处理边界混合的。 示例:多部分/混合;boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252

function getMultiPartContentType(): string

返回

string

getSubRequests()

获取添加到批处理请求中的子请求。

function getSubRequests(): Map<number, BatchSubRequest>

返回

Map<number, BatchSubRequest>

setBlobAccessTier(BlobClient, AccessTier, BlobSetTierOptions)

setBlobAccessTier 操作设置 Blob 上的层。 允许对 Blob 存储或常规用途 v2 帐户中的块 Blob 执行该操作。 每个批处理请求只允许一种操作。

块 Blob 的层确定热/冷/存档存储类型。 此操作不会更新 Blob 的 ETag。 有关块 Blob 级别分层的详细信息 ,请参阅热、冷和存档访问层。 将使用指定的凭据对操作进行身份验证和授权。 请参阅 Blob 批处理授权详细信息

function setBlobAccessTier(blobClient: BlobClient, tier: AccessTier, options?: BlobSetTierOptions): Promise<void>

参数

blobClient
BlobClient

BlobClient。

tier
AccessTier

返回

Promise<void>

setBlobAccessTier(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

setBlobAccessTier 操作设置 Blob 上的层。 允许对 Blob 存储或常规用途 v2 帐户中的块 Blob 执行该操作。 每个批处理请求只允许一种操作。

块 Blob 的层确定热/冷/存档存储类型。 此操作不会更新 Blob 的 ETag。 有关块 Blob 级别分层的详细信息 ,请参阅热、冷和存档访问层。 将使用指定的凭据对操作进行身份验证和授权。 请参阅 Blob 批处理授权详细信息

function setBlobAccessTier(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, tier: AccessTier, options?: BlobSetTierOptions): Promise<void>

参数

url

string

要删除的 Blob 资源的 URL。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

tier
AccessTier

返回

Promise<void>