Partilhar via

Event Subscriptions - Get

  • Referência
Serviço:
Event Grid
Versão da API:
2025-02-15

Obtenha uma assinatura de evento.
Obtenha as propriedades de uma assinatura de evento.

GET https://management.azure.com/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}?api-version=2025-02-15

Parâmetros do URI

Name Em Necessário Tipo Description
eventSubscriptionName
 path True

string

Nome da assinatura do evento a ser encontrada.
scope
 path True

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 de 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 EventGrid.
api-version
 query True

string

Versão da API a ser usada com a solicitação do cliente.

Respostas

Name Tipo Description
200 OK

EventSubscription

OK
Other Status Codes

Respostas de erro: ***

  • 400 mau pedido.

  • 500 Erro interno do servidor.

Exemplos

EventSubscriptions_GetForCustomTopic
EventSubscriptions_GetForCustomTopic_AzureFunctionDestination
EventSubscriptions_GetForCustomTopic_EventHubDestination
EventSubscriptions_GetForCustomTopic_HybridConnectionDestination
EventSubscriptions_GetForCustomTopic_ServiceBusQueueDestination
EventSubscriptions_GetForCustomTopic_ServiceBusTopicDestination
EventSubscriptions_GetForCustomTopic_StorageQueueDestination
EventSubscriptions_GetForCustomTopic_WebhookDestination
EventSubscriptions_GetForResource
EventSubscriptions_GetForResourceGroup
EventSubscriptions_GetForSubscription

EventSubscriptions_GetForCustomTopic

Pedido de amostra

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Resposta da amostra

Código de estado:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_AzureFunctionDestination

Pedido de amostra

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Resposta da amostra

Código de estado:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Web/sites/ContosoSite/funtions/ContosoFunc"
      },
      "endpointType": "AzureFunction"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_EventHubDestination

Pedido de amostra

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Resposta da amostra

Código de estado:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      },
      "endpointType": "EventHub"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_HybridConnectionDestination

Pedido de amostra

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Resposta da amostra

Código de estado:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"
      },
      "endpointType": "HybridConnection"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_ServiceBusQueueDestination

Pedido de amostra

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Resposta da amostra

Código de estado:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/queues/SBQ"
      },
      "endpointType": "ServiceBusQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_ServiceBusTopicDestination

Pedido de amostra

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Resposta da amostra

Código de estado:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/topics/SBT"
      },
      "endpointType": "ServiceBusTopic"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_StorageQueueDestination

Pedido de amostra

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Resposta da amostra

Código de estado:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "queueName": "queue1",
        "queueMessageTimeToLiveInSeconds": 300
      },
      "endpointType": "StorageQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_WebhookDestination

Pedido de amostra

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Resposta da amostra

Código de estado:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForResource

Pedido de amostra

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Resposta da amostra

Código de estado:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      },
      "endpointType": "EventHub"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForResourceGroup

Pedido de amostra

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2?api-version=2025-02-15

Resposta da amostra

Código de estado:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
  "name": "examplesubscription2",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForSubscription

Pedido de amostra

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3?api-version=2025-02-15

Resposta da amostra

Código de estado:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
  "name": "examplesubscription3",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

Definições

Name Description
AzureFunctionEventSubscriptionDestination

Informações sobre o destino da função azure para uma assinatura de evento.
BoolEqualsAdvancedFilter

BoolEquals Filtro Avançado.
createdByType

O tipo de identidade que criou o recurso.
DeadLetterWithResourceIdentity

Informações sobre o destino da letra morta com identidade do recurso.
DeliveryWithResourceIdentity

Informações sobre a entrega de uma assinatura de evento com identidade de recurso.
DynamicDeliveryAttributeMapping

Detalhes do mapeamento de atributos de entrega dinâmica.
EventDeliverySchema

O esquema de entrega de eventos para a assinatura do evento.
EventHubEventSubscriptionDestination

Informações sobre o destino do hub de eventos para uma assinatura de evento.
EventSubscription

Subscrição de Eventos.
EventSubscriptionFilter

Filtro para a Subscrição do Evento.
EventSubscriptionIdentity

As informações de identidade com a assinatura do evento.
EventSubscriptionIdentityType

