BlobContainerClient.DeleteIfExistsAsync(BlobRequestConditions, CancellationToken) Method

Definition

The DeleteIfExistsAsync(BlobRequestConditions, CancellationToken) operation marks the specified container for deletion if it exists. The container and any blobs contained within it are later deleted during garbage collection.

For more information, see Delete Container.

public virtual System.Threading.Tasks.Task<Azure.Response<bool>> DeleteIfExistsAsync (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteIfExistsAsync : Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.DeleteIfExistsAsync : Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
Public Overridable Function DeleteIfExistsAsync (Optional conditions As BlobRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Boolean))

Parameters

conditions
BlobRequestConditions

Optional BlobRequestConditions to add conditions on the deletion of this container.

cancellationToken
System.Threading.CancellationToken

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

Returns

System.Threading.Tasks.Task<Response<System.Boolean>>

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

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to