QueueClient.DeleteIfExistsAsync(CancellationToken) Method

Reference

Definition

Namespace:: Azure.Storage.Queues

Assembly:: Azure.Storage.Queues.dll

Package:: Azure.Storage.Queues v12.20.1

Package:: Azure.Storage.Queues v12.21.0-beta.2

Source:: QueueClient.cs

Source:: QueueClient.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 DeleteIfExistsAsync(CancellationToken) operation deletes the specified queue if it exists.

For more information, see Delete Queue.

public virtual System.Threading.Tasks.Task<Azure.Response<bool>> DeleteIfExistsAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteIfExistsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.DeleteIfExistsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>

Public Overridable Function DeleteIfExistsAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Boolean))

Parameters

cancellationToken: CancellationToken

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

Returns

Task<Response<Boolean>>

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

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

Share via