BlobContainerClient.DeleteIfExists Method

Reference

Definition

Namespace:: Azure.Storage.Blobs

Assembly:: Azure.Storage.Blobs.dll

Package:: Azure.Storage.Blobs v12.19.1

Package:: Azure.Storage.Blobs v12.20.0-beta.2

Source:: BlobContainerClient.cs

Source:: BlobContainerClient.cs

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 DeleteIfExists(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 Azure.Response<bool> DeleteIfExists (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteIfExists : Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> Azure.Response<bool>
override this.DeleteIfExists : Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> Azure.Response<bool>

Public Overridable Function DeleteIfExists (Optional conditions As BlobRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

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.

Applies to