ManagementClient.DeleteQueueAsync(String, CancellationToken) Method

Definition

Namespace:

Microsoft.Azure.ServiceBus.Management

Assembly:

Microsoft.Azure.ServiceBus.dll

Package:

Microsoft.Azure.ServiceBus v5.2.0

Source:

ManagementClient.cs

Deletes the queue described by the path relative to the service namespace base address.

public virtual System.Threading.Tasks.Task DeleteQueueAsync (string queuePath, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function DeleteQueueAsync (queuePath As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

queuePath

String

The name of the queue relative to the service namespace base address.

cancellationToken

CancellationToken

Returns

Task

Exceptions

ArgumentException

queuePath is empty or null, or path starts or ends with "/".

ArgumentOutOfRangeException

The length of 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.