Partager via


Topics interface

Interface representing a Topics.

Methods

createOrUpdate(string, string, string, SBTopic, TopicsCreateOrUpdateOptionalParams)

Creates a topic in the specified namespace.

createOrUpdateAuthorizationRule(string, string, string, string, SBAuthorizationRule, TopicsCreateOrUpdateAuthorizationRuleOptionalParams)

Creates an authorization rule for the specified topic.

delete(string, string, string, TopicsDeleteOptionalParams)

Deletes a topic from the specified namespace and resource group.

deleteAuthorizationRule(string, string, string, string, TopicsDeleteAuthorizationRuleOptionalParams)

Deletes a topic authorization rule.

get(string, string, string, TopicsGetOptionalParams)

Returns a description for the specified topic.

getAuthorizationRule(string, string, string, string, TopicsGetAuthorizationRuleOptionalParams)

Returns the specified authorization rule.

listAuthorizationRules(string, string, string, TopicsListAuthorizationRulesOptionalParams)

Gets authorization rules for a topic.

listByNamespace(string, string, TopicsListByNamespaceOptionalParams)

Gets all the topics in a namespace.

listKeys(string, string, string, string, TopicsListKeysOptionalParams)

Gets the primary and secondary connection strings for the topic.

regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, TopicsRegenerateKeysOptionalParams)

Regenerates primary or secondary connection strings for the topic.

Method Details

createOrUpdate(string, string, string, SBTopic, TopicsCreateOrUpdateOptionalParams)

Creates a topic in the specified namespace.

function createOrUpdate(resourceGroupName: string, namespaceName: string, topicName: string, parameters: SBTopic, options?: TopicsCreateOrUpdateOptionalParams): Promise<SBTopic>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

parameters
SBTopic

Parameters supplied to create a topic resource.

options
TopicsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SBTopic>

createOrUpdateAuthorizationRule(string, string, string, string, SBAuthorizationRule, TopicsCreateOrUpdateAuthorizationRuleOptionalParams)

Creates an authorization rule for the specified topic.

function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, topicName: string, authorizationRuleName: string, parameters: SBAuthorizationRule, options?: TopicsCreateOrUpdateAuthorizationRuleOptionalParams): Promise<SBAuthorizationRule>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

authorizationRuleName

string

The authorization rule name.

parameters
SBAuthorizationRule

The shared access authorization rule.

options
TopicsCreateOrUpdateAuthorizationRuleOptionalParams

The options parameters.

Returns

delete(string, string, string, TopicsDeleteOptionalParams)

Deletes a topic from the specified namespace and resource group.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

options
TopicsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

deleteAuthorizationRule(string, string, string, string, TopicsDeleteAuthorizationRuleOptionalParams)

Deletes a topic authorization rule.

function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, topicName: string, authorizationRuleName: string, options?: TopicsDeleteAuthorizationRuleOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

authorizationRuleName

string

The authorization rule name.

options
TopicsDeleteAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, TopicsGetOptionalParams)

Returns a description for the specified topic.

function get(resourceGroupName: string, namespaceName: string, topicName: string, options?: TopicsGetOptionalParams): Promise<SBTopic>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

options
TopicsGetOptionalParams

The options parameters.

Returns

Promise<SBTopic>

getAuthorizationRule(string, string, string, string, TopicsGetAuthorizationRuleOptionalParams)

Returns the specified authorization rule.

function getAuthorizationRule(resourceGroupName: string, namespaceName: string, topicName: string, authorizationRuleName: string, options?: TopicsGetAuthorizationRuleOptionalParams): Promise<SBAuthorizationRule>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

authorizationRuleName

string

The authorization rule name.

options
TopicsGetAuthorizationRuleOptionalParams

The options parameters.

Returns

listAuthorizationRules(string, string, string, TopicsListAuthorizationRulesOptionalParams)

Gets authorization rules for a topic.

function listAuthorizationRules(resourceGroupName: string, namespaceName: string, topicName: string, options?: TopicsListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SBAuthorizationRule, SBAuthorizationRule[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

options
TopicsListAuthorizationRulesOptionalParams

The options parameters.

Returns

listByNamespace(string, string, TopicsListByNamespaceOptionalParams)

Gets all the topics in a namespace.

function listByNamespace(resourceGroupName: string, namespaceName: string, options?: TopicsListByNamespaceOptionalParams): PagedAsyncIterableIterator<SBTopic, SBTopic[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

options
TopicsListByNamespaceOptionalParams

The options parameters.

Returns

listKeys(string, string, string, string, TopicsListKeysOptionalParams)

Gets the primary and secondary connection strings for the topic.

function listKeys(resourceGroupName: string, namespaceName: string, topicName: string, authorizationRuleName: string, options?: TopicsListKeysOptionalParams): Promise<AccessKeys>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

authorizationRuleName

string

The authorization rule name.

options
TopicsListKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>

regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, TopicsRegenerateKeysOptionalParams)

Regenerates primary or secondary connection strings for the topic.

function regenerateKeys(resourceGroupName: string, namespaceName: string, topicName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: TopicsRegenerateKeysOptionalParams): Promise<AccessKeys>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

topicName

string

The topic name.

authorizationRuleName

string

The authorization rule name.

parameters
RegenerateAccessKeyParameters

Parameters supplied to regenerate the authorization rule.

options
TopicsRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>