Topics interface

Interface representing a Topics.

Methods

beginCreateOrUpdate(string, string, Topic, TopicsCreateOrUpdateOptionalParams)

Asynchronously creates a new topic with the specified parameters.

beginCreateOrUpdateAndWait(string, string, Topic, TopicsCreateOrUpdateOptionalParams)

Asynchronously creates a new topic with the specified parameters.

beginDelete(string, string, TopicsDeleteOptionalParams)

Delete existing topic.

beginDeleteAndWait(string, string, TopicsDeleteOptionalParams)

Delete existing topic.

beginRegenerateKey(string, string, TopicRegenerateKeyRequest, TopicsRegenerateKeyOptionalParams)

Regenerate a shared access key for a topic.

beginRegenerateKeyAndWait(string, string, TopicRegenerateKeyRequest, TopicsRegenerateKeyOptionalParams)

Regenerate a shared access key for a topic.

beginUpdate(string, string, TopicUpdateParameters, TopicsUpdateOptionalParams)

Asynchronously updates a topic with the specified parameters.

beginUpdateAndWait(string, string, TopicUpdateParameters, TopicsUpdateOptionalParams)

Asynchronously updates a topic with the specified parameters.

get(string, string, TopicsGetOptionalParams)

Get properties of a topic.

listByResourceGroup(string, TopicsListByResourceGroupOptionalParams)

List all the topics under a resource group.

listBySubscription(TopicsListBySubscriptionOptionalParams)

List all the topics under an Azure subscription.

listEventTypes(string, string, string, string, TopicsListEventTypesOptionalParams)

List event types for a topic.

listSharedAccessKeys(string, string, TopicsListSharedAccessKeysOptionalParams)

List the two keys used to publish to a topic.

Method Details

beginCreateOrUpdate(string, string, Topic, TopicsCreateOrUpdateOptionalParams)

Asynchronously creates a new topic with the specified parameters.

function beginCreateOrUpdate(resourceGroupName: string, topicName: string, topicInfo: Topic, options?: TopicsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Topic>, Topic>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

topicName

string

Name of the topic.

topicInfo
Topic

Topic information.

options
TopicsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Topic>, Topic>>

beginCreateOrUpdateAndWait(string, string, Topic, TopicsCreateOrUpdateOptionalParams)

Asynchronously creates a new topic with the specified parameters.

function beginCreateOrUpdateAndWait(resourceGroupName: string, topicName: string, topicInfo: Topic, options?: TopicsCreateOrUpdateOptionalParams): Promise<Topic>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

topicName

string

Name of the topic.

topicInfo
Topic

Topic information.

options
TopicsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Topic>

beginDelete(string, string, TopicsDeleteOptionalParams)

Delete existing topic.

function beginDelete(resourceGroupName: string, topicName: string, options?: TopicsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

topicName

string

Name of the topic.

options
TopicsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, TopicsDeleteOptionalParams)

Delete existing topic.

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

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

topicName

string

Name of the topic.

options
TopicsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRegenerateKey(string, string, TopicRegenerateKeyRequest, TopicsRegenerateKeyOptionalParams)

Regenerate a shared access key for a topic.

function beginRegenerateKey(resourceGroupName: string, topicName: string, regenerateKeyRequest: TopicRegenerateKeyRequest, options?: TopicsRegenerateKeyOptionalParams): Promise<PollerLike<PollOperationState<TopicSharedAccessKeys>, TopicSharedAccessKeys>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

topicName

string

Name of the topic.

regenerateKeyRequest
TopicRegenerateKeyRequest

Request body to regenerate key.

options
TopicsRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<TopicSharedAccessKeys>, TopicSharedAccessKeys>>

beginRegenerateKeyAndWait(string, string, TopicRegenerateKeyRequest, TopicsRegenerateKeyOptionalParams)

Regenerate a shared access key for a topic.

function beginRegenerateKeyAndWait(resourceGroupName: string, topicName: string, regenerateKeyRequest: TopicRegenerateKeyRequest, options?: TopicsRegenerateKeyOptionalParams): Promise<TopicSharedAccessKeys>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

topicName

string

Name of the topic.

regenerateKeyRequest
TopicRegenerateKeyRequest

Request body to regenerate key.

options
TopicsRegenerateKeyOptionalParams

The options parameters.

Returns

beginUpdate(string, string, TopicUpdateParameters, TopicsUpdateOptionalParams)

Asynchronously updates a topic with the specified parameters.

function beginUpdate(resourceGroupName: string, topicName: string, topicUpdateParameters: TopicUpdateParameters, options?: TopicsUpdateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

topicName

string

Name of the topic.

topicUpdateParameters
TopicUpdateParameters

Topic update information.

options
TopicsUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginUpdateAndWait(string, string, TopicUpdateParameters, TopicsUpdateOptionalParams)

Asynchronously updates a topic with the specified parameters.

function beginUpdateAndWait(resourceGroupName: string, topicName: string, topicUpdateParameters: TopicUpdateParameters, options?: TopicsUpdateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

topicName

string

Name of the topic.

topicUpdateParameters
TopicUpdateParameters

Topic update information.

options
TopicsUpdateOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, TopicsGetOptionalParams)

Get properties of a topic.

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

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

topicName

string

Name of the topic.

options
TopicsGetOptionalParams

The options parameters.

Returns

Promise<Topic>

listByResourceGroup(string, TopicsListByResourceGroupOptionalParams)

List all the topics under a resource group.

function listByResourceGroup(resourceGroupName: string, options?: TopicsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Topic, Topic[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

options
TopicsListByResourceGroupOptionalParams

The options parameters.

Returns

listBySubscription(TopicsListBySubscriptionOptionalParams)

List all the topics under an Azure subscription.

function listBySubscription(options?: TopicsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Topic, Topic[], PageSettings>

Parameters

options
TopicsListBySubscriptionOptionalParams

The options parameters.

Returns

listEventTypes(string, string, string, string, TopicsListEventTypesOptionalParams)

List event types for a topic.

function listEventTypes(resourceGroupName: string, providerNamespace: string, resourceTypeName: string, resourceName: string, options?: TopicsListEventTypesOptionalParams): PagedAsyncIterableIterator<EventType, EventType[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

providerNamespace

string

Namespace of the provider of the topic.

resourceTypeName

string

Name of the topic type.

resourceName

string

Name of the topic.

options
TopicsListEventTypesOptionalParams

The options parameters.

Returns

listSharedAccessKeys(string, string, TopicsListSharedAccessKeysOptionalParams)

List the two keys used to publish to a topic.

function listSharedAccessKeys(resourceGroupName: string, topicName: string, options?: TopicsListSharedAccessKeysOptionalParams): Promise<TopicSharedAccessKeys>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

topicName

string

Name of the topic.

options
TopicsListSharedAccessKeysOptionalParams

The options parameters.

Returns