TopicsOperations interface

Package:

@azure/arm-servicebus

Interface representing a Topics operations.

Properties

createOrUpdate	Creates a topic in the specified namespace.
createOrUpdateAuthorizationRule	Creates an authorization rule for the specified topic.
delete	Deletes a topic from the specified namespace and resource group.
deleteAuthorizationRule	Deletes a topic authorization rule.
get	Returns a description for the specified topic.
getAuthorizationRule	Returns the specified authorization rule.
listAuthorizationRules	Gets authorization rules for a topic.
listByNamespace	Gets all the topics in a namespace.
listKeys	Gets the primary and secondary connection strings for the topic.
regenerateKeys	Regenerates primary or secondary connection strings for the topic.

Property Details

createOrUpdate

Creates a topic in the specified namespace.

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

Property Value

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

createOrUpdateAuthorizationRule

Creates an authorization rule for the specified topic.

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

Property Value

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

delete

Deletes a topic from the specified namespace and resource group.

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

Property Value

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

deleteAuthorizationRule

Deletes a topic authorization rule.

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

Property Value

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

get

Returns a description for the specified topic.

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

Property Value

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

getAuthorizationRule

Returns the specified authorization rule.

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

Property Value

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

listAuthorizationRules

Gets authorization rules for a topic.

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

Property Value

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

listByNamespace

Gets all the topics in a namespace.

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

Property Value

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

listKeys

Gets the primary and secondary connection strings for the topic.

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

Property Value

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

regenerateKeys

Regenerates primary or secondary connection strings for the topic.

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

Property Value

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