Share via

ServiceBusAdministrationClient.GetRulesAsync Method

  • Reference

Definition

Namespace:
Azure.Messaging.ServiceBus.Administration
Assembly:
Azure.Messaging.ServiceBus.dll
Package:
Azure.Messaging.ServiceBus v7.18.2
Package:
Azure.Messaging.ServiceBus v7.18.0-beta.1
Source:
ServiceBusAdministrationClient.cs
Source:
ServiceBusAdministrationClient.cs

Retrieves the set of rules for a given subscription in a topic.

public virtual Azure.AsyncPageable<Azure.Messaging.ServiceBus.Administration.RuleProperties> GetRulesAsync (string topicName, string subscriptionName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetRulesAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Messaging.ServiceBus.Administration.RuleProperties>
override this.GetRulesAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Messaging.ServiceBus.Administration.RuleProperties>
Public Overridable Function GetRulesAsync (topicName As String, subscriptionName As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of RuleProperties)

Parameters

topicName
String

The topic name.

subscriptionName
String

The subscription for which all the rules need to be retrieved.

cancellationToken
CancellationToken

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

Returns

AsyncPageable<RuleProperties>

An AsyncPageable<T> describing the rules.

Exceptions

ServiceTimeout

The operation times out. The timeout period is initialized through the ServiceBusAdministrationClientOptions class (see Retry property). You may need to increase the value of timeout to avoid this exception if the timeout value is relatively low.

ServiceBusy

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

ArgumentNullException

The topic or subscription name is null or empty.

ArgumentOutOfRangeException

The topic or subscription 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://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.
  • 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.

Remarks

Maximum value allowed is 100 per page.

Applies to