BatchDeleteRequest class

Package:

@azure/storage-blob

A BatchDeleteRequest represents a batch delete request, which consists of one or more delete operations.

Extends

BatchRequest

Methods

addSubRequest(BlobURL, IBlobDeleteOptions)	Add a delete operation(subrequest) to mark the specified blob or snapshot for deletion. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time. See delete operation details. The operation(subrequest) will be authenticated and authorized with specified credential. See blob batch authorization details.
addSubRequest(string, Credential, IBlobDeleteOptions)	Add a delete operation(subrequest) to mark the specified blob or snapshot for deletion. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time. See delete operation details. The operation(subrequest) will be authenticated and authorized with specified credential. See blob batch authorization details.

Inherited Methods

getHttpRequestBody()	Get assembled HTTP request body for sub requests.
getMultiPartContentType()	Get the value of Content-Type for a batch request. The value must be multipart/mixed with a batch boundary. Example: multipart/mixed; boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252
getSubRequests()	Get sub requests that are added into the batch request.

Method Details

addSubRequest(BlobURL, IBlobDeleteOptions)

Add a delete operation(subrequest) to mark the specified blob or snapshot for deletion. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time. See delete operation details. The operation(subrequest) will be authenticated and authorized with specified credential. See blob batch authorization details.

function addSubRequest(blobURL: BlobURL, options?: IBlobDeleteOptions): Promise<void>

Parameters

blobURL

BlobURL

options

IBlobDeleteOptions

Returns

Promise<void>

addSubRequest(string, Credential, IBlobDeleteOptions)

Add a delete operation(subrequest) to mark the specified blob or snapshot for deletion. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time. See delete operation details. The operation(subrequest) will be authenticated and authorized with specified credential. See blob batch authorization details.

function addSubRequest(url: string, credential: Credential, options?: IBlobDeleteOptions): Promise<void>

Parameters

url

string

The url of the blob resource to delete.

credential

Credential

The credential to be used for authentication and authorization.

options

IBlobDeleteOptions

Returns

Promise<void>

Inherited Method Details

getHttpRequestBody()

Get assembled HTTP request body for sub requests.

function getHttpRequestBody(): string

Returns

string

Inherited From BatchRequest.getHttpRequestBody

getMultiPartContentType()

Get the value of Content-Type for a batch request. The value must be multipart/mixed with a batch boundary. Example: multipart/mixed; boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252

function getMultiPartContentType(): string

Returns

string

Inherited From BatchRequest.getMultiPartContentType

getSubRequests()

Get sub requests that are added into the batch request.

function getSubRequests(): Map<number, BatchSubRequest>

Returns

Map<number, BatchSubRequest>

Inherited From BatchRequest.getSubRequests