ManagementClient.QueueExistsAsync(String, CancellationToken) Method

Definition

Namespace:

Microsoft.Azure.ServiceBus.Management

Assembly:

Microsoft.Azure.ServiceBus.dll

Package:

Microsoft.Azure.ServiceBus v5.2.0

Source:

ManagementClient.cs

Checks whether a given queue exists or not.

public virtual System.Threading.Tasks.Task<bool> QueueExistsAsync (string queuePath, System.Threading.CancellationToken cancellationToken = default);

abstract member QueueExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
override this.QueueExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

Public Overridable Function QueueExistsAsync (queuePath As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)

Parameters

queuePath

String

Path of the queue entity to check.

cancellationToken

CancellationToken

Returns

Task<Boolean>

True if queue exists, false otherwise.

Exceptions

ArgumentException

Queue path provided is not valid.

ServiceBusTimeoutException

The operation times out.

UnauthorizedAccessException

No sufficient permission to perform this operation. You should check to ensure that your ManagementClient has the correct TokenProvider credentials to perform this operation.

ServerBusyException

The server is busy. You should wait before you retry the operation.

ServiceBusException

An internal error or unexpected exception occurs.