ManagementClient.GetQueueAsync(String, CancellationToken) Method

Definition

Namespace:

Microsoft.Azure.ServiceBus.Management

Assembly:

Microsoft.Azure.ServiceBus.dll

Package:

Microsoft.Azure.ServiceBus v5.2.0

Source:

ManagementClient.cs

Retrieves a queue from the service namespace.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Management.QueueDescription> GetQueueAsync (string queuePath, System.Threading.CancellationToken cancellationToken = default);

abstract member GetQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Management.QueueDescription>
override this.GetQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Management.QueueDescription>

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

Parameters

queuePath

String

The path of the queue relative to service bus namespace.

cancellationToken

CancellationToken

Returns

Task<QueueDescription>

QueueDescription containing information about the queue.

Exceptions

ArgumentException

Thrown if queuePath is null, white space empty or not in the right format.

ArgumentOutOfRangeException

The length of queue path is greater than 260.

ServiceBusTimeoutException

The operation times out. The timeout period is initialized through the ServiceBusConnection class. You may need to increase the value of timeout to avoid this exception if the timeout value is relatively low.

MessagingEntityNotFoundException

Queue with this name does not exist.

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 an unexpected exception occured.