BlobBaseClient.Delete Method

Definition

Namespace:

Azure.Storage.Blobs.Specialized

Assembly:

Azure.Storage.Blobs.dll

Package:

Azure.Storage.Blobs v12.23.0

Source:

BlobBaseClient.cs

The Delete(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) operation marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection which could take several minutes.

Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time using IncludeSnapshots.

For more information, see Delete Blob.

public virtual Azure.Response Delete (Azure.Storage.Blobs.Models.DeleteSnapshotsOption snapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Delete : Azure.Storage.Blobs.Models.DeleteSnapshotsOption * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> Azure.Response
override this.Delete : Azure.Storage.Blobs.Models.DeleteSnapshotsOption * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function Delete (Optional snapshotsOption As DeleteSnapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Optional conditions As BlobRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

snapshotsOption

DeleteSnapshotsOption

Specifies options for deleting blob snapshots.

conditions

BlobRequestConditions

Optional BlobRequestConditions to add conditions on deleting this blob.

cancellationToken

CancellationToken

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

Returns

Response

A Response on successfully marking for deletion.

Remarks

A RequestFailedException will be thrown if a failure occurs.