ServiceBusAdministrationClient.SubscriptionExistsAsync Method

Definition

Namespace:

Azure.Messaging.ServiceBus.Administration

Assembly:

Azure.Messaging.ServiceBus.dll

Package:

Azure.Messaging.ServiceBus v7.18.2

Source:

ServiceBusAdministrationClient.cs

Checks whether a given subscription exists or not.

public virtual System.Threading.Tasks.Task<Azure.Response<bool>> SubscriptionExistsAsync (string topicName, string subscriptionName, System.Threading.CancellationToken cancellationToken = default);

abstract member SubscriptionExistsAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.SubscriptionExistsAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>

Public Overridable Function SubscriptionExistsAsync (topicName As String, subscriptionName 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.

cancellationToken

CancellationToken

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

Returns

Task<Response<Boolean>>

True if subscription exists, false otherwise.

Exceptions

ServiceTimeout

The operation times out.

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