BlobBaseClient.DeleteIfExists(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) Method

Definition

The DeleteIfExists(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) operation marks the specified blob or snapshot for deletion, if the blob exists. The blob is later deleted during garbage collection.

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<bool> DeleteIfExists (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 DeleteIfExists : Azure.Storage.Blobs.Models.DeleteSnapshotsOption * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> Azure.Response<bool>
override this.DeleteIfExists : Azure.Storage.Blobs.Models.DeleteSnapshotsOption * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> Azure.Response<bool>
Public Overridable Function DeleteIfExists (Optional snapshotsOption As DeleteSnapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Optional conditions As BlobRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of Boolean)

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<Boolean>

A Response Returns true if blob exists and was deleted, return false otherwise.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to