Compartilhar via


EventSubscriptions interface

Interface que representa eventSubscriptions.

Métodos

beginCreateOrUpdate(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

Cria de forma assíncrona uma nova assinatura de evento ou atualiza uma assinatura de evento existente com base no escopo especificado.

beginCreateOrUpdateAndWait(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

Cria de forma assíncrona uma nova assinatura de evento ou atualiza uma assinatura de evento existente com base no escopo especificado.

beginDelete(string, string, EventSubscriptionsDeleteOptionalParams)

Exclua uma assinatura de evento existente.

beginDeleteAndWait(string, string, EventSubscriptionsDeleteOptionalParams)

Exclua uma assinatura de evento existente.

beginUpdate(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

Atualiza de forma assíncrona uma assinatura de evento existente.

beginUpdateAndWait(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

Atualiza de forma assíncrona uma assinatura de evento existente.

get(string, string, EventSubscriptionsGetOptionalParams)

Obter propriedades de uma assinatura de evento.

getDeliveryAttributes(string, string, EventSubscriptionsGetDeliveryAttributesOptionalParams)

Obtenha todos os atributos de entrega para uma assinatura de evento.

getFullUrl(string, string, EventSubscriptionsGetFullUrlOptionalParams)

Obtenha a URL completa do ponto de extremidade para uma assinatura de evento.

listByDomainTopic(string, string, string, EventSubscriptionsListByDomainTopicOptionalParams)

Liste todas as assinaturas de evento que foram criadas para um tópico de domínio específico.

listByResource(string, string, string, string, EventSubscriptionsListByResourceOptionalParams)

Liste todas as assinaturas de evento que foram criadas para um recurso específico.

listGlobalByResourceGroup(string, EventSubscriptionsListGlobalByResourceGroupOptionalParams)

Liste todas as assinaturas de eventos globais em uma assinatura e grupo de recursos específicos do Azure.

listGlobalByResourceGroupForTopicType(string, string, EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams)

Liste todas as assinaturas de eventos globais em um grupo de recursos para um tipo de tópico específico.

listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)

Liste todas as assinaturas de evento global agregadas em uma assinatura específica do Azure.

listGlobalBySubscriptionForTopicType(string, EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams)

Liste todas as assinaturas de evento global em uma assinatura do Azure para um tipo de tópico.

listRegionalByResourceGroup(string, string, EventSubscriptionsListRegionalByResourceGroupOptionalParams)

Liste todas as assinaturas de evento do local especificado em uma assinatura e grupo de recursos específicos do Azure.

listRegionalByResourceGroupForTopicType(string, string, string, EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams)

Liste todas as assinaturas de evento do local especificado em uma assinatura específica do Azure, grupo de recursos e tipo de tópico.

listRegionalBySubscription(string, EventSubscriptionsListRegionalBySubscriptionOptionalParams)

Liste todas as assinaturas de evento do local especificado em uma assinatura específica do Azure.

listRegionalBySubscriptionForTopicType(string, string, EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams)

Liste todas as assinaturas de evento do local especificado em uma assinatura e um tipo de tópico específicos do Azure.

Detalhes do método

beginCreateOrUpdate(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

Cria de forma assíncrona uma nova assinatura de evento ou atualiza uma assinatura de evento existente com base no escopo especificado.

function beginCreateOrUpdate(scope: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: EventSubscriptionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>

Parâmetros

scope

string

O identificador do recurso para o qual a assinatura do evento precisa ser criada ou atualizada. O escopo pode ser uma assinatura ou um grupo de recursos ou um recurso de nível superior pertencente a um namespace do provedor de recursos ou um tópico EventGrid. Por exemplo, use '/subscriptions/{subscriptionId}/' para uma assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para um grupo de recursos, e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para um recurso e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para um tópico do EventGrid.

eventSubscriptionName

string

Nome da assinatura do evento que será criado. Os nomes de assinatura de evento devem ter entre 3 e 64 caracteres de comprimento e devem usar apenas letras alfanuméricas.

eventSubscriptionInfo
EventSubscription

Propriedades de assinatura de evento que contêm as informações de destino e filtro.

options
EventSubscriptionsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

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

beginCreateOrUpdateAndWait(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

Cria de forma assíncrona uma nova assinatura de evento ou atualiza uma assinatura de evento existente com base no escopo especificado.

function beginCreateOrUpdateAndWait(scope: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: EventSubscriptionsCreateOrUpdateOptionalParams): Promise<EventSubscription>

Parâmetros

scope

string

O identificador do recurso para o qual a assinatura do evento precisa ser criada ou atualizada. O escopo pode ser uma assinatura ou um grupo de recursos ou um recurso de nível superior pertencente a um namespace do provedor de recursos ou um tópico EventGrid. Por exemplo, use '/subscriptions/{subscriptionId}/' para uma assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para um grupo de recursos, e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para um recurso e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para um tópico do EventGrid.

eventSubscriptionName

string

Nome da assinatura do evento que será criado. Os nomes de assinatura de evento devem ter entre 3 e 64 caracteres de comprimento e devem usar apenas letras alfanuméricas.

eventSubscriptionInfo
EventSubscription

Propriedades de assinatura de evento que contêm as informações de destino e filtro.

options
EventSubscriptionsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

beginDelete(string, string, EventSubscriptionsDeleteOptionalParams)

Exclua uma assinatura de evento existente.

function beginDelete(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parâmetros

scope

string

O escopo da assinatura do evento. O escopo pode ser uma assinatura ou um grupo de recursos ou um recurso de nível superior pertencente a um namespace do provedor de recursos ou um tópico EventGrid. Por exemplo, use '/subscriptions/{subscriptionId}/' para uma assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para um grupo de recursos, e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para um recurso e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para um tópico do EventGrid.

eventSubscriptionName

string

Nome da assinatura do evento a ser excluída.

options
EventSubscriptionsDeleteOptionalParams

Os parâmetros de opções.

Retornos

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

beginDeleteAndWait(string, string, EventSubscriptionsDeleteOptionalParams)

Exclua uma assinatura de evento existente.

function beginDeleteAndWait(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsDeleteOptionalParams): Promise<void>

Parâmetros

scope

string

O escopo da assinatura do evento. O escopo pode ser uma assinatura ou um grupo de recursos ou um recurso de nível superior pertencente a um namespace do provedor de recursos ou um tópico EventGrid. Por exemplo, use '/subscriptions/{subscriptionId}/' para uma assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para um grupo de recursos, e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para um recurso e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para um tópico do EventGrid.

eventSubscriptionName

string

Nome da assinatura do evento a ser excluída.

options
EventSubscriptionsDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

beginUpdate(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

Atualiza de forma assíncrona uma assinatura de evento existente.

function beginUpdate(scope: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: EventSubscriptionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>

Parâmetros

scope

string

O escopo da assinatura de evento existente. O escopo pode ser uma assinatura ou um grupo de recursos ou um recurso de nível superior pertencente a um namespace do provedor de recursos ou um tópico EventGrid. Por exemplo, use '/subscriptions/{subscriptionId}/' para uma assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para um grupo de recursos, e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para um recurso e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para um tópico do EventGrid.

eventSubscriptionName

string

Nome da assinatura do evento a ser atualizada.

eventSubscriptionUpdateParameters
EventSubscriptionUpdateParameters

Informações de assinatura de evento atualizadas.

options
EventSubscriptionsUpdateOptionalParams

Os parâmetros de opções.

Retornos

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

beginUpdateAndWait(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

Atualiza de forma assíncrona uma assinatura de evento existente.

function beginUpdateAndWait(scope: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: EventSubscriptionsUpdateOptionalParams): Promise<EventSubscription>

Parâmetros

scope

string

O escopo da assinatura de evento existente. O escopo pode ser uma assinatura ou um grupo de recursos ou um recurso de nível superior pertencente a um namespace do provedor de recursos ou um tópico EventGrid. Por exemplo, use '/subscriptions/{subscriptionId}/' para uma assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para um grupo de recursos, e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para um recurso e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para um tópico do EventGrid.

eventSubscriptionName

string

Nome da assinatura do evento a ser atualizada.

eventSubscriptionUpdateParameters
EventSubscriptionUpdateParameters

Informações de assinatura de evento atualizadas.

options
EventSubscriptionsUpdateOptionalParams

Os parâmetros de opções.

Retornos

get(string, string, EventSubscriptionsGetOptionalParams)

Obter propriedades de uma assinatura de evento.

function get(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsGetOptionalParams): Promise<EventSubscription>

Parâmetros

scope

string

O escopo da assinatura do evento. O escopo pode ser uma assinatura ou um grupo de recursos ou um recurso de nível superior pertencente a um namespace do provedor de recursos ou um tópico EventGrid. Por exemplo, use '/subscriptions/{subscriptionId}/' para uma assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para um grupo de recursos, e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para um recurso e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para um tópico do EventGrid.

eventSubscriptionName

string

Nome da assinatura do evento a ser encontrada.

options
EventSubscriptionsGetOptionalParams

Os parâmetros de opções.

Retornos

getDeliveryAttributes(string, string, EventSubscriptionsGetDeliveryAttributesOptionalParams)

Obtenha todos os atributos de entrega para uma assinatura de evento.

function getDeliveryAttributes(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsGetDeliveryAttributesOptionalParams): Promise<DeliveryAttributeListResult>

Parâmetros

scope

string

O escopo da assinatura do evento. O escopo pode ser uma assinatura ou um grupo de recursos ou um recurso de nível superior pertencente a um namespace do provedor de recursos ou um tópico EventGrid. Por exemplo, use '/subscriptions/{subscriptionId}/' para uma assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para um grupo de recursos, e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para um recurso e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para um tópico do EventGrid.

eventSubscriptionName

string

Nome da assinatura do evento.

options
EventSubscriptionsGetDeliveryAttributesOptionalParams

Os parâmetros de opções.

Retornos

getFullUrl(string, string, EventSubscriptionsGetFullUrlOptionalParams)

Obtenha a URL completa do ponto de extremidade para uma assinatura de evento.

function getFullUrl(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsGetFullUrlOptionalParams): Promise<EventSubscriptionFullUrl>

Parâmetros

scope

string

O escopo da assinatura do evento. O escopo pode ser uma assinatura ou um grupo de recursos ou um recurso de nível superior pertencente a um namespace do provedor de recursos ou um tópico EventGrid. Por exemplo, use '/subscriptions/{subscriptionId}/' para uma assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para um grupo de recursos, e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para um recurso e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para um tópico do EventGrid.

eventSubscriptionName

string

Nome da assinatura do evento.

options
EventSubscriptionsGetFullUrlOptionalParams

Os parâmetros de opções.

Retornos

listByDomainTopic(string, string, string, EventSubscriptionsListByDomainTopicOptionalParams)

Liste todas as assinaturas de evento que foram criadas para um tópico de domínio específico.

function listByDomainTopic(resourceGroupName: string, domainName: string, topicName: string, options?: EventSubscriptionsListByDomainTopicOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura do usuário.

domainName

string

Nome do domínio de nível superior.

topicName

string

Nome do tópico de domínio.

options
EventSubscriptionsListByDomainTopicOptionalParams

Os parâmetros de opções.

Retornos

listByResource(string, string, string, string, EventSubscriptionsListByResourceOptionalParams)

Liste todas as assinaturas de evento que foram criadas para um recurso específico.

function listByResource(resourceGroupName: string, providerNamespace: string, resourceTypeName: string, resourceName: string, options?: EventSubscriptionsListByResourceOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura do usuário.

providerNamespace

string

Namespace do provedor do tópico.

resourceTypeName

string

Nome do tipo de recurso.

resourceName

string

Nome do recurso.

options
EventSubscriptionsListByResourceOptionalParams

Os parâmetros de opções.

Retornos

listGlobalByResourceGroup(string, EventSubscriptionsListGlobalByResourceGroupOptionalParams)

Liste todas as assinaturas de eventos globais em uma assinatura e grupo de recursos específicos do Azure.

function listGlobalByResourceGroup(resourceGroupName: string, options?: EventSubscriptionsListGlobalByResourceGroupOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura do usuário.

options
EventSubscriptionsListGlobalByResourceGroupOptionalParams

Os parâmetros de opções.

Retornos

listGlobalByResourceGroupForTopicType(string, string, EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams)

Liste todas as assinaturas de eventos globais em um grupo de recursos para um tipo de tópico específico.

function listGlobalByResourceGroupForTopicType(resourceGroupName: string, topicTypeName: string, options?: EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura do usuário.

topicTypeName

string

Nome do tipo de tópico.

Retornos

listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)

Liste todas as assinaturas de evento global agregadas em uma assinatura específica do Azure.

function listGlobalBySubscription(options?: EventSubscriptionsListGlobalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parâmetros

options
EventSubscriptionsListGlobalBySubscriptionOptionalParams

Os parâmetros de opções.

Retornos

listGlobalBySubscriptionForTopicType(string, EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams)

Liste todas as assinaturas de evento global em uma assinatura do Azure para um tipo de tópico.

function listGlobalBySubscriptionForTopicType(topicTypeName: string, options?: EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parâmetros

topicTypeName

string

Nome do tipo de tópico.

Retornos

listRegionalByResourceGroup(string, string, EventSubscriptionsListRegionalByResourceGroupOptionalParams)

Liste todas as assinaturas de evento do local especificado em uma assinatura e grupo de recursos específicos do Azure.

function listRegionalByResourceGroup(resourceGroupName: string, location: string, options?: EventSubscriptionsListRegionalByResourceGroupOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura do usuário.

location

string

Nome da localização.

Retornos

listRegionalByResourceGroupForTopicType(string, string, string, EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams)

Liste todas as assinaturas de evento do local especificado em uma assinatura específica do Azure, grupo de recursos e tipo de tópico.

function listRegionalByResourceGroupForTopicType(resourceGroupName: string, location: string, topicTypeName: string, options?: EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura do usuário.

location

string

Nome da localização.

topicTypeName

string

Nome do tipo de tópico.

Retornos

listRegionalBySubscription(string, EventSubscriptionsListRegionalBySubscriptionOptionalParams)

Liste todas as assinaturas de evento do local especificado em uma assinatura específica do Azure.

function listRegionalBySubscription(location: string, options?: EventSubscriptionsListRegionalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parâmetros

location

string

Nome da localização.

Retornos

listRegionalBySubscriptionForTopicType(string, string, EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams)

Liste todas as assinaturas de evento do local especificado em uma assinatura e um tipo de tópico específicos do Azure.

function listRegionalBySubscriptionForTopicType(location: string, topicTypeName: string, options?: EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parâmetros

location

string

Nome da localização.

topicTypeName

string

Nome do tipo de tópico.

Retornos