O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'.
EventSubscriptionProvisioningState

Estado de provisionamento da assinatura do evento.
HybridConnectionEventSubscriptionDestination

Informações sobre o destino HybridConnection para uma assinatura de evento.
IsNotNullAdvancedFilter

Filtro avançado IsNotNull.
IsNullOrUndefinedAdvancedFilter

Filtro avançado IsNullOrUndefined.
MonitorAlertEventSubscriptionDestination

Informações sobre o destino do Alerta do Monitor para uma assinatura de evento.
MonitorAlertSeverity

A gravidade que será anexada a cada Alerta disparado por meio dessa assinatura de evento. Este campo deve ser fornecido.
NamespaceTopicEventSubscriptionDestination

Informações sobre o destino do Tópico de Namespace para uma assinatura de evento.
NumberGreaterThanAdvancedFilter

Filtro avançado NumberGreaterThan.
NumberGreaterThanOrEqualsAdvancedFilter

Filtro avançado NumberGreaterThanOrEquals.
NumberInAdvancedFilter

NumberIn Filtro Avançado.
NumberInRangeAdvancedFilter

Filtro avançado NumberInRange.
NumberLessThanAdvancedFilter

Filtro avançado NumberLessThan.
NumberLessThanOrEqualsAdvancedFilter

Filtro avançado NumberLessThanOrEquals.
NumberNotInAdvancedFilter

Filtro avançado NumberNotIn.
NumberNotInRangeAdvancedFilter

Filtro avançado NumberNotInRange.
RetryPolicy

Informações sobre a política de repetição para uma assinatura de evento.
ServiceBusQueueEventSubscriptionDestination

Informações sobre o destino do barramento de serviço para uma assinatura de evento.
ServiceBusTopicEventSubscriptionDestination

Informações sobre o destino do tópico do barramento de serviço para uma assinatura de evento.
StaticDeliveryAttributeMapping

Detalhes de mapeamento de atributos de entrega estáticos.
StorageBlobDeadLetterDestination

Informações sobre o destino de letra morta baseado em blob de armazenamento.
StorageQueueEventSubscriptionDestination

Informações sobre o destino da fila de armazenamento para uma assinatura de evento.
StringBeginsWithAdvancedFilter

StringBeginsCom filtro avançado.
StringContainsAdvancedFilter

StringContains Filtro Avançado.
StringEndsWithAdvancedFilter

StringEndsCom filtro avançado.
StringInAdvancedFilter

Filtro avançado StringIn.
StringNotBeginsWithAdvancedFilter

StringNotBeginsCom filtro avançado.
StringNotContainsAdvancedFilter

StringNotContains Filtro Avançado.
StringNotEndsWithAdvancedFilter

StringNotEndsCom filtro avançado.
StringNotInAdvancedFilter

Filtro avançado StringNotIn.
systemData

Metadados referentes à criação e última modificação do recurso.
TlsVersion

Versão TLS mínima do editor que pode publicar neste domínio
WebHookEventSubscriptionDestination

Informações sobre o destino do webhook para uma assinatura de evento.

AzureFunctionEventSubscriptionDestination

Object

Informações sobre o destino da função azure para uma assinatura de evento.

Name Tipo Default value Description
endpointType string:

AzureFunction

Tipo de ponto de extremidade para o destino da assinatura do evento.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalhes do atributo de entrega.
properties.maxEventsPerBatch

integer

1

Número máximo de eventos por lote.
properties.preferredBatchSizeInKilobytes

integer

64

Tamanho de lote preferido em kilobytes.
properties.resourceId

string

A Id de Recursos do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento.

BoolEqualsAdvancedFilter

Object

BoolEquals Filtro Avançado.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

BoolEquals

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value

boolean

O valor do filtro booleano.

createdByType

Enumeration

O tipo de identidade que criou o recurso.

Valor Description
Application
Key
ManagedIdentity
User

DeadLetterWithResourceIdentity

Object

Informações sobre o destino da letra morta com identidade do recurso.

Name Tipo Description
deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante o dead-lettering.
identity

EventSubscriptionIdentity

A identidade a ser usada quando eventos de letras mortas.

DeliveryWithResourceIdentity

