NamespaceManager.RenameQueueAsync(String, String) Method

Definition

Namespace:

Microsoft.ServiceBus

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Asynchronous version of RenameQueue(String, String). This is currently NOT supported with Premium Service Bus SKU.

public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.QueueDescription> RenameQueueAsync(string path, string newPath);

member this.RenameQueueAsync : string * string -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.QueueDescription>

Public Function RenameQueueAsync (path As String, newPath As String) As Task(Of QueueDescription)

Parameters

path

System.String

The path to an existing queue.

newPath

System.String

The new path to the renamed queue.

Returns

System.Threading.Tasks.Task<QueueDescription>

Returns System.Threading.Tasks.Task`1.

Exceptions

System.ArgumentException

Thrown when path is null or empty.

System.ArgumentOutOfRangeException

Thrown when the length of path is more than 290 characters.

System.TimeoutException

Thrown when the operation times out. The timeout period is initialized through the NamespaceManagerSettings class. You can increase the value of the OperationTimeout property to avoid this exception if the timeout value is relatively low.

MessagingEntityNotFoundException

Thrown when the source queue with the specified path does not exist.

MessagingEntityAlreadyExistsException

Thrown when the target queue with the same path exists within the same namespace.

System.UnauthorizedAccessException

Thrown when the client does not have credentials to perform the operation.

MessagingException

Thrown when an internal error or unexpected exception occurs.