NamespaceTopics interface

Package:

@azure/arm-eventgrid

Interface representing a NamespaceTopics.

Methods

beginCreateOrUpdate(string, string, string, NamespaceTopic, NamespaceTopicsCreateOrUpdateOptionalParams)	Asynchronously creates a new namespace topic with the specified parameters.
beginCreateOrUpdateAndWait(string, string, string, NamespaceTopic, NamespaceTopicsCreateOrUpdateOptionalParams)	Asynchronously creates a new namespace topic with the specified parameters.
beginDelete(string, string, string, NamespaceTopicsDeleteOptionalParams)	Delete existing namespace topic.
beginDeleteAndWait(string, string, string, NamespaceTopicsDeleteOptionalParams)	Delete existing namespace topic.
beginRegenerateKey(string, string, string, TopicRegenerateKeyRequest, NamespaceTopicsRegenerateKeyOptionalParams)	Regenerate a shared access key for a namespace topic.
beginRegenerateKeyAndWait(string, string, string, TopicRegenerateKeyRequest, NamespaceTopicsRegenerateKeyOptionalParams)	Regenerate a shared access key for a namespace topic.
beginUpdate(string, string, string, NamespaceTopicUpdateParameters, NamespaceTopicsUpdateOptionalParams)	Asynchronously updates a namespace topic with the specified parameters.
beginUpdateAndWait(string, string, string, NamespaceTopicUpdateParameters, NamespaceTopicsUpdateOptionalParams)	Asynchronously updates a namespace topic with the specified parameters.
get(string, string, string, NamespaceTopicsGetOptionalParams)	Get properties of a namespace topic.
listByNamespace(string, string, NamespaceTopicsListByNamespaceOptionalParams)	List all the namespace topics under a namespace.
listSharedAccessKeys(string, string, string, NamespaceTopicsListSharedAccessKeysOptionalParams)	List the two keys used to publish to a namespace topic.

Method Details

beginCreateOrUpdate(string, string, string, NamespaceTopic, NamespaceTopicsCreateOrUpdateOptionalParams)

Asynchronously creates a new namespace topic with the specified parameters.

function beginCreateOrUpdate(resourceGroupName: string, namespaceName: string, topicName: string, namespaceTopicInfo: NamespaceTopic, options?: NamespaceTopicsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NamespaceTopic>, NamespaceTopic>>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

namespaceTopicInfo

NamespaceTopic

Namespace topic information.

options

NamespaceTopicsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NamespaceTopic>, NamespaceTopic>>

beginCreateOrUpdateAndWait(string, string, string, NamespaceTopic, NamespaceTopicsCreateOrUpdateOptionalParams)

Asynchronously creates a new namespace topic with the specified parameters.

function beginCreateOrUpdateAndWait(resourceGroupName: string, namespaceName: string, topicName: string, namespaceTopicInfo: NamespaceTopic, options?: NamespaceTopicsCreateOrUpdateOptionalParams): Promise<NamespaceTopic>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

namespaceTopicInfo

NamespaceTopic

Namespace topic information.

options

NamespaceTopicsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<NamespaceTopic>

beginDelete(string, string, string, NamespaceTopicsDeleteOptionalParams)

Delete existing namespace topic.

function beginDelete(resourceGroupName: string, namespaceName: string, topicName: string, options?: NamespaceTopicsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicName

string

Name of the topic.

options

NamespaceTopicsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, NamespaceTopicsDeleteOptionalParams)

Delete existing namespace topic.

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

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicName

string

Name of the topic.

options

NamespaceTopicsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRegenerateKey(string, string, string, TopicRegenerateKeyRequest, NamespaceTopicsRegenerateKeyOptionalParams)

Regenerate a shared access key for a namespace topic.

function beginRegenerateKey(resourceGroupName: string, namespaceName: string, topicName: string, regenerateKeyRequest: TopicRegenerateKeyRequest, options?: NamespaceTopicsRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<TopicSharedAccessKeys>, TopicSharedAccessKeys>>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicName

string

Name of the topic.

regenerateKeyRequest

TopicRegenerateKeyRequest

Request body to regenerate key.

options

NamespaceTopicsRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<TopicSharedAccessKeys>, TopicSharedAccessKeys>>

beginRegenerateKeyAndWait(string, string, string, TopicRegenerateKeyRequest, NamespaceTopicsRegenerateKeyOptionalParams)

Regenerate a shared access key for a namespace topic.

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

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicName

string

Name of the topic.

regenerateKeyRequest

TopicRegenerateKeyRequest

Request body to regenerate key.

options

NamespaceTopicsRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<TopicSharedAccessKeys>

beginUpdate(string, string, string, NamespaceTopicUpdateParameters, NamespaceTopicsUpdateOptionalParams)

Asynchronously updates a namespace topic with the specified parameters.

function beginUpdate(resourceGroupName: string, namespaceName: string, topicName: string, namespaceTopicUpdateParameters: NamespaceTopicUpdateParameters, options?: NamespaceTopicsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NamespaceTopic>, NamespaceTopic>>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

namespaceTopicUpdateParameters

NamespaceTopicUpdateParameters

Namespace topic update information.

options

NamespaceTopicsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NamespaceTopic>, NamespaceTopic>>

beginUpdateAndWait(string, string, string, NamespaceTopicUpdateParameters, NamespaceTopicsUpdateOptionalParams)

Asynchronously updates a namespace topic with the specified parameters.

function beginUpdateAndWait(resourceGroupName: string, namespaceName: string, topicName: string, namespaceTopicUpdateParameters: NamespaceTopicUpdateParameters, options?: NamespaceTopicsUpdateOptionalParams): Promise<NamespaceTopic>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

namespaceTopicUpdateParameters

NamespaceTopicUpdateParameters

Namespace topic update information.

options

NamespaceTopicsUpdateOptionalParams

The options parameters.

Returns

Promise<NamespaceTopic>

get(string, string, string, NamespaceTopicsGetOptionalParams)

Get properties of a namespace topic.

function get(resourceGroupName: string, namespaceName: string, topicName: string, options?: NamespaceTopicsGetOptionalParams): Promise<NamespaceTopic>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

options

NamespaceTopicsGetOptionalParams

The options parameters.

Returns

Promise<NamespaceTopic>

listByNamespace(string, string, NamespaceTopicsListByNamespaceOptionalParams)

List all the namespace topics under a namespace.

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

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

options

NamespaceTopicsListByNamespaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NamespaceTopic, NamespaceTopic[], PageSettings>

listSharedAccessKeys(string, string, string, NamespaceTopicsListSharedAccessKeysOptionalParams)

List the two keys used to publish to a namespace topic.

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

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicName

string

Name of the topic.

options

NamespaceTopicsListSharedAccessKeysOptionalParams

The options parameters.

Returns

Promise<TopicSharedAccessKeys>