BatchDeleteRequest class
A BatchDeleteRequest represents a batch delete request, which consists of one or more delete operations.
- Extends
Constructors
| Batch |
Methods
| add |
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. |
| add |
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. |
| get |
Get assembled HTTP request body for sub requests. |
| get |
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 |
| get |
Get sub requests that are added into the batch request. |
Constructor Details
BatchDeleteRequest()
new BatchDeleteRequest()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)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)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>
getHttpRequestBody()
Get assembled HTTP request body for sub requests.
function getHttpRequestBody()Returns
string
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()Returns
string
getSubRequests()
Get sub requests that are added into the batch request.
function getSubRequests()Returns
Map<number, BatchSubRequest>
