ServiceBusAdministrationClient.UpdateQueueAsync Method

Definition

Namespace:

Azure.Messaging.ServiceBus.Administration

Assembly:

Azure.Messaging.ServiceBus.dll

Package:

Azure.Messaging.ServiceBus v7.18.2

Source:

ServiceBusAdministrationClient.cs

Updates an existing queue.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueProperties>> UpdateQueueAsync (Azure.Messaging.ServiceBus.Administration.QueueProperties queue, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateQueueAsync : Azure.Messaging.ServiceBus.Administration.QueueProperties * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueProperties>>
override this.UpdateQueueAsync : Azure.Messaging.ServiceBus.Administration.QueueProperties * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueProperties>>

Public Overridable Function UpdateQueueAsync (queue As QueueProperties, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of QueueProperties))

Parameters

queue

QueueProperties

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

cancellationToken

CancellationToken

An optional CancellationToken instance to signal the request to cancel the operation.

Returns

Task<Response<QueueProperties>>

The QueueProperties of the updated queue.

Exceptions

MessagingEntityNotFound

Described queue was not found.

ServiceTimeout

The operation times out.

QuotaExceeded

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.

ServiceBusy

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

ArgumentNullException

The queue properties instance is null.

UnauthorizedAccessException

Insufficient permission to perform this operation. You should check to ensure that your ServiceBusAdministrationClient has the necessary claims to perform this operation. https://learn.microsoft.com/azure/service-bus-messaging/service-bus-sas#rights-required-for-service-bus-operations

ServiceBusException

• The specified entity could not be found. The Reason will be set to MessagingEntityNotFound in this case.
• The operation timed out. The Reason will be set to ServiceTimeout in this case.
• Either the specified size of the entity 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. The failure reason will be set to QuotaExceeded in this case.
• The server is busy. You should wait before you retry the operation. The failure reason will be set to ServiceBusy in this case.
• An internal error or unexpected exception occurs. The failure reason will be set to GeneralError in this case.