ServiceBusAdministrationClient.RuleExistsAsync Method

Definition

Checks whether a given rule exists or not.

public virtual System.Threading.Tasks.Task<Azure.Response<bool>> RuleExistsAsync (string topicName, string subscriptionName, string ruleName, System.Threading.CancellationToken cancellationToken = default);
abstract member RuleExistsAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.RuleExistsAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
Public Overridable Function RuleExistsAsync (topicName As String, subscriptionName As String, ruleName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Boolean))

Parameters

topicName
String

Name of the topic.

subscriptionName
String

Name of the subscription to check.

ruleName
String

The name of the rule to retrieve.

cancellationToken
CancellationToken

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

Returns

True if subscription exists, false otherwise.

Exceptions

The operation times out.

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

The topic or subscription name is null or empty..

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

The topic or subscription name is otherwise invalid.

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

  • 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.

Applies to