TopicSpaces interface

Package:

@azure/arm-eventgrid

Interface representing a TopicSpaces.

Methods

beginCreateOrUpdate(string, string, string, TopicSpace, TopicSpacesCreateOrUpdateOptionalParams)	Create or update a topic space with the specified parameters.
beginCreateOrUpdateAndWait(string, string, string, TopicSpace, TopicSpacesCreateOrUpdateOptionalParams)	Create or update a topic space with the specified parameters.
beginDelete(string, string, string, TopicSpacesDeleteOptionalParams)	Delete an existing topic space.
beginDeleteAndWait(string, string, string, TopicSpacesDeleteOptionalParams)	Delete an existing topic space.
get(string, string, string, TopicSpacesGetOptionalParams)	Get properties of a topic space.
listByNamespace(string, string, TopicSpacesListByNamespaceOptionalParams)	Get all the topic spaces under a namespace.

Method Details

beginCreateOrUpdate(string, string, string, TopicSpace, TopicSpacesCreateOrUpdateOptionalParams)

Create or update a topic space with the specified parameters.

function beginCreateOrUpdate(resourceGroupName: string, namespaceName: string, topicSpaceName: string, topicSpaceInfo: TopicSpace, options?: TopicSpacesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<TopicSpace>, TopicSpace>>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicSpaceName

string

The topic space name.

topicSpaceInfo

TopicSpace

Topic space information.

options

TopicSpacesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, TopicSpace, TopicSpacesCreateOrUpdateOptionalParams)

Create or update a topic space with the specified parameters.

function beginCreateOrUpdateAndWait(resourceGroupName: string, namespaceName: string, topicSpaceName: string, topicSpaceInfo: TopicSpace, options?: TopicSpacesCreateOrUpdateOptionalParams): Promise<TopicSpace>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicSpaceName

string

The topic space name.

topicSpaceInfo

TopicSpace

Topic space information.

options

TopicSpacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<TopicSpace>

beginDelete(string, string, string, TopicSpacesDeleteOptionalParams)

Delete an existing topic space.

function beginDelete(resourceGroupName: string, namespaceName: string, topicSpaceName: string, options?: TopicSpacesDeleteOptionalParams): 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.

topicSpaceName

string

Name of the Topic space.

options

TopicSpacesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, TopicSpacesDeleteOptionalParams)

Delete an existing topic space.

function beginDeleteAndWait(resourceGroupName: string, namespaceName: string, topicSpaceName: string, options?: TopicSpacesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicSpaceName

string

Name of the Topic space.

options

TopicSpacesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, TopicSpacesGetOptionalParams)

Get properties of a topic space.

function get(resourceGroupName: string, namespaceName: string, topicSpaceName: string, options?: TopicSpacesGetOptionalParams): Promise<TopicSpace>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

topicSpaceName

string

Name of the Topic space.

options

TopicSpacesGetOptionalParams

The options parameters.

Returns

Promise<TopicSpace>

listByNamespace(string, string, TopicSpacesListByNamespaceOptionalParams)

Get all the topic spaces under a namespace.

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

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

options

TopicSpacesListByNamespaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TopicSpace, TopicSpace[], PageSettings>