ServiceBusAdministrationClient.QueueExistsAsync Method

Definition

Namespace:

Azure.Messaging.ServiceBus.Administration

Assembly:

Azure.Messaging.ServiceBus.dll

Package:

Azure.Messaging.ServiceBus v7.18.2

Source:

ServiceBusAdministrationClient.cs

Checks whether a given queue exists or not.

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

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

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

Parameters

name

String

Name of the queue entity to check.

cancellationToken

CancellationToken

An optional CancellationToken instance to signal the request to cancel the operation.

Returns

Task<Response<Boolean>>

True if queue exists, false otherwise.

Exceptions

ServiceTimeout

The operation times out.

ServiceBusy

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

ArgumentNullException

The queue name is null or empty..

ArgumentOutOfRangeException

The queue name name exceeds the maximum allowed length.

ArgumentException

The queue name is otherwise invalid.

UnauthorizedAccessException

Insufficient permission to perform this operation. You should check to ensure that your ServiceBusAdministrationClient has the necessary claims to perform this operation. https://learn.microsoft.com/azure/service-bus-messaging/service-bus-sas#rights-required-for-service-bus-operations

ServiceBusException

• The operation timed out. The Reason will be set to ServiceTimeout in this case.
• The server is busy. You should wait before you retry the operation. The failure reason will be set to ServiceBusy in this case.
• An internal error or unexpected exception occurs. The failure reason will be set to GeneralError in this case.