BlobBatchClient | @azure/storage-blob

A BlobBatchClient allows you to make batched requests to the Azure Storage Blob service.

see: https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

Hierarchy

BlobBatchClient

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in storage/storage-blob/src/BlobBatchClient.ts:77
Creates an instance of BlobBatchClient.

memberof

BlobBatchClient

Parameters
- url: string
  
  A url pointing to Azure Storage blob service, such as "https://myaccount.blob.core.windows.net". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
- Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
  
  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
- Optional options: StoragePipelineOptions
Returns BlobBatchClient
- Defined in storage/storage-blob/src/BlobBatchClient.ts:93
Creates an instance of BlobBatchClient.

memberof

BlobBatchClient

Parameters
- url: string
  
  A url pointing to Azure Storage blob service, such as "https://myaccount.blob.core.windows.net". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
- pipeline: Pipeline
  
  Call newPipeline() to create a default pipeline, or provide a customized pipeline.
Returns BlobBatchClient

Methods

createBatch

createBatch(): BlobBatch

- Defined in storage/storage-blob/src/BlobBatchClient.ts:133
Creates a BlobBatch. A BlobBatch represents an aggregated set of operations on blobs.

Returns BlobBatch

deleteBlobs

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

- Defined in storage/storage-blob/src/BlobBatchClient.ts:150
Create multiple delete operations to mark the specified blobs or snapshots 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 operations will be authenticated and authorized with specified credential. See blob batch authorization details.

memberof

BlobBatchClient

Parameters
- urls: string[]
  
  The urls of the blob resources to delete.
- credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
  
  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
- Optional options: BlobDeleteOptions
Returns Promise<BlobBatchDeleteBlobsResponse>
- Defined in storage/storage-blob/src/BlobBatchClient.ts:168
Create multiple delete operations to mark the specified blobs or snapshots 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.

memberof

BlobBatchClient

Parameters
- blobClients: BlobClient[]
  
  The BlobClients for the blobs to delete.
- Optional options: BlobDeleteOptions
Returns Promise<BlobBatchDeleteBlobsResponse>

setBlobsAccessTier

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

- Defined in storage/storage-blob/src/BlobBatchClient.ts:212
Create multiple set tier operations to set the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. See set blob tier details. The operation(subrequest) will be authenticated and authorized with specified credential.See blob batch authorization details.

memberof

BlobBatchClient

Parameters
- urls: string[]
  
  The urls of the blob resource to delete.
- credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
  
  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
- tier: AccessTier
- Optional options: BlobSetTierOptions
Returns Promise<BlobBatchSetBlobsAccessTierResponse>
- Defined in storage/storage-blob/src/BlobBatchClient.ts:236
Create multiple set tier operations to set the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. See set blob tier details. The operation(subrequest) will be authenticated and authorized with specified credential.See blob batch authorization details.

memberof

BlobBatchClient

Parameters
- blobClients: BlobClient[]
  
  The BlobClients for the blobs which should have a new tier set.
- tier: AccessTier
- Optional options: BlobSetTierOptions
Returns Promise<BlobBatchSetBlobsAccessTierResponse>

submitBatch

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

Submit batch request which consists of multiple subrequests.

Get blobBatchClient and other details before running the snippets. blobServiceClient.getBlobBatchClient() gives the blobBatchClient

example

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);

example

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);

see

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

memberof

BlobBatchClient

Parameters

batchRequest: BlobBatch

A set of Delete or SetTier operations.
Default value options: BlobBatchSubmitBatchOptionalParams = {}

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

url: string

Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Optional options: StoragePipelineOptions

Returns BlobBatchClient

Parameters

url: string

pipeline: Pipeline

Returns BlobBatchClient

Methods

createBatch

Returns BlobBatch

deleteBlobs

Parameters

urls: string[]

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Optional options: BlobDeleteOptions

Returns Promise<BlobBatchDeleteBlobsResponse>

Parameters

blobClients: BlobClient[]

Optional options: BlobDeleteOptions

Returns Promise<BlobBatchDeleteBlobsResponse>

setBlobsAccessTier

Parameters

urls: string[]

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

tier: AccessTier

Optional options: BlobSetTierOptions

Returns Promise<BlobBatchSetBlobsAccessTierResponse>

Parameters

blobClients: BlobClient[]

tier: AccessTier

Optional options: BlobSetTierOptions

Returns Promise<BlobBatchSetBlobsAccessTierResponse>

submitBatch

Parameters

batchRequest: BlobBatch

Default value options: BlobBatchSubmitBatchOptionalParams = {}

Returns Promise<BlobBatchSubmitBatchResponse>