QueueClient.CreateIfNotExistsAsync Method

Definition

Namespace:

Azure.Storage.Queues

Assembly:

Azure.Storage.Queues.dll

Package:

Azure.Storage.Queues v12.20.1

Source:

QueueClient.cs

The CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken) operation creates a new queue under the specified account. If the queue already exists, it is not changed.

For more information, see Create Queue.

public virtual System.Threading.Tasks.Task<Azure.Response> CreateIfNotExistsAsync (System.Collections.Generic.IDictionary<string,string> metadata = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateIfNotExistsAsync : System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateIfNotExistsAsync : System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CreateIfNotExistsAsync (Optional metadata As IDictionary(Of String, String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

metadata

IDictionary<String,String>

Optional custom metadata to set for this queue.

cancellationToken

CancellationToken

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

Returns

Task<Response>

If the queue does not already exist, a Response describing the newly created queue. If the queue already exists, null.

Remarks

A RequestFailedException will be thrown if a failure occurs.