你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。

Topics interface

表示主题的接口。

方法详细信息

beginCreateOrUpdate(string, string, Topic, TopicsCreateOrUpdateOptionalParams)

使用指定的参数异步创建一个新主题。

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

参数

resourceGroupName

string

用户订阅中的资源组的名称。

topicName

string

主题的名称。

topicInfo
Topic

主题信息。

options
TopicsCreateOrUpdateOptionalParams

选项参数。

返回

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

beginCreateOrUpdateAndWait(string, string, Topic, TopicsCreateOrUpdateOptionalParams)

使用指定的参数异步创建一个新主题。

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

参数

resourceGroupName

string

用户订阅中的资源组的名称。

topicName

string

主题的名称。

topicInfo
Topic

主题信息。

options
TopicsCreateOrUpdateOptionalParams

选项参数。

返回

Promise<Topic>

beginDelete(string, string, TopicsDeleteOptionalParams)

删除现有主题。

function beginDelete(resourceGroupName: string, topicName: string, options?: TopicsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<TopicsDeleteHeaders>, TopicsDeleteHeaders>>

参数

resourceGroupName

string

用户订阅中的资源组的名称。

topicName

string

主题的名称。

options
TopicsDeleteOptionalParams

选项参数。

返回

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

beginDeleteAndWait(string, string, TopicsDeleteOptionalParams)

删除现有主题。

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

参数

resourceGroupName

string

用户订阅中的资源组的名称。

topicName

string

主题的名称。

options
TopicsDeleteOptionalParams

选项参数。

返回

beginRegenerateKey(string, string, TopicRegenerateKeyRequest, TopicsRegenerateKeyOptionalParams)

重新生成主题的共享访问密钥。

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

参数

resourceGroupName

string

用户订阅中的资源组的名称。

topicName

string

主题的名称。

regenerateKeyRequest
TopicRegenerateKeyRequest

请求正文以重新生成密钥。

options
TopicsRegenerateKeyOptionalParams

选项参数。

返回

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

beginRegenerateKeyAndWait(string, string, TopicRegenerateKeyRequest, TopicsRegenerateKeyOptionalParams)

重新生成主题的共享访问密钥。

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

参数

resourceGroupName

string

用户订阅中的资源组的名称。

topicName

string

主题的名称。

regenerateKeyRequest
TopicRegenerateKeyRequest

请求正文以重新生成密钥。

options
TopicsRegenerateKeyOptionalParams

选项参数。

返回

beginUpdate(string, string, TopicUpdateParameters, TopicsUpdateOptionalParams)

使用指定的参数异步更新主题。

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

参数

resourceGroupName

string

用户订阅中的资源组的名称。

topicName

string

主题的名称。

topicUpdateParameters
TopicUpdateParameters

主题更新信息。

options
TopicsUpdateOptionalParams

选项参数。

返回

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

beginUpdateAndWait(string, string, TopicUpdateParameters, TopicsUpdateOptionalParams)

使用指定的参数异步更新主题。

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

参数

resourceGroupName

string

用户订阅中的资源组的名称。

topicName

string

主题的名称。

topicUpdateParameters
TopicUpdateParameters

主题更新信息。

options
TopicsUpdateOptionalParams

选项参数。

返回

Promise<void>

get(string, string, TopicsGetOptionalParams)

获取主题的属性。

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

参数

resourceGroupName

string

用户订阅中的资源组的名称。

topicName

string

主题的名称。

options
TopicsGetOptionalParams

选项参数。

返回

Promise<Topic>

listByResourceGroup(string, TopicsListByResourceGroupOptionalParams)

列出资源组下的所有主题。

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

参数

resourceGroupName

string

用户订阅中的资源组的名称。

options
TopicsListByResourceGroupOptionalParams

选项参数。

返回

listBySubscription(TopicsListBySubscriptionOptionalParams)

列出 Azure 订阅下的所有主题。

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

参数

options
TopicsListBySubscriptionOptionalParams

选项参数。

返回

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

列出主题的事件类型。

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

参数

resourceGroupName

string

用户订阅中的资源组的名称。

providerNamespace

string

主题提供程序的命名空间。

resourceTypeName

string

主题类型的名称。

resourceName

string

主题的名称。

options
TopicsListEventTypesOptionalParams

选项参数。

返回

listSharedAccessKeys(string, string, TopicsListSharedAccessKeysOptionalParams)

列出用于发布到主题的两个键。

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

参数

resourceGroupName

string

用户订阅中的资源组的名称。

topicName

string

主题的名称。

返回