Microsoft.EventGrid eventSubscriptions
- Mais recente
- 2023-12-15-preview
- 2023-06-01-preview
- 2022-06-15
- 2021-12-01
- 2021-10-15-preview
- 2021-06-01-preview
- 2020-10-15-preview
- 2020-06-01
- 2020-04-01-preview
- 2020-01-01-preview
- 2019-06-01
- 2019-02-01-preview
- 2019-01-01
- 2018-09-15-preview
- 2018-05-01-preview
- 2018-01-01
- 2017-09-15-preview
- 2017-06-15-preview
Definição de recurso do Bicep
O tipo de recurso eventSubscriptions é um recurso de extensão, o que significa que você pode aplicá-lo a outro recurso.
Use a scope propriedade nesse recurso para definir o escopo desse recurso. Consulte Definir escopo em recursos de extensão no Bicep.
O tipo de recurso eventSubscriptions pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
- Assinaturas – Consulte comandos de implantação de assinatura
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o seguinte Bicep ao modelo.
resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2023-12-15-preview' = {
name: 'string'
scope: resourceSymbolicName
properties: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
deadLetterWithResourceIdentity: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
deliveryWithResourceIdentity: {
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
eventDeliverySchema: 'string'
expirationTimeUtc: 'string'
filter: {
advancedFilters: [
{
key: 'string'
operatorType: 'string'
// For remaining properties, see AdvancedFilter objects
}
]
enableAdvancedFilteringOnArrays: bool
includedEventTypes: [
'string'
]
isSubjectCaseSensitive: bool
subjectBeginsWith: 'string'
subjectEndsWith: 'string'
}
labels: [
'string'
]
retryPolicy: {
eventTimeToLiveInMinutes: int
maxDeliveryAttempts: int
}
}
}
Objetos DeadLetterDestination
Defina a propriedade endpointType para especificar o tipo de objeto.
Para StorageBlob, use:
endpointType: 'StorageBlob'
properties: {
blobContainerName: 'string'
resourceId: 'string'
}
Objetos EventSubscriptionDestination
Defina a propriedade endpointType para especificar o tipo de objeto.
Para AzureFunction, use:
endpointType: 'AzureFunction'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
maxEventsPerBatch: int
preferredBatchSizeInKilobytes: int
resourceId: 'string'
}
Para o EventHub, use:
endpointType: 'EventHub'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
Para HybridConnection, use:
endpointType: 'HybridConnection'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
Para MonitorAlert, use:
endpointType: 'MonitorAlert'
properties: {
actionGroups: [
'string'
]
description: 'string'
severity: 'string'
}
Para NamespaceTopic, use:
endpointType: 'NamespaceTopic'
properties: {
resourceId: 'string'
}
Para PartnerDestination, use:
endpointType: 'PartnerDestination'
properties: {
resourceId: 'string'
}
Para ServiceBusQueue, use:
endpointType: 'ServiceBusQueue'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
Para ServiceBusTopic, use:
endpointType: 'ServiceBusTopic'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
Para StorageQueue, use:
endpointType: 'StorageQueue'
properties: {
queueMessageTimeToLiveInSeconds: int
queueName: 'string'
resourceId: 'string'
}
Para WebHook, use:
endpointType: 'WebHook'
properties: {
azureActiveDirectoryApplicationIdOrUri: 'string'
azureActiveDirectoryTenantId: 'string'
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
endpointUrl: 'string'
maxEventsPerBatch: int
minimumTlsVersionAllowed: 'string'
preferredBatchSizeInKilobytes: int
}
Objetos DeliveryAttributeMapping
Defina a propriedade type para especificar o tipo de objeto.
Para Dinâmico, use:
type: 'Dynamic'
properties: {
sourceField: 'string'
}
Para Estático, use:
type: 'Static'
properties: {
isSecret: bool
value: 'string'
}
Objetos AdvancedFilter
Defina a propriedade operatorType para especificar o tipo de objeto.
Para BoolEquals, use:
operatorType: 'BoolEquals'
value: bool
Para IsNotNull, use:
operatorType: 'IsNotNull'
Para IsNullOrUndefined, use:
operatorType: 'IsNullOrUndefined'
Para NumberGreaterThan, use:
operatorType: 'NumberGreaterThan'
value: int
Para NumberGreaterThanOrEquals, use:
operatorType: 'NumberGreaterThanOrEquals'
value: int
Para NumberIn, use:
operatorType: 'NumberIn'
values: [
int
]
Para NumberInRange, use:
operatorType: 'NumberInRange'
values: [
[
int
]
]
Para NumberLessThan, use:
operatorType: 'NumberLessThan'
value: int
Para NumberLessThanOrEquals, use:
operatorType: 'NumberLessThanOrEquals'
value: int
Para NumberNotIn, use:
operatorType: 'NumberNotIn'
values: [
int
]
Para NumberNotInRange, use:
operatorType: 'NumberNotInRange'
values: [
[
int
]
]
Para StringBeginsWith, use:
operatorType: 'StringBeginsWith'
values: [
'string'
]
Para StringContains, use:
operatorType: 'StringContains'
values: [
'string'
]
Para StringEndsWith, use:
operatorType: 'StringEndsWith'
values: [
'string'
]
Para StringIn, use:
operatorType: 'StringIn'
values: [
'string'
]
Para StringNotBeginsWith, use:
operatorType: 'StringNotBeginsWith'
values: [
'string'
]
Para StringNotContains, use:
operatorType: 'StringNotContains'
values: [
'string'
]
Para StringNotEndsWith, use:
operatorType: 'StringNotEndsWith'
values: [
'string'
]
Para StringNotIn, use:
operatorType: 'StringNotIn'
values: [
'string'
]
Valores de propriedade
eventSubscriptions
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia de caracteres (obrigatório) Limite de caracteres: 3-64 Caracteres válidos: Caracteres alfanuméricos e hifens. |
| scope | Use ao criar um recurso de extensão em um escopo diferente do escopo de implantação. | Recurso de destino Para o Bicep, defina essa propriedade como o nome simbólico do recurso para aplicar o recurso de extensão. |
| properties | Propriedades da assinatura do evento. | EventSubscriptionProperties |
EventSubscriptionProperties
| Nome | Descrição | Valor |
|---|---|---|
| deadLetterDestination | O destino de mensagens mortas da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino de mensagens mortas. Usa a identidade do Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas. |
DeadLetterDestination |
| deadLetterWithResourceIdentity | O destino de mensagens mortas da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino de mensagens mortas. 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/mensagens mortas. |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | Informações sobre o destino em que os eventos precisam 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/mensagens mortas. |
DeliveryWithResourceIdentity |
| destino | Informações sobre o destino em que os eventos precisam ser entregues para a assinatura do evento. Usa a identidade do Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas. |
EventSubscriptionDestination |
| eventDeliverySchema | O esquema de entrega de eventos para a assinatura do evento. | 'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema' |
| expirationTimeUtc | Hora de expiração da assinatura do evento. | string |
| filter | Informações sobre o filtro para a assinatura do evento. | EventSubscriptionFilter |
| rótulos | Lista de rótulos definidos pelo usuário. | string[] |
| 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 tempo de vida para eventos. | RetryPolicy |
DeadLetterDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Definir o tipo de objeto | StorageBlob (obrigatório) |
StorageBlobDeadLetterDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino de mensagens mortas | 'StorageBlob' (obrigatório) |
| properties | As propriedades do destino de mensagens mortas baseadas em Blob de Armazenamento | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| blobContainerName | O nome do contêiner de blob de armazenamento que é o destino dos eventos de mensagens mortas | string |
| resourceId | A ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos de mensagens mortas | string |
DeadLetterWithResourceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| deadLetterDestination | Informações sobre o destino em que os eventos precisam 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/mensagens mortas. |
DeadLetterDestination |
| identidade | A identidade a ser usada quando eventos de mensagens mortas. | EventSubscriptionIdentity |
EventSubscriptionIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade. | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | A identidade do usuário associada ao recurso. | string |
DeliveryWithResourceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| destino | Informações sobre o destino em que os eventos precisam ser entregues para a assinatura do evento. Usa a identidade do Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas. |
EventSubscriptionDestination |
| identidade | A identidade a ser usada ao entregar eventos. | EventSubscriptionIdentity |
EventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Definir o tipo de objeto | AzureFunction EventHub HybridConnection MonitorAlert NamespaceTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook (obrigatório) |
AzureFunctionEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'AzureFunction' (obrigatório) |
| properties | Propriedades da Função do Azure do destino da assinatura de evento. | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| maxEventsPerBatch | Número máximo de eventos por lote. | INT |
| preferredBatchSizeInKilobytes | Tamanho de lote preferencial em Kilobytes. | INT |
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento. | string |
DeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| name | Nome do atributo ou cabeçalho de entrega. | string |
| type | Definir o tipo de objeto | Dinâmico Estático (obrigatório) |
DynamicDeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo do atributo de entrega ou do nome do cabeçalho. | 'Dynamic' (obrigatório) |
| properties | Propriedades do mapeamento de atributo de entrega dinâmica. | DynamicDeliveryAttributeMappingProperties |
DynamicDeliveryAttributeMappingProperties
| Nome | Descrição | Valor |
|---|---|---|
| sourceField | Caminho JSON no evento que contém o valor do atributo. | string |
StaticDeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo do atributo de entrega ou do nome do cabeçalho. | 'Static' (obrigatório) |
| properties | Propriedades do mapeamento de atributo de entrega estático. | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
| Nome | Descrição | Valor |
|---|---|---|
| isSecret | Sinalizador booliano para saber se o atributo contém informações confidenciais. | bool |
| value | Valor do atributo de entrega. | string |
EventHubEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'EventHub' (obrigatório) |
| properties | Propriedades do Hub de Eventos do destino da assinatura de evento. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento. | string |
HybridConnectionEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'HybridConnection' (obrigatório) |
| properties | Propriedades de conexão híbrida do destino da assinatura do evento. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | A ID de Recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento. | string |
MonitorAlertEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'MonitorAlert' (obrigatório) |
| properties | Monitore as propriedades de alerta do destino da assinatura do evento. | MonitorAlertEventSubscriptionDestinationProperties |
MonitorAlertEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| actionGroups | A lista de IDs do ARM de Grupos de Ações que serão disparadas em todos os alertas disparados por meio dessa assinatura de evento. Cada ID do ARM de recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}. |
string[] |
| descrição | A descrição que será anexada a cada alerta disparado por meio dessa assinatura de evento. | string |
| severidade | A gravidade que será anexada a cada alerta disparado por meio dessa assinatura de evento. Esse campo deve ser fornecido. |
'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4' |
NamespaceTopicEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'NamespaceTopic' (obrigatório) |
| properties | Propriedades do Tópico do namespace do destino da assinatura do evento. | NamespaceTopicEventSubscriptionDestinationProperties |
NamespaceTopicEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | A ID do recurso do Azure que representa o ponto de extremidade do destino do Tópico do Namespace da Grade de Eventos de uma assinatura de evento. Esse campo é necessário e o recurso Tópico do Namespace listado já deve existir. A ID do ARM do recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}. |
string |
PartnerEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'PartnerDestination' (obrigatório) |
| properties | Propriedades de Destino do Parceiro do destino da assinatura do evento. | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade de um destino de parceiro de uma assinatura de evento. | string |
ServiceBusQueueEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'ServiceBusQueue' (obrigatório) |
| properties | Propriedades do Barramento de Serviço do destino da assinatura do evento. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade do destino do Barramento de Serviço de uma assinatura de evento. | string |
ServiceBusTopicEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'ServiceBusTopic' (obrigatório) |
| properties | Propriedades do Tópico do Barramento de Serviço do destino da assinatura de evento. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade do destino do Tópico do Barramento de Serviço de uma assinatura de evento. | string |
StorageQueueEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'StorageQueue' (obrigatório) |
| properties | Propriedades da Fila de Armazenamento do destino da assinatura de evento. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| queueMessageTimeToLiveInSeconds | Tempo de vida da mensagem da fila de armazenamento em segundos. Esse valor não pode ser zero ou negativo, com exceção de usar -1 para indicar que a Vida Útil da mensagem é Infinita. | INT |
| queueName | O nome da fila de armazenamento em uma conta de armazenamento que é o destino de uma assinatura de evento. | string |
| resourceId | A ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma assinatura de evento. | string |
WebHookEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'WebHook' (obrigatório) |
| properties | Propriedades do WebHook do destino da assinatura de evento. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | A ID ou o URI do Aplicativo do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. | string |
| azureActiveDirectoryTenantId | A ID do locatário do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. | string |
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| endpointUrl | A URL que representa o ponto de extremidade do destino de uma assinatura de evento. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| maxEventsPerBatch | Número máximo de eventos por lote. | INT |
| minimumTlsVersionAllowed | Versão mínima do TLS que deve ser compatível com o ponto de extremidade do webhook | '1.0' '1.1' '1.2' |
| preferredBatchSizeInKilobytes | Tamanho de lote preferencial em Kilobytes. | INT |
EventSubscriptionFilter
| Nome | Descrição | Valor |
|---|---|---|
| Advancedfilters | Uma matriz de filtros avançados que são usados para filtrar assinaturas de evento. | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular. | bool |
| includedEventTypes | Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento padrão, defina IncludedEventTypes como nulo. | string[] |
| isSubjectCaseSensitive | Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de maneira sensível a maiúsculas e minúsculas. |
bool |
| subjectBeginsWith | Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato disso depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho. |
string |
| subjectEndsWith | Uma cadeia de caracteres opcional para filtrar eventos de uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho. |
string |
Advancedfilter
| Nome | Descrição | Valor |
|---|---|---|
| chave | O campo/propriedade no evento com base no qual você deseja filtrar. | string |
| operatorType | Definir o tipo de objeto | BoolEquals Isnotnull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (obrigatório) |
BoolEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'BoolEquals' (obrigatório) |
| value | O valor do filtro booliano. | bool |
IsNotNullAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'IsNotNull' (obrigatório) |
IsNullOrUndefinedAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'IsNullOrUndefined' (obrigatório) |
NumberGreaterThanAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberGreaterThan' (obrigatório) |
| value | O valor do filtro. | INT |
NumberGreaterThanOrEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberGreaterThanOrEquals' (obrigatório) |
| value | O valor do filtro. | INT |
NumberInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberIn' (obrigatório) |
| valores | O conjunto de valores de filtro. | int[] |
NumberInRangeAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberInRange' (obrigatório) |
| valores | O conjunto de valores de filtro. | int[][] |
NumberLessThanAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberLessThan' (obrigatório) |
| value | O valor do filtro. | INT |
NumberLessThanOrEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberLessThanOrEquals' (obrigatório) |
| value | O valor do filtro. | INT |
NumberNotInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberNotIn' (obrigatório) |
| valores | O conjunto de valores de filtro. | int[] |
NumberNotInRangeAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberNotInRange' (obrigatório) |
| valores | O conjunto de valores de filtro. | int[][] |
StringBeginsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringBeginsWith' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringContainsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringContains' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringEndsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringEndsWith' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringIn' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringNotBeginsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringNotBeginsWith' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringNotContainsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringNotContains' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringNotEndsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringNotEndsWith' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringNotInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringNotIn' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
RetryPolicy
| Nome | Descrição | Valor |
|---|---|---|
| eventTimeToLiveInMinutes | Vida útil (em minutos) para eventos. | INT |
| maxDeliveryAttempts | Número máximo de tentativas de repetição de entrega para eventos. | INT |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
Criar Grade de Eventos do Azure tópico e assinatura personalizados |
Cria um tópico personalizado Grade de Eventos do Azure e uma assinatura de webhook. Modelo originalmente criado por John Downs. |
| Tópico/assinatura de Grade de Eventos do Azure personalizado com CloudEvents |
Cria um tópico de Grade de Eventos do Azure personalizado, uma assinatura de webhook com esquema CloudEvents e um Aplicativo Lógico como um manipulador de eventos. Modelo originalmente criado por Justin Yoo. |
| Criar um manipulador personalizado de tópicos e hub de eventos da Grade de Eventos |
Cria um tópico personalizado Grade de Eventos do Azure e um hub de eventos para lidar com os eventos. |
| Criar assinatura da Grade de Eventos para eventos de recurso |
Cria uma assinatura da Grade de Eventos para o grupo de recursos ou a assinatura do Azure. |
| Criar Grade de Eventos do Azure assinatura de fila e tópico personalizado |
Cria um tópico personalizado Grade de Eventos do Azure e uma assinatura de fila do barramento de serviço. Modelo originalmente criado por Markus Meyer. |
| Criar Grade de Eventos do Azure assinatura de tópico personalizado |
Cria um tópico personalizado Grade de Eventos do Azure e uma assinatura de tópico do barramento de serviço. Modelo originalmente criado por Markus Meyer. |
Definição de recurso de modelo do ARM
O tipo de recurso eventSubscriptions é um recurso de extensão, o que significa que você pode aplicá-lo a outro recurso.
Use a scope propriedade nesse recurso para definir o escopo desse recurso. Consulte Definir escopo em recursos de extensão em modelos do ARM.
O tipo de recurso eventSubscriptions pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
- Assinaturas – Consulte comandos de implantação de assinatura
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.EventGrid/eventSubscriptions",
"apiVersion": "2023-12-15-preview",
"name": "string",
"scope": "string",
"properties": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"deadLetterWithResourceIdentity": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"deliveryWithResourceIdentity": {
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"eventDeliverySchema": "string",
"expirationTimeUtc": "string",
"filter": {
"advancedFilters": [
{
"key": "string",
"operatorType": "string"
// For remaining properties, see AdvancedFilter objects
}
],
"enableAdvancedFilteringOnArrays": "bool",
"includedEventTypes": [ "string" ],
"isSubjectCaseSensitive": "bool",
"subjectBeginsWith": "string",
"subjectEndsWith": "string"
},
"labels": [ "string" ],
"retryPolicy": {
"eventTimeToLiveInMinutes": "int",
"maxDeliveryAttempts": "int"
}
}
}
Objetos DeadLetterDestination
Defina a propriedade endpointType para especificar o tipo de objeto.
Para StorageBlob, use:
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "string",
"resourceId": "string"
}
Objetos EventSubscriptionDestination
Defina a propriedade endpointType para especificar o tipo de objeto.
Para AzureFunction, use:
"endpointType": "AzureFunction",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"maxEventsPerBatch": "int",
"preferredBatchSizeInKilobytes": "int",
"resourceId": "string"
}
Para o EventHub, use:
"endpointType": "EventHub",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"resourceId": "string"
}
Para HybridConnection, use:
"endpointType": "HybridConnection",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"resourceId": "string"
}
Para MonitorAlert, use:
"endpointType": "MonitorAlert",
"properties": {
"actionGroups": [ "string" ],
"description": "string",
"severity": "string"
}
Para NamespaceTopic, use:
"endpointType": "NamespaceTopic",
"properties": {
"resourceId": "string"
}
Para PartnerDestination, use:
"endpointType": "PartnerDestination",
"properties": {
"resourceId": "string"
}
Para ServiceBusQueue, use:
"endpointType": "ServiceBusQueue",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"resourceId": "string"
}
Para ServiceBusTopic, use:
"endpointType": "ServiceBusTopic",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"resourceId": "string"
}
Para StorageQueue, use:
"endpointType": "StorageQueue",
"properties": {
"queueMessageTimeToLiveInSeconds": "int",
"queueName": "string",
"resourceId": "string"
}
Para WebHook, use:
"endpointType": "WebHook",
"properties": {
"azureActiveDirectoryApplicationIdOrUri": "string",
"azureActiveDirectoryTenantId": "string",
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"endpointUrl": "string",
"maxEventsPerBatch": "int",
"minimumTlsVersionAllowed": "string",
"preferredBatchSizeInKilobytes": "int"
}
Objetos DeliveryAttributeMapping
Defina a propriedade type para especificar o tipo de objeto.
Para Dinâmico, use:
"type": "Dynamic",
"properties": {
"sourceField": "string"
}
Para Estático, use:
"type": "Static",
"properties": {
"isSecret": "bool",
"value": "string"
}
Objetos AdvancedFilter
Defina a propriedade operatorType para especificar o tipo de objeto .
Para BoolEquals, use:
"operatorType": "BoolEquals",
"value": "bool"
Para IsNotNull, use:
"operatorType": "IsNotNull"
Para IsNullOrUndefined, use:
"operatorType": "IsNullOrUndefined"
Para NumberGreaterThan, use:
"operatorType": "NumberGreaterThan",
"value": "int"
Para NumberGreaterThanOrEquals, use:
"operatorType": "NumberGreaterThanOrEquals",
"value": "int"
Para NumberIn, use:
"operatorType": "NumberIn",
"values": [ "int" ]
Para NumberInRange, use:
"operatorType": "NumberInRange",
"values": [ [ "int" ] ]
Para NumberLessThan, use:
"operatorType": "NumberLessThan",
"value": "int"
Para NumberLessThanOrEquals, use:
"operatorType": "NumberLessThanOrEquals",
"value": "int"
Para NumberNotIn, use:
"operatorType": "NumberNotIn",
"values": [ "int" ]
Para NumberNotInRange, use:
"operatorType": "NumberNotInRange",
"values": [ [ "int" ] ]
Para StringBeginsWith, use:
"operatorType": "StringBeginsWith",
"values": [ "string" ]
Para StringContains, use:
"operatorType": "StringContains",
"values": [ "string" ]
Para StringEndsWith, use:
"operatorType": "StringEndsWith",
"values": [ "string" ]
Para StringIn, use:
"operatorType": "StringIn",
"values": [ "string" ]
Para StringNotBeginsWith, use:
"operatorType": "StringNotBeginsWith",
"values": [ "string" ]
Para StringNotContains, use:
"operatorType": "StringNotContains",
"values": [ "string" ]
Para StringNotEndsWith, use:
"operatorType": "StringNotEndsWith",
"values": [ "string" ]
Para StringNotIn, use:
"operatorType": "StringNotIn",
"values": [ "string" ]
Valores de propriedade
eventSubscriptions
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.EventGrid/eventSubscriptions' |
| apiVersion | A versão da API do recurso | '2023-12-15-preview' |
| name | O nome do recurso | cadeia de caracteres (obrigatório) Limite de caracteres: 3-64 Caracteres válidos: Caracteres alfanuméricos e hifens. |
| scope | Use ao criar um recurso de extensão em um escopo diferente do escopo de implantação. | Recurso de destino Para JSON, defina o valor como o nome completo do recurso ao qual aplicar o recurso de extensão . |
| properties | Propriedades da assinatura do evento. | EventSubscriptionProperties |
EventSubscriptionProperties
| Nome | Descrição | Valor |
|---|---|---|
| deadLetterDestination | O destino de mensagens mortas da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino de mensagens mortas. Usa a identidade do Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas. |
DeadLetterDestination |
| deadLetterWithResourceIdentity | O destino de mensagens mortas da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino de mensagens mortas. 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/mensagens mortas. |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | Informações sobre o destino em que os eventos precisam 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/mensagens mortas. |
DeliveryWithResourceIdentity |
| destino | Informações sobre o destino em que os eventos precisam ser entregues para a assinatura do evento. Usa a identidade do Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas. |
EventSubscriptionDestination |
| eventDeliverySchema | O esquema de entrega de eventos para a assinatura do evento. | 'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema' |
| expirationTimeUtc | Hora de expiração da assinatura do evento. | string |
| filter | Informações sobre o filtro para a assinatura do evento. | EventSubscriptionFilter |
| rótulos | Lista de rótulos definidos pelo usuário. | string[] |
| 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 tempo de vida para eventos. | RetryPolicy |
DeadLetterDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Definir o tipo de objeto | StorageBlob (obrigatório) |
StorageBlobDeadLetterDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino de mensagens mortas | 'StorageBlob' (obrigatório) |
| properties | As propriedades do destino de mensagens mortas baseadas em Blob de Armazenamento | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| blobContainerName | O nome do contêiner de blob de armazenamento que é o destino dos eventos de mensagens mortas | string |
| resourceId | A ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos de mensagens mortas | string |
DeadLetterWithResourceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| deadLetterDestination | Informações sobre o destino em que os eventos precisam 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/mensagens mortas. |
DeadLetterDestination |
| identidade | A identidade a ser usada quando eventos de mensagens mortas. | EventSubscriptionIdentity |
EventSubscriptionIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade. | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | A identidade do usuário associada ao recurso. | string |
DeliveryWithResourceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| destino | Informações sobre o destino em que os eventos precisam ser entregues para a assinatura do evento. Usa a identidade do Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas. |
EventSubscriptionDestination |
| identidade | A identidade a ser usada ao entregar eventos. | EventSubscriptionIdentity |
EventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Definir o tipo de objeto | AzureFunction EventHub HybridConnection MonitorAlert NamespaceTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook (obrigatório) |
AzureFunctionEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'AzureFunction' (obrigatório) |
| properties | Propriedades da Função do Azure do destino da assinatura de evento. | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| maxEventsPerBatch | Número máximo de eventos por lote. | INT |
| preferredBatchSizeInKilobytes | Tamanho de lote preferencial em Kilobytes. | INT |
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento. | string |
DeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| name | Nome do atributo ou cabeçalho de entrega. | string |
| type | Definir o tipo de objeto | Dinâmico Estático (obrigatório) |
DynamicDeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo do atributo de entrega ou do nome do cabeçalho. | 'Dynamic' (obrigatório) |
| properties | Propriedades do mapeamento de atributo de entrega dinâmica. | DynamicDeliveryAttributeMappingProperties |
DynamicDeliveryAttributeMappingProperties
| Nome | Descrição | Valor |
|---|---|---|
| sourceField | Caminho JSON no evento que contém o valor do atributo. | string |
StaticDeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo do atributo de entrega ou do nome do cabeçalho. | 'Static' (obrigatório) |
| properties | Propriedades do mapeamento de atributo de entrega estático. | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
| Nome | Descrição | Valor |
|---|---|---|
| isSecret | Sinalizador booliano para saber se o atributo contém informações confidenciais. | bool |
| value | Valor do atributo de entrega. | string |
EventHubEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'EventHub' (obrigatório) |
| properties | Propriedades do Hub de Eventos do destino da assinatura de evento. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento. | string |
HybridConnectionEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'HybridConnection' (obrigatório) |
| properties | Propriedades de conexão híbrida do destino da assinatura de evento. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | A ID de Recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento. | string |
MonitorAlertEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'MonitorAlert' (obrigatório) |
| properties | Monitorar propriedades de alerta do destino da assinatura de evento. | MonitorAlertEventSubscriptionDestinationProperties |
MonitorAlertEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| actionGroups | A lista de IDs do ARM de Grupos de Ações que serão disparadas em cada alerta disparado por meio dessa assinatura de evento. Cada ID do ARM de recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}. |
string[] |
| descrição | A descrição que será anexada a cada Alerta disparado por meio dessa assinatura de evento. | string |
| severidade | A gravidade que será anexada a cada Alerta disparado por meio dessa assinatura de evento. Esse campo deve ser fornecido. |
'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4' |
NamespaceTopicEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'NamespaceTopic' (obrigatório) |
| properties | Propriedades do Tópico do namespace do destino da assinatura do evento. | NamespaceTopicEventSubscriptionDestinationProperties |
NamespaceTopicEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | A ID do recurso do Azure que representa o ponto de extremidade do destino do Tópico do Namespace da Grade de Eventos de uma assinatura de evento. Esse campo é necessário e o recurso Tópico do Namespace listado já deve existir. A ID do ARM do recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}. |
string |
PartnerEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'PartnerDestination' (obrigatório) |
| properties | Propriedades de Destino do Parceiro do destino da assinatura do evento. | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade de um destino de parceiro de uma assinatura de evento. | string |
ServiceBusQueueEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'ServiceBusQueue' (obrigatório) |
| properties | Propriedades do Barramento de Serviço do destino da assinatura do evento. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade do destino do Barramento de Serviço de uma assinatura de evento. | string |
ServiceBusTopicEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'ServiceBusTopic' (obrigatório) |
| properties | Propriedades do Tópico do Barramento de Serviço do destino da assinatura do evento. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade do destino tópico do Barramento de Serviço de uma assinatura de evento. | string |
StorageQueueEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'StorageQueue' (obrigatório) |
| properties | Propriedades da Fila de Armazenamento do destino da assinatura do evento. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| queueMessageTimeToLiveInSeconds | Tempo de vida da mensagem da fila de armazenamento em segundos. Esse valor não pode ser zero ou negativo, com exceção de usar -1 para indicar que a vida útil da mensagem é Infinita. | INT |
| queueName | O nome da fila de armazenamento em uma conta de armazenamento que é o destino de uma assinatura de evento. | string |
| resourceId | A ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma assinatura de evento. | string |
WebHookEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | 'WebHook' (obrigatório) |
| properties | Propriedades do WebHook do destino da assinatura de evento. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | A ID ou o URI do Aplicativo do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. | string |
| azureActiveDirectoryTenantId | A ID do locatário do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. | string |
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| endpointUrl | A URL que representa o ponto de extremidade do destino de uma assinatura de evento. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| maxEventsPerBatch | Número máximo de eventos por lote. | INT |
| minimumTlsVersionAllowed | Versão mínima do TLS que deve ser compatível com o ponto de extremidade do webhook | '1.0' '1.1' '1.2' |
| preferredBatchSizeInKilobytes | Tamanho de lote preferencial em Kilobytes. | INT |
EventSubscriptionFilter
| Nome | Descrição | Valor |
|---|---|---|
| Advancedfilters | Uma matriz de filtros avançados que são usados para filtrar assinaturas de evento. | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular. | bool |
| includedEventTypes | Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento padrão, defina IncludedEventTypes como nulo. | string[] |
| isSubjectCaseSensitive | Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de uma maneira que diferencia maiúsculas de minúsculas. |
bool |
| subjectBeginsWith | Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato disso depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho. |
string |
| subjectEndsWith | 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. |
string |
Advancedfilter
| Nome | Descrição | Valor |
|---|---|---|
| chave | O campo/propriedade no evento com base no qual você deseja filtrar. | string |
| operatorType | Definir o tipo de objeto | BoolEquals Isnotnull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (obrigatório) |
BoolEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'BoolEquals' (obrigatório) |
| value | O valor do filtro booliano. | bool |
IsNotNullAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'IsNotNull' (obrigatório) |
IsNullOrUndefinedAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'IsNullOrUndefined' (obrigatório) |
NumberGreaterThanAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberGreaterThan' (obrigatório) |
| value | O valor do filtro. | INT |
NumberGreaterThanOrEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberGreaterThanOrEquals' (obrigatório) |
| value | O valor do filtro. | INT |
NumberInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberIn' (obrigatório) |
| valores | O conjunto de valores de filtro. | int[] |
NumberInRangeAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberInRange' (obrigatório) |
| valores | O conjunto de valores de filtro. | int[][] |
NumberLessThanAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberLessThan' (obrigatório) |
| value | O valor do filtro. | INT |
NumberLessThanOrEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberLessThanOrEquals' (obrigatório) |
| value | O valor do filtro. | INT |
NumberNotInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberNotIn' (obrigatório) |
| valores | O conjunto de valores de filtro. | int[] |
NumberNotInRangeAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'NumberNotInRange' (obrigatório) |
| valores | O conjunto de valores de filtro. | int[][] |
StringBeginsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringBeginsWith' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringContainsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringContains' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringEndsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringEndsWith' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringIn' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringNotBeginsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringNotBeginsWith' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringNotContainsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringNotContains' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringNotEndsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringNotEndsWith' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringNotInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | 'StringNotIn' (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
RetryPolicy
| Nome | Descrição | Valor |
|---|---|---|
| eventTimeToLiveInMinutes | Vida Útil (em minutos) para eventos. | INT |
| maxDeliveryAttempts | Número máximo de tentativas de repetição de entrega para eventos. | INT |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
| Criar Grade de Eventos do Azure tópico e assinatura personalizados |
Cria um tópico personalizado Grade de Eventos do Azure e uma assinatura de webhook. Modelo originalmente criado por John Downs. |
| Tópico/assinatura de Grade de Eventos do Azure personalizado com CloudEvents |
Cria um tópico de Grade de Eventos do Azure personalizado, uma assinatura de webhook com esquema CloudEvents e um Aplicativo Lógico como um manipulador de eventos. Modelo originalmente criado por Justin Yoo. |
| Criar um manipulador de hub de eventos e tópico personalizado da Grade de Eventos |
Cria um tópico personalizado Grade de Eventos do Azure e um hub de eventos para lidar com os eventos. |
| Criar assinatura da Grade de Eventos para eventos de recurso |
Cria uma assinatura da Grade de Eventos para o grupo de recursos ou a assinatura do Azure. |
| Criar Grade de Eventos do Azure assinatura de fila e tópico personalizado |
Cria um tópico personalizado Grade de Eventos do Azure e uma assinatura de fila do barramento de serviço. Modelo originalmente criado por Markus Meyer. |
| Criar Grade de Eventos do Azure assinatura de tópico personalizado |
Cria um tópico personalizado Grade de Eventos do Azure e uma assinatura de tópico do barramento de serviço. Modelo originalmente criado por Markus Meyer. |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso eventSubscriptions é um recurso de extensão, o que significa que você pode aplicá-lo a outro recurso.
Use a parent_id propriedade nesse recurso para definir o escopo desse recurso.
O tipo de recurso eventSubscriptions pode ser implantado com operações direcionadas:
- Grupos de recursos
- Assinaturas
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o Terraform a seguir ao modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/eventSubscriptions@2023-12-15-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
deadLetterWithResourceIdentity = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
deliveryWithResourceIdentity = {
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
eventDeliverySchema = "string"
expirationTimeUtc = "string"
filter = {
advancedFilters = [
{
key = "string"
operatorType = "string"
// For remaining properties, see AdvancedFilter objects
}
]
enableAdvancedFilteringOnArrays = bool
includedEventTypes = [
"string"
]
isSubjectCaseSensitive = bool
subjectBeginsWith = "string"
subjectEndsWith = "string"
}
labels = [
"string"
]
retryPolicy = {
eventTimeToLiveInMinutes = int
maxDeliveryAttempts = int
}
}
})
}
Objetos DeadLetterDestination
Defina a propriedade endpointType para especificar o tipo de objeto.
Para StorageBlob, use:
endpointType = "StorageBlob"
properties = {
blobContainerName = "string"
resourceId = "string"
}
Objetos EventSubscriptionDestination
Defina a propriedade endpointType para especificar o tipo de objeto.
Para AzureFunction, use:
endpointType = "AzureFunction"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
maxEventsPerBatch = int
preferredBatchSizeInKilobytes = int
resourceId = "string"
}
Para o EventHub, use:
endpointType = "EventHub"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
Para HybridConnection, use:
endpointType = "HybridConnection"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
Para MonitorAlert, use:
endpointType = "MonitorAlert"
properties = {
actionGroups = [
"string"
]
description = "string"
severity = "string"
}
Para NamespaceTopic, use:
endpointType = "NamespaceTopic"
properties = {
resourceId = "string"
}
Para PartnerDestination, use:
endpointType = "PartnerDestination"
properties = {
resourceId = "string"
}
Para ServiceBusQueue, use:
endpointType = "ServiceBusQueue"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
Para ServiceBusTopic, use:
endpointType = "ServiceBusTopic"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
Para StorageQueue, use:
endpointType = "StorageQueue"
properties = {
queueMessageTimeToLiveInSeconds = int
queueName = "string"
resourceId = "string"
}
Para WebHook, use:
endpointType = "WebHook"
properties = {
azureActiveDirectoryApplicationIdOrUri = "string"
azureActiveDirectoryTenantId = "string"
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
endpointUrl = "string"
maxEventsPerBatch = int
minimumTlsVersionAllowed = "string"
preferredBatchSizeInKilobytes = int
}
Objetos DeliveryAttributeMapping
Defina a propriedade type para especificar o tipo de objeto.
Para Dinâmico, use:
type = "Dynamic"
properties = {
sourceField = "string"
}
Para Estático, use:
type = "Static"
properties = {
isSecret = bool
value = "string"
}
Objetos AdvancedFilter
Defina a propriedade operatorType para especificar o tipo de objeto.
Para BoolEquals, use:
operatorType = "BoolEquals"
value = bool
Para IsNotNull, use:
operatorType = "IsNotNull"
Para IsNullOrUndefined, use:
operatorType = "IsNullOrUndefined"
Para NumberGreaterThan, use:
operatorType = "NumberGreaterThan"
value = int
Para NumberGreaterThanOrEquals, use:
operatorType = "NumberGreaterThanOrEquals"
value = int
Para NumberIn, use:
operatorType = "NumberIn"
values = [
int
]
Para NumberInRange, use:
operatorType = "NumberInRange"
values = [
[
int
]
]
Para NumberLessThan, use:
operatorType = "NumberLessThan"
value = int
Para NumberLessThanOrEquals, use:
operatorType = "NumberLessThanOrEquals"
value = int
Para NumberNotIn, use:
operatorType = "NumberNotIn"
values = [
int
]
Para NumberNotInRange, use:
operatorType = "NumberNotInRange"
values = [
[
int
]
]
Para StringBeginsWith, use:
operatorType = "StringBeginsWith"
values = [
"string"
]
Para StringContains, use:
operatorType = "StringContains"
values = [
"string"
]
Para StringEndsWith, use:
operatorType = "StringEndsWith"
values = [
"string"
]
Para StringIn, use:
operatorType = "StringIn"
values = [
"string"
]
Para StringNotBeginsWith, use:
operatorType = "StringNotBeginsWith"
values = [
"string"
]
Para StringNotContains, use:
operatorType = "StringNotContains"
values = [
"string"
]
Para StringNotEndsWith, use:
operatorType = "StringNotEndsWith"
values = [
"string"
]
Para StringNotIn, use:
operatorType = "StringNotIn"
values = [
"string"
]
Valores de propriedade
eventSubscriptions
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.EventGrid/eventSubscriptions@2023-12-15-preview" |
| name | O nome do recurso | cadeia de caracteres (obrigatório) Limite de caracteres: 3-64 Caracteres válidos: Caracteres alfanuméricos e hifens. |
| parent_id | A ID do recurso ao qual aplicar esse recurso de extensão. | cadeia de caracteres (obrigatório) |
| properties | Propriedades da assinatura do evento. | EventSubscriptionProperties |
EventSubscriptionProperties
| Nome | Descrição | Valor |
|---|---|---|
| deadLetterDestination | O destino de mensagens mortas da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino de mensagens mortas. Usa a identidade do Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas. |
DeadLetterDestination |
| deadLetterWithResourceIdentity | O destino de mensagens mortas da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino de mensagens mortas. 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/mensagens mortas. |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | Informações sobre o destino em que 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/mensagens mortas. |
DeliveryWithResourceIdentity |
| destino | Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. Usa a identidade do Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas. |
EventSubscriptionDestination |
| eventDeliverySchema | O esquema de entrega de eventos para a assinatura do evento. | "CloudEventSchemaV1_0" "CustomInputSchema" "EventGridSchema" |
| expirationTimeUtc | Hora de expiração da assinatura do evento. | string |
| filter | Informações sobre o filtro para a assinatura do evento. | EventSubscriptionFilter |
| rótulos | Lista de rótulos definidos pelo usuário. | string[] |
| 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 tempo de vida para eventos. | RetryPolicy |
DeadLetterDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Definir o tipo de objeto | StorageBlob (obrigatório) |
StorageBlobDeadLetterDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino de mensagens mortas | "StorageBlob" (obrigatório) |
| properties | As propriedades do destino deadletter baseado em Blob de Armazenamento | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| blobContainerName | O nome do contêiner de blob de armazenamento que é o destino dos eventos deadletter | string |
| resourceId | A ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos deadletter | string |
DeadLetterWithResourceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| deadLetterDestination | Informações sobre o destino em que 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/mensagens mortas. |
DeadLetterDestination |
| identidade | A identidade a ser usada quando eventos de mensagens mortas. | EventSubscriptionIdentity |
EventSubscriptionIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de identidade gerenciada usada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade. | "SystemAssigned" "UserAssigned" |
| userAssignedIdentity | A identidade do usuário associada ao recurso. | string |
DeliveryWithResourceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| destino | Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. Usa a identidade do Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas. |
EventSubscriptionDestination |
| identidade | A identidade a ser usada ao fornecer eventos. | EventSubscriptionIdentity |
EventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Definir o tipo de objeto | AzureFunction EventHub HybridConnection MonitorAlert NamespaceTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook (obrigatório) |
AzureFunctionEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | "AzureFunction" (obrigatório) |
| properties | Propriedades da Função do Azure do destino da assinatura de evento. | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| maxEventsPerBatch | Número máximo de eventos por lote. | INT |
| preferredBatchSizeInKilobytes | Tamanho de lote preferencial em Kilobytes. | INT |
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento. | string |
DeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| name | Nome do atributo ou cabeçalho de entrega. | string |
| type | Definir o tipo de objeto | Dinâmico Estático (obrigatório) |
DynamicDeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo do atributo de entrega ou do nome do cabeçalho. | "Dinâmico" (obrigatório) |
| properties | Propriedades do mapeamento de atributo de entrega dinâmica. | DynamicDeliveryAttributeMappingProperties |
DynamicDeliveryAttributeMappingProperties
| Nome | Descrição | Valor |
|---|---|---|
| sourceField | Caminho JSON no evento que contém o valor do atributo. | string |
StaticDeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo do atributo de entrega ou do nome do cabeçalho. | "Estático" (obrigatório) |
| properties | Propriedades do mapeamento de atributo de entrega estático. | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
| Nome | Descrição | Valor |
|---|---|---|
| isSecret | Sinalizador booliano para saber se o atributo contém informações confidenciais. | bool |
| value | Valor do atributo de entrega. | string |
EventHubEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | "EventHub" (obrigatório) |
| properties | Propriedades do Hub de Eventos do destino da assinatura de evento. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento. | string |
HybridConnectionEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | "HybridConnection" (obrigatório) |
| properties | Propriedades de conexão híbrida do destino da assinatura do evento. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | A ID de Recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento. | string |
MonitorAlertEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | "MonitorAlert" (obrigatório) |
| properties | Monitore as propriedades de alerta do destino da assinatura do evento. | MonitorAlertEventSubscriptionDestinationProperties |
MonitorAlertEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| actionGroups | A lista de IDs do ARM de Grupos de Ações que serão disparadas em todos os alertas disparados por meio dessa assinatura de evento. Cada ID do ARM de recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}. |
string[] |
| descrição | A descrição que será anexada a cada alerta disparado por meio dessa assinatura de evento. | string |
| severidade | A gravidade que será anexada a cada alerta disparado por meio dessa assinatura de evento. Esse campo deve ser fornecido. |
"Sev0" "Sev1" "Sev2" "Sev3" "Sev4" |
NamespaceTopicEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | "NamespaceTopic" (obrigatório) |
| properties | Propriedades do Tópico do namespace do destino da assinatura do evento. | NamespaceTopicEventSubscriptionDestinationProperties |
NamespaceTopicEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | A ID do recurso do Azure que representa o ponto de extremidade do destino do Tópico do Namespace da Grade de Eventos de uma assinatura de evento. Esse campo é necessário e o recurso Tópico do Namespace listado já deve existir. A ID do ARM do recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}. |
string |
PartnerEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | "PartnerDestination" (obrigatório) |
| properties | Propriedades de Destino do Parceiro do destino da assinatura do evento. | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade de um destino de parceiro de uma assinatura de evento. | string |
ServiceBusQueueEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | "ServiceBusQueue" (obrigatório) |
| properties | Propriedades do Barramento de Serviço do destino da assinatura do evento. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade do destino do Barramento de Serviço de uma assinatura de evento. | string |
ServiceBusTopicEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | "ServiceBusTopic" (obrigatório) |
| properties | Propriedades do Tópico do Barramento de Serviço do destino da assinatura do evento. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade do destino tópico do Barramento de Serviço de uma assinatura de evento. | string |
StorageQueueEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | "StorageQueue" (obrigatório) |
| properties | Propriedades da Fila de Armazenamento do destino da assinatura do evento. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| queueMessageTimeToLiveInSeconds | Tempo de vida da mensagem da fila de armazenamento em segundos. Esse valor não pode ser zero ou negativo, com exceção de usar -1 para indicar que a vida útil da mensagem é Infinita. | INT |
| queueName | O nome da fila de armazenamento em uma conta de armazenamento que é o destino de uma assinatura de evento. | string |
| resourceId | A ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma assinatura de evento. | string |
WebHookEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura de evento. | "WebHook" (obrigatório) |
| properties | Propriedades do WebHook do destino da assinatura de evento. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | A ID ou o URI do Aplicativo do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. | string |
| azureActiveDirectoryTenantId | A ID do locatário do Azure Active Directory para obter o token de acesso que será incluído como o token de portador em solicitações de entrega. | string |
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| endpointUrl | A URL que representa o ponto de extremidade do destino de uma assinatura de evento. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| maxEventsPerBatch | Número máximo de eventos por lote. | INT |
| minimumTlsVersionAllowed | Versão mínima do TLS que deve ser compatível com o ponto de extremidade do webhook | "1.0" "1.1" "1.2" |
| preferredBatchSizeInKilobytes | Tamanho de lote preferencial em Kilobytes. | INT |
EventSubscriptionFilter
| Nome | Descrição | Valor |
|---|---|---|
| Advancedfilters | Uma matriz de filtros avançados que são usados para filtrar assinaturas de evento. | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular. | bool |
| includedEventTypes | Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento padrão, defina IncludedEventTypes como nulo. | string[] |
| isSubjectCaseSensitive | Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de maneira sensível a maiúsculas e minúsculas. |
bool |
| subjectBeginsWith | Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato disso depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho. |
string |
| subjectEndsWith | Uma cadeia de caracteres opcional para filtrar eventos de uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho. |
string |
Advancedfilter
| Nome | Descrição | Valor |
|---|---|---|
| chave | O campo/propriedade no evento com base no qual você deseja filtrar. | string |
| operatorType | Definir o tipo de objeto | BoolEquals Isnotnull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (obrigatório) |
BoolEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "BoolEquals" (obrigatório) |
| value | O valor do filtro booliano. | bool |
IsNotNullAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "IsNotNull" (obrigatório) |
IsNullOrUndefinedAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "IsNullOrUndefined" (obrigatório) |
NumberGreaterThanAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberGreaterThan" (obrigatório) |
| value | O valor do filtro. | INT |
NumberGreaterThanOrEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberGreaterThanOrEquals" (obrigatório) |
| value | O valor do filtro. | INT |
NumberInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberIn" (obrigatório) |
| valores | O conjunto de valores de filtro. | int[] |
NumberInRangeAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberInRange" (obrigatório) |
| valores | O conjunto de valores de filtro. | int[][] |
NumberLessThanAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberLessThan" (obrigatório) |
| value | O valor do filtro. | INT |
NumberLessThanOrEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberLessThanOrEquals" (obrigatório) |
| value | O valor do filtro. | INT |
NumberNotInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberNotIn" (obrigatório) |
| valores | O conjunto de valores de filtro. | int[] |
NumberNotInRangeAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberNotInRange" (obrigatório) |
| valores | O conjunto de valores de filtro. | int[][] |
StringBeginsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringBeginsWith" (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringContainsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringContains" (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringEndsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringEndsWith" (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringIn" (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringNotBeginsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotBeginsWith" (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringNotContainsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotContains" (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringNotEndsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotEndsWith" (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
StringNotInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotIn" (obrigatório) |
| valores | O conjunto de valores de filtro. | string[] |
RetryPolicy
| Nome | Descrição | Valor |
|---|---|---|
| eventTimeToLiveInMinutes | Vida útil (em minutos) para eventos. | INT |
| maxDeliveryAttempts | Número máximo de tentativas de repetição de entrega para eventos. | INT |