ManagementClient.UpdateQueueAsync(QueueDescription, CancellationToken) Method

Definition

Namespace:

Microsoft.Azure.ServiceBus.Management

Assembly:

Microsoft.Azure.ServiceBus.dll

Package:

Microsoft.Azure.ServiceBus v5.2.0

Source:

ManagementClient.cs

Updates an existing queue.

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

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

Public Overridable Function UpdateQueueAsync (queueDescription As QueueDescription, Optional cancellationToken As CancellationToken = Nothing) As Task(Of QueueDescription)

Parameters

queueDescription

QueueDescription

A QueueDescription object describing the attributes with which the queue will be updated.

cancellationToken

CancellationToken

Returns

Task<QueueDescription>

The QueueDescription of the updated queue.

Exceptions

ArgumentNullException

Queue descriptor is null.

MessagingEntityNotFoundException

Described queue was not found.

ServiceBusTimeoutException

The operation times out.

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.

QuotaExceededException

Either the specified size in the description is not supported or the maximum allowable quota has been reached. You must specify one of the supported size values, delete existing entities, or increase your quota size.

ServerBusyException

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

ServiceBusException

An internal error or unexpected exception occurs.