Object

Informações sobre a entrega de uma assinatura de evento com identidade de recurso.

Name Tipo Description
destination EventSubscriptionDestination:

Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega.
identity

EventSubscriptionIdentity

A identidade a ser usada ao entregar eventos.

DynamicDeliveryAttributeMapping

Object

Detalhes do mapeamento de atributos de entrega dinâmica.

Name Tipo Description
name

string

Nome do atributo de entrega ou cabeçalho.
properties.sourceField

string

Caminho JSON no evento que contém o valor do atributo.
type string:

Dynamic

Tipo do atributo de entrega ou nome do cabeçalho.

EventDeliverySchema

Enumeration

O esquema de entrega de eventos para a assinatura do evento.

Valor Description
CloudEventSchemaV1_0
CustomInputSchema
EventGridSchema

EventHubEventSubscriptionDestination

Object

Informações sobre o destino do hub de eventos para uma assinatura de evento.

Name Tipo Description
endpointType string:

EventHub

Tipo de ponto de extremidade para o destino da assinatura do evento.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalhes do atributo de entrega.
properties.resourceId

string

A Id de Recursos do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento.

EventSubscription

Object

Subscrição de Eventos.

Name Tipo Default value Description
id

string

Identificador totalmente qualificado do recurso.
name

string

Nome do recurso.
properties.deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

O destino letra morta da assinatura do evento. Qualquer evento que não possa ser entregue no seu destino é enviado para o destino letra morta. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
properties.deadLetterWithResourceIdentity

DeadLetterWithResourceIdentity

O destino letra morta da assinatura do evento. Qualquer evento que não possa ser entregue no seu destino é enviado para o destino letra morta. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
properties.deliveryWithResourceIdentity

DeliveryWithResourceIdentity

Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
properties.destination EventSubscriptionDestination:

Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
properties.eventDeliverySchema

EventDeliverySchema

EventGridSchema

O esquema de entrega de eventos para a assinatura do evento.
properties.expirationTimeUtc

string

Tempo de expiração da subscrição do evento.
properties.filter

EventSubscriptionFilter

Informações sobre o filtro para a assinatura do evento.
properties.labels

string[]

Lista de rótulos definidos pelo usuário.
properties.provisioningState

EventSubscriptionProvisioningState

Estado de provisionamento da assinatura do evento.
properties.retryPolicy

RetryPolicy

A política de repetição para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e o tempo de vida dos eventos.
properties.topic

string

Nome do tópico da assinatura do evento.
systemData

systemData

Os metadados do sistema relacionados ao recurso Grade de Eventos.
type

string

Tipo de recurso.

EventSubscriptionFilter

Object

Filtro para a Subscrição do Evento.

Name Tipo Default value Description
advancedFilters AdvancedFilter[]:

Uma matriz de filtros avançados que são usados para filtrar assinaturas de eventos.
enableAdvancedFilteringOnArrays

boolean

Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular.
includedEventTypes

string[]

Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar se inscrever em todos os tipos de evento padrão, defina IncludedEventTypes como null.
isSubjectCaseSensitive

boolean

False

Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro devem ser comparadas de maneira sensível a maiúsculas e minúsculas.
subjectBeginsWith

string

Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho.
subjectEndsWith

string

Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho.

EventSubscriptionIdentity

Object

As informações de identidade com a assinatura do evento.

Name Tipo Description
type

EventSubscriptionIdentityType

O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'.
userAssignedIdentity

string

A identidade do usuário associada ao recurso.

EventSubscriptionIdentityType

Enumeration

O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'.

Valor Description
SystemAssigned
UserAssigned

EventSubscriptionProvisioningState

Enumeration

Estado de provisionamento da assinatura do evento.

Valor Description
AwaitingManualAction
Canceled
Creating
Deleting
Failed
Succeeded
Updating

HybridConnectionEventSubscriptionDestination

Object

Informações sobre o destino HybridConnection para uma assinatura de evento.

Name Tipo Description
endpointType string:

HybridConnection

Tipo de ponto de extremidade para o destino da assinatura do evento.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalhes do atributo de entrega.
properties.resourceId

string

A ID de Recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento.

