NamespaceManager.RenameQueueAsync(String, String) Method

Definition

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
String

The path to an existing queue.

newPath
String

The new path to the renamed queue.

Returns

Task<QueueDescription>

Returns Task<TResult>.

Exceptions

Thrown when path is null or empty.

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

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.

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

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

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

Thrown when an internal error or unexpected exception occurs.

Applies to