ServiceBusAdministrationClient.UpdateRuleAsync Method

Definition

Namespace:

Azure.Messaging.ServiceBus.Administration

Assembly:

Azure.Messaging.ServiceBus.dll

Package:

Azure.Messaging.ServiceBus v7.17.5

Source:

ServiceBusAdministrationClient.cs

Updates an existing rule for a topic-subscription.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.RuleProperties>> UpdateRuleAsync (string topicName, string subscriptionName, Azure.Messaging.ServiceBus.Administration.RuleProperties rule, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function UpdateRuleAsync (topicName As String, subscriptionName As String, rule As RuleProperties, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RuleProperties))

Parameters

topicName

String

Name of the topic.

subscriptionName

String

Name of the subscription.

rule

RuleProperties

A RuleProperties object describing the attributes with which the rule will be updated.

cancellationToken

CancellationToken

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

Returns

Task<Response<RuleProperties>>

The RuleProperties of the updated rule.

Exceptions

MessagingEntityNotFound

Described topic/subscription/rule 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 topic name, subscription name, or rule properties instance is null.

ArgumentOutOfRangeException

The topic or subscription name name exceeds the maximum allowed length.

ArgumentException

The topic or subscription name is otherwise invalid.

UnauthorizedAccessException

Insufficient permission to perform this operation. You should check to ensure that your ServiceBusAdministrationClient has the necessary claims to perform this operation. https://docs.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.