IsNotNullAdvancedFilter

Object

Filtro avançado IsNotNull.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

IsNotNull

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.

IsNullOrUndefinedAdvancedFilter

Object

Filtro avançado IsNullOrUndefined.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

IsNullOrUndefined

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.

MonitorAlertEventSubscriptionDestination

Object

Informações sobre o destino do Alerta do Monitor para uma assinatura de evento.

Name Tipo Description
endpointType string:

MonitorAlert

Tipo de ponto de extremidade para o destino da assinatura do evento.
properties.actionGroups

string[]

A lista de IDs ARM de Grupos de Ação que serão acionados em cada Alerta disparado por meio dessa assinatura de evento. Cada ID ARM de recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
properties.description

string

A descrição que será anexada a cada Alerta disparado através desta subscrição de evento.
properties.severity

MonitorAlertSeverity

A gravidade que será anexada a cada Alerta disparado por meio dessa assinatura de evento. Este campo deve ser fornecido.

MonitorAlertSeverity

Enumeration

A gravidade que será anexada a cada Alerta disparado por meio dessa assinatura de evento. Este campo deve ser fornecido.

Valor Description
Sev0
Sev1
Sev2
Sev3
Sev4

NamespaceTopicEventSubscriptionDestination

Object

Informações sobre o destino do Tópico de Namespace para uma assinatura de evento.

Name Tipo Description
endpointType string:

NamespaceTopic

Tipo de ponto de extremidade para o destino da assinatura do evento.
properties.resourceId

string

A ID do recurso do Azure que representa o ponto de extremidade do destino do Tópico de Namespace da Grade de Eventos de uma assinatura de evento. Este campo é obrigatório e o recurso Tópico de Espaço de Nomes listado já deve existir. A ID ARM do recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.

NumberGreaterThanAdvancedFilter

Object

Filtro avançado NumberGreaterThan.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

NumberGreaterThan

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value

number

O valor do filtro.

NumberGreaterThanOrEqualsAdvancedFilter

Object

Filtro avançado NumberGreaterThanOrEquals.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

NumberGreaterThanOrEquals

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value

number

O valor do filtro.

NumberInAdvancedFilter

Object

NumberIn Filtro Avançado.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

NumberIn

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values

number[]

O conjunto de valores de filtro.

NumberInRangeAdvancedFilter

Object

Filtro avançado NumberInRange.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

NumberInRange

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values

number[]

O conjunto de valores de filtro.

NumberLessThanAdvancedFilter

Object

Filtro avançado NumberLessThan.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

NumberLessThan

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value

number

O valor do filtro.

NumberLessThanOrEqualsAdvancedFilter

Object

Filtro avançado NumberLessThanOrEquals.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

NumberLessThanOrEquals

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value

number

O valor do filtro.

NumberNotInAdvancedFilter

Object

Filtro avançado NumberNotIn.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

NumberNotIn

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values

number[]

O conjunto de valores de filtro.

NumberNotInRangeAdvancedFilter

Object

Filtro avançado NumberNotInRange.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

NumberNotInRange

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values

number[]

O conjunto de valores de filtro.

RetryPolicy

Object

Informações sobre a política de repetição para uma assinatura de evento.

Name Tipo Default value Description
eventTimeToLiveInMinutes

integer

1440

Time To Live (em minutos) para eventos.
maxDeliveryAttempts

integer

30

Número máximo de tentativas de repetição de entrega para eventos.

ServiceBusQueueEventSubscriptionDestination

Object

Informações sobre o destino do barramento de serviço para uma assinatura de evento.

Name Tipo Description
endpointType string:

ServiceBusQueue

Tipo de ponto de extremidade para o destino da assinatura do evento.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalhes do atributo de entrega.
properties.resourceId

string

A Id de Recurso do Azure que representa o ponto de extremidade do destino do Service Bus de uma assinatura de evento.

ServiceBusTopicEventSubscriptionDestination

Object

Informações sobre o destino do tópico do barramento de serviço para uma assinatura de evento.

Name Tipo Description
endpointType string:

ServiceBusTopic

Tipo de ponto de extremidade para o destino da assinatura do evento.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalhes do atributo de entrega.
properties.resourceId

string

