ManagementClient.UpdateRuleAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.ServiceBus.Management

Assembly:: Microsoft.Azure.ServiceBus.dll

Package:: Microsoft.Azure.ServiceBus v5.2.0

Source:: ManagementClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Updates an existing rule for a topic-subscription.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.RuleDescription> UpdateRuleAsync (string topicPath, string subscriptionName, Microsoft.Azure.ServiceBus.RuleDescription ruleDescription, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateRuleAsync : string * string * Microsoft.Azure.ServiceBus.RuleDescription * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.RuleDescription>
override this.UpdateRuleAsync : string * string * Microsoft.Azure.ServiceBus.RuleDescription * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.RuleDescription>

Public Overridable Function UpdateRuleAsync (topicPath As String, subscriptionName As String, ruleDescription As RuleDescription, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RuleDescription)

Parameters

topicPath: String

Path of the topic.

subscriptionName: String

Name of the subscription.

ruleDescription: RuleDescription

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

cancellationToken: CancellationToken

Returns

Task<RuleDescription>

The RuleDescription of the updated rule.

Exceptions

ArgumentNullException

rule descriptor is null.

MessagingEntityNotFoundException

Described topic/subscription/rule 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.

Applies to