Topics interface

Pacote:

@azure/arm-eventgrid

Interface que representa tópicos.

Métodos

beginCreateOrUpdate(string, string, Topic, TopicsCreateOrUpdateOptionalParams)	Cria de forma assíncrona um novo tópico com os parâmetros especificados.
beginCreateOrUpdateAndWait(string, string, Topic, TopicsCreateOrUpdateOptionalParams)	Cria de forma assíncrona um novo tópico com os parâmetros especificados.
beginDelete(string, string, TopicsDeleteOptionalParams)	Eliminar tópico existente.
beginDeleteAndWait(string, string, TopicsDeleteOptionalParams)	Eliminar tópico existente.
beginRegenerateKey(string, string, TopicRegenerateKeyRequest, TopicsRegenerateKeyOptionalParams)	Regenerar uma chave de acesso partilhado para um tópico.
beginRegenerateKeyAndWait(string, string, TopicRegenerateKeyRequest, TopicsRegenerateKeyOptionalParams)	Regenerar uma chave de acesso partilhado para um tópico.
beginUpdate(string, string, TopicUpdateParameters, TopicsUpdateOptionalParams)	Atualiza de forma assíncrona um tópico com os parâmetros especificados.
beginUpdateAndWait(string, string, TopicUpdateParameters, TopicsUpdateOptionalParams)	Atualiza de forma assíncrona um tópico com os parâmetros especificados.
get(string, string, TopicsGetOptionalParams)	Obter propriedades de um tópico.
listByResourceGroup(string, TopicsListByResourceGroupOptionalParams)	Liste todos os tópicos num grupo de recursos.
listBySubscription(TopicsListBySubscriptionOptionalParams)	Liste todos os tópicos numa subscrição do Azure.
listEventTypes(string, string, string, string, TopicsListEventTypesOptionalParams)	Listar tipos de eventos para um tópico.
listSharedAccessKeys(string, string, TopicsListSharedAccessKeysOptionalParams)	Liste as duas chaves utilizadas para publicar num tópico.

Detalhes de Método

beginCreateOrUpdate(string, string, Topic, TopicsCreateOrUpdateOptionalParams)

Cria de forma assíncrona um novo tópico com os parâmetros especificados.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na subscrição do utilizador.

topicName

string

Nome do tópico.

topicInfo

Topic

Informações do tópico.

options

TopicsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

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

beginCreateOrUpdateAndWait(string, string, Topic, TopicsCreateOrUpdateOptionalParams)

Cria de forma assíncrona um novo tópico com os parâmetros especificados.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na subscrição do utilizador.

topicName

string

Nome do tópico.

topicInfo

Topic

Informações do tópico.

options

TopicsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<Topic>

beginDelete(string, string, TopicsDeleteOptionalParams)

Eliminar tópico existente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na subscrição do utilizador.

topicName

string

Nome do tópico.

options

TopicsDeleteOptionalParams

Os parâmetros de opções.

Devoluções

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

beginDeleteAndWait(string, string, TopicsDeleteOptionalParams)

Eliminar tópico existente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na subscrição do utilizador.

topicName

string

Nome do tópico.

options

TopicsDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

beginRegenerateKey(string, string, TopicRegenerateKeyRequest, TopicsRegenerateKeyOptionalParams)

Regenerar uma chave de acesso partilhado para um tópico.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na subscrição do utilizador.

topicName

string

Nome do tópico.

regenerateKeyRequest

TopicRegenerateKeyRequest

Peça ao corpo para regenerar a chave.

options

TopicsRegenerateKeyOptionalParams

Os parâmetros de opções.

Devoluções

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

beginRegenerateKeyAndWait(string, string, TopicRegenerateKeyRequest, TopicsRegenerateKeyOptionalParams)

Regenerar uma chave de acesso partilhado para um tópico.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na subscrição do utilizador.

topicName

string

Nome do tópico.

regenerateKeyRequest

TopicRegenerateKeyRequest

Peça ao corpo para regenerar a chave.

options

TopicsRegenerateKeyOptionalParams

Os parâmetros de opções.

Devoluções

Promise<TopicSharedAccessKeys>

beginUpdate(string, string, TopicUpdateParameters, TopicsUpdateOptionalParams)

Atualiza de forma assíncrona um tópico com os parâmetros especificados.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na subscrição do utilizador.

topicName

string

Nome do tópico.

topicUpdateParameters

TopicUpdateParameters

Informações de atualização do tópico.

options

TopicsUpdateOptionalParams

Os parâmetros de opções.

Devoluções

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

beginUpdateAndWait(string, string, TopicUpdateParameters, TopicsUpdateOptionalParams)

Atualiza de forma assíncrona um tópico com os parâmetros especificados.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na subscrição do utilizador.

topicName

string

Nome do tópico.

topicUpdateParameters

TopicUpdateParameters

Informações de atualização do tópico.

options

TopicsUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, string, TopicsGetOptionalParams)

Obter propriedades de um tópico.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na subscrição do utilizador.

topicName

string

Nome do tópico.

options

TopicsGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<Topic>

listByResourceGroup(string, TopicsListByResourceGroupOptionalParams)

Liste todos os tópicos num grupo de recursos.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na subscrição do utilizador.

options

TopicsListByResourceGroupOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<Topic, Topic[], PageSettings>

listBySubscription(TopicsListBySubscriptionOptionalParams)

Liste todos os tópicos numa subscrição do Azure.

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

Parâmetros

options

TopicsListBySubscriptionOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<Topic, Topic[], PageSettings>

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

Listar tipos de eventos para um tópico.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na subscrição do utilizador.

providerNamespace

string

Espaço de nomes do fornecedor do tópico.

resourceTypeName

string

Nome do tipo de tópico.

resourceName

string

Nome do tópico.

options

TopicsListEventTypesOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<EventType, EventType[], PageSettings>

listSharedAccessKeys(string, string, TopicsListSharedAccessKeysOptionalParams)

Liste as duas chaves utilizadas para publicar num tópico.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na subscrição do utilizador.

topicName

string

Nome do tópico.

options

TopicsListSharedAccessKeysOptionalParams

Os parâmetros de opções.

Devoluções

Promise<TopicSharedAccessKeys>