ManagementClient.DeleteSubscriptionAsync Method

Definition

Namespace:

Microsoft.Azure.ServiceBus.Management

Assembly:

Microsoft.Azure.ServiceBus.dll

Package:

Microsoft.Azure.ServiceBus v5.2.0

Source:

ManagementClient.cs

Deletes the subscription with the specified topic and subscription name.

public virtual System.Threading.Tasks.Task DeleteSubscriptionAsync (string topicPath, string subscriptionName, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteSubscriptionAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteSubscriptionAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

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

Parameters

topicPath

String

The name of the topic relative to the service namespace base address.

subscriptionName

String

The name of the subscription to delete.

cancellationToken

CancellationToken

Returns

Task

Exceptions

ArgumentException

topicPath or subscriptionName is empty or null, or path starts or ends with "/".

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

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.