BlobBatch class
BlobBatch 表示对 Blob 的聚合作集。
目前仅支持 delete
和 setAccessTier
。
方法
delete |
deleteBlob作标记要删除的指定 Blob 或快照。 稍后在垃圾回收期间删除该 Blob。 每个批处理请求只允许一种作。 请注意,若要删除 Blob,必须删除其所有快照。 可以同时删除两者。 请参阅 删除作详细信息。 该作将通过指定的凭据进行身份验证和授权。 请参阅 blob 批处理授权详细信息。 |
delete |
deleteBlob作标记要删除的指定 Blob 或快照。 稍后在垃圾回收期间删除该 Blob。 每个批处理请求只允许一种作。 请注意,若要删除 Blob,必须删除其所有快照。 可以同时删除两者。 请参阅 删除作详细信息。 该作将通过指定的凭据进行身份验证和授权。 请参阅 blob 批处理授权详细信息。 |
get |
获取子请求的已组装 HTTP 请求正文。 |
get |
获取批处理请求的 Content-Type 值。 该值必须与批处理边界多部分/混合。 示例:多部分/混合;boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252 |
get |
获取添加到批处理请求中的子请求。 |
set |
setBlobAccessTier作设置 Blob 上的层。 在 Blob 存储或常规用途 v2 帐户中的块 Blob 上允许此作。 每个批处理请求只允许一种作。 块 Blob 层确定热/冷/存档存储类型。 此作不会更新 Blob 的 ETag。 有关块 blob 级别分层的详细信息,请参阅 热、冷和存档访问层。 该作将通过指定的凭据进行身份验证和授权。 请参阅 blob 批处理授权详细信息。 |
set |
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。
- options
- BlobDeleteOptions
返回
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。
- options
- BlobDeleteOptions
返回
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
- options
- BlobSetTierOptions
返回
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
- options
- BlobSetTierOptions
返回
Promise<void>