Subscriptions interface

Package:

@azure/arm-servicebus

Interface representing a Subscriptions.

Methods

createOrUpdate(string, string, string, string, SBSubscription, SubscriptionsCreateOrUpdateOptionalParams)	Creates a topic subscription.
delete(string, string, string, string, SubscriptionsDeleteOptionalParams)	Deletes a subscription from the specified topic.
get(string, string, string, string, SubscriptionsGetOptionalParams)	Returns a subscription description for the specified topic.
listByTopic(string, string, string, SubscriptionsListByTopicOptionalParams)	List all the subscriptions under a specified topic.

Method Details

createOrUpdate(string, string, string, string, SBSubscription, SubscriptionsCreateOrUpdateOptionalParams)

Creates a topic subscription.

function createOrUpdate(resourceGroupName: string, namespaceName: string, topicName: string, subscriptionName: string, parameters: SBSubscription, options?: SubscriptionsCreateOrUpdateOptionalParams): Promise<SBSubscription>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

subscriptionName

string

The subscription name.

parameters

SBSubscription

Parameters supplied to create a subscription resource.

options

SubscriptionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SBSubscription>

delete(string, string, string, string, SubscriptionsDeleteOptionalParams)

Deletes a subscription from the specified topic.

function delete(resourceGroupName: string, namespaceName: string, topicName: string, subscriptionName: string, options?: SubscriptionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

subscriptionName

string

The subscription name.

options

SubscriptionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, SubscriptionsGetOptionalParams)

Returns a subscription description for the specified topic.

function get(resourceGroupName: string, namespaceName: string, topicName: string, subscriptionName: string, options?: SubscriptionsGetOptionalParams): Promise<SBSubscription>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

subscriptionName

string

The subscription name.

options

SubscriptionsGetOptionalParams

The options parameters.

Returns

Promise<SBSubscription>

listByTopic(string, string, string, SubscriptionsListByTopicOptionalParams)

List all the subscriptions under a specified topic.

function listByTopic(resourceGroupName: string, namespaceName: string, topicName: string, options?: SubscriptionsListByTopicOptionalParams): PagedAsyncIterableIterator<SBSubscription, SBSubscription[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

options

SubscriptionsListByTopicOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SBSubscription, SBSubscription[], PageSettings>