ManagementClient.GetSubscriptionAsync Method

Definition

Namespace:

Microsoft.Azure.ServiceBus.Management

Assembly:

Microsoft.Azure.ServiceBus.dll

Package:

Microsoft.Azure.ServiceBus v5.2.0

Source:

ManagementClient.cs

Retrieves a subscription from the service namespace.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Management.SubscriptionDescription> GetSubscriptionAsync (string topicPath, string subscriptionName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetSubscriptionAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Management.SubscriptionDescription>
override this.GetSubscriptionAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Management.SubscriptionDescription>

Public Overridable Function GetSubscriptionAsync (topicPath As String, subscriptionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of SubscriptionDescription)

Parameters

topicPath

String

The path of the topic relative to service bus namespace.

subscriptionName

String

The subscription name.

cancellationToken

CancellationToken

Returns

Task<SubscriptionDescription>

SubscriptionDescription containing information about the subscription.

Exceptions

ArgumentException

Thrown if topicPath, subscriptionName is null, white space empty or not in the right format.

ArgumentOutOfRangeException

The length of topic path is greater than 260 or length of subscription-name is greater than 50.

ServiceBusTimeoutException

The operation times out. The timeout period is initialized through the ServiceBusConnection class. You may need to increase the value of timeout to avoid this exception if the timeout value is relatively low.

MessagingEntityNotFoundException

Topic or Subscription with this name does not exist.

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.

ServerBusyException

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

ServiceBusException

An internal error or an unexpected exception occured.