BlobBatchClient.DeleteBlobs Method

Definition

Namespace:

Azure.Storage.Blobs.Specialized

Assembly:

Azure.Storage.Blobs.Batch.dll

Package:

Azure.Storage.Blobs.Batch v12.19.1

Source:

BlobBatchClient.cs

The DeleteBlobs operation marks the specified blobs for deletion. The blobs are later deleted during garbage collection which could take several minutes. All of the deletions are sent as a single batched request.

public virtual Azure.Response[] DeleteBlobs (System.Collections.Generic.IEnumerable<Uri> blobUris, Azure.Storage.Blobs.Models.DeleteSnapshotsOption snapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteBlobs : seq<Uri> * Azure.Storage.Blobs.Models.DeleteSnapshotsOption * System.Threading.CancellationToken -> Azure.Response[]
override this.DeleteBlobs : seq<Uri> * Azure.Storage.Blobs.Models.DeleteSnapshotsOption * System.Threading.CancellationToken -> Azure.Response[]

Public Overridable Function DeleteBlobs (blobUris As IEnumerable(Of Uri), Optional snapshotsOption As DeleteSnapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Optional cancellationToken As CancellationToken = Nothing) As Response()

Parameters

blobUris

IEnumerable<Uri>

URIs of the blobs to delete.

snapshotsOption

DeleteSnapshotsOption

Specifies options for deleting blob snapshots.

cancellationToken

CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Response[]

The Responses for the individual Delete operations.

Remarks

A RequestFailedException will be thrown if a failure to submit the batch occurs. Individual sub-operation failures will be wrapped in an AggregateException.