A Id de Recurso do Azure que representa o ponto de extremidade do destino do Tópico do Service Bus de uma assinatura de evento.

StaticDeliveryAttributeMapping

Object

Detalhes de mapeamento de atributos de entrega estáticos.

Name Tipo Default value Description
name

string

Nome do atributo de entrega ou cabeçalho.
properties.isSecret

boolean

False

Sinalizador booleano para saber se o atributo contém informações confidenciais.
properties.value

string

Valor do atributo delivery.
type string:

Static

Tipo do atributo de entrega ou nome do cabeçalho.

StorageBlobDeadLetterDestination

Object

Informações sobre o destino de letra morta baseado em blob de armazenamento.

Name Tipo Description
endpointType string:

StorageBlob

Tipo de ponto de extremidade para o destino da letra morta
properties.blobContainerName

string

O nome do contêiner de blob de armazenamento que é o destino dos eventos deadletter
properties.resourceId

string

A ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos deadletter

StorageQueueEventSubscriptionDestination

Object

Informações sobre o destino da fila de armazenamento para uma assinatura de evento.

Name Tipo Description
endpointType string:

StorageQueue

Tipo de ponto de extremidade para o destino da assinatura do evento.
properties.queueMessageTimeToLiveInSeconds

integer

Tempo de vida da mensagem da fila de armazenamento em segundos. Esse valor não pode ser zero ou negativo, com exceção do uso de -1 para indicar que o Tempo de Vida da mensagem é Infinito.
properties.queueName

string

O nome da fila de armazenamento em uma conta de armazenamento que é o destino de uma assinatura de evento.
properties.resourceId

string

A ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma assinatura de evento.

StringBeginsWithAdvancedFilter

Object

StringBeginsCom filtro avançado.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

StringBeginsWith

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values

string[]

O conjunto de valores de filtro.

StringContainsAdvancedFilter

Object

StringContains Filtro Avançado.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

StringContains

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values

string[]

O conjunto de valores de filtro.

StringEndsWithAdvancedFilter

Object

StringEndsCom filtro avançado.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

StringEndsWith

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values

string[]

O conjunto de valores de filtro.

StringInAdvancedFilter

Object

Filtro avançado StringIn.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

StringIn

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values

string[]

O conjunto de valores de filtro.

StringNotBeginsWithAdvancedFilter

Object

StringNotBeginsCom filtro avançado.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

StringNotBeginsWith

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values

string[]

O conjunto de valores de filtro.

StringNotContainsAdvancedFilter

Object

StringNotContains Filtro Avançado.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

StringNotContains

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values

string[]

O conjunto de valores de filtro.

StringNotEndsWithAdvancedFilter

Object

StringNotEndsCom filtro avançado.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

StringNotEndsWith

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values

string[]

O conjunto de valores de filtro.

StringNotInAdvancedFilter

Object

Filtro avançado StringNotIn.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType string:

StringNotIn

O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values

string[]

O conjunto de valores de filtro.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

TlsVersion

Enumeration

Versão TLS mínima do editor que pode publicar neste domínio

Valor Description
1.0
1.1
1.2

WebHookEventSubscriptionDestination

Object

Informações sobre o destino do webhook para uma assinatura de evento.

Name Tipo Default value Description
endpointType string:

WebHook

Tipo de ponto de extremidade para o destino da assinatura do evento.
properties.azureActiveDirectoryApplicationIdOrUri

string

A ID do Aplicativo do Ative Directory do Azure ou URI para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega.
properties.azureActiveDirectoryTenantId

string

A ID do Locatário do Ative Directory do Azure para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalhes do atributo de entrega.
properties.endpointBaseUrl

string

A URL base que representa o ponto de extremidade do destino de uma assinatura de evento.
properties.endpointUrl

string

A URL que representa o ponto de extremidade do destino de uma assinatura de evento.
properties.maxEventsPerBatch

integer

1

Número máximo de eventos por lote.
properties.minimumTlsVersionAllowed

TlsVersion

Versão mínima do TLS que deve ser suportada pelo ponto de extremidade do webhook
properties.preferredBatchSizeInKilobytes

integer

64

Tamanho de lote preferido em kilobytes.