BlobContainerClient.DeleteBlobIfExistsAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The DeleteBlobIfExistsAsync(String, DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) operation marks the specified blob or snapshot for deletion, if the blob or snapshot exists. 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 System.Threading.Tasks.Task<Azure.Response<bool>> DeleteBlobIfExistsAsync (string blobName, 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 DeleteBlobIfExistsAsync : string * Azure.Storage.Blobs.Models.DeleteSnapshotsOption * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.DeleteBlobIfExistsAsync : string * Azure.Storage.Blobs.Models.DeleteSnapshotsOption * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>Public Overridable Function DeleteBlobIfExistsAsync (blobName As String, Optional snapshotsOption As DeleteSnapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Optional conditions As BlobRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Boolean))Parameters
- blobName
- String
The name of the blob to delete.
- 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
A Response on successfully marking for deletion.
Remarks
A RequestFailedException will be thrown if a failure occurs.
