BlobContainerClient.DeleteIfExistsAsync Method

Definition

Namespace:

Azure.Storage.Blobs

Assembly:

Azure.Storage.Blobs.dll

Package:

Azure.Storage.Blobs v12.19.1

Source:

BlobContainerClient.cs

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 which could take several minutes.

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

CancellationToken

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

Returns

Task<Response<Boolean>>

A Response Returns true if container exists and was marked for deletion, return false otherwise.

Remarks

A RequestFailedException will be thrown if a failure occurs.