Eventos Microsoft.EventGridSubscriptions
- Mais recente
- 2023-12-15-preview
- 06-06-01-preview de 2023
- 2022-06-15
- 2021-12-01
- 2021-10-15-preview
- 06-01-pré-visualização de 2021
- 2020-10-15-preview
- 2020-06-01
- 2020-04-01-preview
- 01-01-pré-visualização de 2020
- 2019-06-01
- 2019-02-01-preview
- 2019-01-01
- 2018-09-15-preview
- 05-05-01-preview de 2018
- 2018-01-01
- 2017-09-15-preview
- 06-15-preview de 2017
Definição de recurso do Bicep
O tipo de recurso eventSubscriptions é um recurso de extensão, o que significa que pode aplicá-lo a outro recurso.
Utilize a scope propriedade neste recurso para definir o âmbito deste recurso. Veja Definir âmbito nos recursos de extensão no Bicep.
O tipo de recurso eventSubscriptions pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
- Subscrições - Veja os comandos de implementação da subscrição
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o seguinte Bicep ao seu 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, utilize:
endpointType: 'StorageBlob'
properties: {
blobContainerName: 'string'
resourceId: 'string'
}
Objetos EventSubscriptionDestination
Defina a propriedade endpointType para especificar o tipo de objeto.
Para AzureFunction, utilize:
endpointType: 'AzureFunction'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
maxEventsPerBatch: int
preferredBatchSizeInKilobytes: int
resourceId: 'string'
}
Para o EventHub, utilize:
endpointType: 'EventHub'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
Para HybridConnection, utilize:
endpointType: 'HybridConnection'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
Para MonitorAlert, utilize:
endpointType: 'MonitorAlert'
properties: {
actionGroups: [
'string'
]
description: 'string'
severity: 'string'
}
Para NamespaceTopic, utilize:
endpointType: 'NamespaceTopic'
properties: {
resourceId: 'string'
}
Para PartnerDestination, utilize:
endpointType: 'PartnerDestination'
properties: {
resourceId: 'string'
}
Para ServiceBusQueue, utilize:
endpointType: 'ServiceBusQueue'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
Para ServiceBusTopic, utilize:
endpointType: 'ServiceBusTopic'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
Para StorageQueue, utilize:
endpointType: 'StorageQueue'
properties: {
queueMessageTimeToLiveInSeconds: int
queueName: 'string'
resourceId: 'string'
}
Para WebHook, utilize:
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
}
DeliveryAttributeMapping objects (Objetos DeliveryAttributeMapping)
Defina a propriedade tipo para especificar o tipo de objeto.
Para Dinâmico, utilize:
type: 'Dynamic'
properties: {
sourceField: 'string'
}
Para Estático, utilize:
type: 'Static'
properties: {
isSecret: bool
value: 'string'
}
Objetos AdvancedFilter
Defina a propriedade operatorType para especificar o tipo de objeto.
Para BoolEquals, utilize:
operatorType: 'BoolEquals'
value: bool
Para IsNotNull, utilize:
operatorType: 'IsNotNull'
Para IsNullOrUndefined, utilize:
operatorType: 'IsNullOrUndefined'
Para NumberGreaterThan, utilize:
operatorType: 'NumberGreaterThan'
value: int
Para NumberGreaterThanOrEquals, utilize:
operatorType: 'NumberGreaterThanOrEquals'
value: int
Para NumberIn, utilize:
operatorType: 'NumberIn'
values: [
int
]
Para NumberInRange, utilize:
operatorType: 'NumberInRange'
values: [
[
int
]
]
Para NumberLessThan, utilize:
operatorType: 'NumberLessThan'
value: int
Para NumberLessThanOrEquals, utilize:
operatorType: 'NumberLessThanOrEquals'
value: int
Para NumberNotIn, utilize:
operatorType: 'NumberNotIn'
values: [
int
]
Para NumberNotInRange, utilize:
operatorType: 'NumberNotInRange'
values: [
[
int
]
]
Para StringBeginsWith, utilize:
operatorType: 'StringBeginsWith'
values: [
'string'
]
Para StringContains, utilize:
operatorType: 'StringContains'
values: [
'string'
]
Para StringEndsWith, utilize:
operatorType: 'StringEndsWith'
values: [
'string'
]
Para StringIn, utilize:
operatorType: 'StringIn'
values: [
'string'
]
Para StringNotBeginsWith, utilize:
operatorType: 'StringNotBeginsWith'
values: [
'string'
]
Para StringNotContains, utilize:
operatorType: 'StringNotContains'
values: [
'string'
]
Para StringNotEndsWith, utilize:
operatorType: 'StringNotEndsWith'
values: [
'string'
]
Para StringNotIn, utilize:
operatorType: 'StringNotIn'
values: [
'string'
]
Valores de propriedade
eventSubscriptions
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 3-64 Carateres válidos: Alfanuméricos e hífenes. |
| scope | Utilize ao criar um recurso de extensão num âmbito diferente do âmbito de implementação. | Recurso de destino Para Bicep, defina esta propriedade como o nome simbólico do recurso para aplicar o recurso de extensão. |
| propriedades | Propriedades da subscrição do evento. | EventSubscriptionProperties |
EventSubscriptionProperties
| Nome | Descrição | Valor |
|---|---|---|
| deadLetterDestination | O destino da letra não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do respetivo destino é enviado para o destino da letra não entregue. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/sem letras. |
DeadLetterDestination |
| deadLetterWithResourceIdentity | O destino da letra não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do respetivo destino é enviado para o destino da letra não entregue. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/letra não entregue. |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/letra não entregue. |
DeliveryWithResourceIdentity |
| destino | Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/sem letras. |
EventSubscriptionDestination |
| eventDeliverySchema | O esquema de entrega de eventos para a subscrição do evento. | 'CloudEventSchemaV1_0' "CustomInputSchema" 'EventGridSchema' |
| expirationTimeUtc | Tempo de expiração da subscrição do evento. | string |
| filter | Informações sobre o filtro da subscrição do evento. | EventSubscriptionFilter |
| etiquetas | Lista de etiquetas definidas pelo utilizador. | cadeia[] |
| retryPolicy | A política de repetição para eventos. Isto pode ser utilizado para configurar o número máximo de tentativas de entrega e tempo de transmissão em direto para eventos. | RetryPolicy |
DeadLetterDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Definir o tipo de objeto | StorageBlob (obrigatório) |
StorageBlobDeadLetterDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo de ponto final para o destino da letra não entregue | "StorageBlob" (obrigatório) |
| propriedades | As propriedades do destino deadletter baseado em Blobs de Armazenamento | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| blobContainerName | O nome do contentor de blobs de armazenamento que é o destino dos eventos deadletter | string |
| resourceId | O 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 onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/letra não entregue. |
DeadLetterDestination |
| identidade | A identidade a utilizar quando são apresentados eventos de letra não entregue. | EventSubscriptionIdentity |
EventSubscriptionIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade. | "SystemAssigned" "UserAssigned" |
| userAssignedIdentity | A identidade de utilizador associada ao recurso. | string |
DeliveryWithResourceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| destino | Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/sem letras. |
EventSubscriptionDestination |
| identidade | A identidade a utilizar ao entregar eventos. | EventSubscriptionIdentity |
EventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Definir o tipo de objeto | AzureFunction EventHub Ligação Híbrida MonitorAlert NamespaceTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook (obrigatório) |
AzureFunctionEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "AzureFunction" (obrigatório) |
| propriedades | Propriedades da Função do Azure do destino da subscrição de eventos. | 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 preferencial do lote em Kilobytes. | int |
| resourceId | O ID de Recurso do Azure que representa o ponto final do destino da Função do Azure de uma subscrição de evento. | string |
DeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| name | Nome do atributo ou cabeçalho de entrega. | string |
| tipo | Definir o tipo de objeto | Dinâmico Estático (obrigatório) |
DynamicDeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo do atributo de entrega ou nome do cabeçalho. | "Dinâmico" (obrigatório) |
| propriedades | Propriedades do mapeamento de atributos 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 nome do cabeçalho. | "Estático" (obrigatório) |
| propriedades | Propriedades do mapeamento de atributos de entrega estática. | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
| Nome | Descrição | Valor |
|---|---|---|
| isSecret | Sinalizador booleano para saber se o atributo contém informações confidenciais. | bool |
| valor | Valor do atributo de entrega. | string |
EventHubEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "EventHub" (obrigatório) |
| propriedades | Propriedades do Hub de Eventos do destino da subscrição de eventos. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | O ID de Recurso do Azure que representa o ponto final de um destino do Hub de Eventos de uma subscrição de evento. | string |
HybridConnectionEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "HybridConnection" (obrigatório) |
| propriedades | Propriedades da ligação híbrida do destino da subscrição de eventos. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | O ID de Recurso do Azure de uma ligação híbrida que é o destino de uma subscrição de evento. | string |
MonitorAlertEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "MonitorAlert" (obrigatório) |
| propriedades | Monitorizar as propriedades de Alerta do destino da subscrição de eventos. | MonitorAlertEventSubscriptionDestinationProperties |
MonitorAlertEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| actionGroups | A lista de IDs do ARM dos Grupos de Ações que serão acionados em todos os Alertas acionados através desta subscrição de evento. Cada ID arm de recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}. |
cadeia[] |
| descrição | A descrição que será anexada a todos os Alertas acionados através desta subscrição de evento. | string |
| gravidade | A gravidade que será anexada a todos os Alertas acionados através desta subscrição de evento. Este campo tem de ser fornecido. |
'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4' |
NamespaceTopicEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "NamespaceTopic" (obrigatório) |
| propriedades | Propriedades do Tópico do Espaço de Nomes do destino da subscrição de eventos. | NamespaceTopicEventSubscriptionDestinationProperties |
NamespaceTopicEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | O ID de recurso do Azure que representa o ponto final do destino do Tópico do Espaço de Nomes do Event Grid de uma subscrição de evento. Este campo é necessário e o recurso tópico espaço de nomes listado já tem de existir. O ID arm do recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}. |
string |
PartnerEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "PartnerDestination" (obrigatório) |
| propriedades | Propriedades de Destino do Parceiro do destino da subscrição de eventos. | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | O ID de Recurso do Azure que representa o ponto final de um Destino de Parceiro de uma subscrição de evento. | string |
ServiceBusQueueEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "ServiceBusQueue" (obrigatório) |
| propriedades | Propriedades do Service Bus do destino da subscrição de eventos. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | O ID de Recurso do Azure que representa o ponto final do destino do Service Bus de uma subscrição de evento. | string |
ServiceBusTopicEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "ServiceBusTopic" (obrigatório) |
| propriedades | Propriedades do Tópico do Service Bus do destino da subscrição de eventos. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | O ID de Recurso do Azure que representa o ponto final do destino do Tópico do Service Bus de uma subscrição de evento. | string |
StorageQueueEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "StorageQueue" (obrigatório) |
| propriedades | Propriedades da Fila de Armazenamento do destino da subscrição de eventos. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| queueMessageTimeToLiveInSeconds | Tempo de espera da fila de armazenamento para viver em segundos. Este valor não pode ser zero ou negativo, com exceção da utilização de -1 para indicar que o Time To Live da mensagem é Infinito. | int |
| queueName | O nome da fila de Armazenamento numa conta de armazenamento que é o destino de uma subscrição de evento. | string |
| resourceId | O ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma subscrição de evento. | string |
WebHookEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "WebHook" (obrigatório) |
| propriedades | Propriedades do WebHook do destino da subscrição de eventos. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | O ID ou o URI da Aplicação do Azure Active Directory para obter o token de acesso que será incluído como token de portador nos pedidos de entrega. | string |
| azureActiveDirectoryTenantId | O ID de Inquilino do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nos pedidos de entrega. | string |
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| endpointUrl | O URL que representa o ponto final do destino de uma subscrição de evento. | string Restrições: Valor sensível. Transmita 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 suportada pelo ponto final do webhook | '1.0' '1.1' '1.2' |
| preferredBatchSizeInKilobytes | Tamanho preferencial do lote em Kilobytes. | int |
EventSubscriptionFilter
| Nome | Descrição | Valor |
|---|---|---|
| advancedFilters | Uma matriz de filtros avançados que são utilizados para filtrar subscrições de eventos. | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | Permite que os filtros avançados sejam avaliados relativamente a uma matriz de valores em vez de esperar um valor singular. | bool |
| includedEventTypes | Uma lista dos tipos de evento aplicáveis que têm de fazer parte da subscrição do evento. Se pretender subscrever todos os tipos de eventos predefinidos, defina IncludedEventTypes como nulo. | string[] |
| isSubjectCaseSensitive | Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de forma sensível a maiúsculas e minúsculas. |
bool |
| subjectBeginsWith | Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num prefixo de caminho de recurso. O formato depende do publicador dos eventos. Os carateres universais não são suportados neste caminho. |
string |
| subjectEndsWith | Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num sufixo de caminho de recurso. Os carateres universais não são suportados neste caminho. |
string |
AdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| chave | O campo/propriedade no evento com base no qual pretende filtrar. | string |
| operatorType | Definir o tipo de objeto | BoolEquals IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NúmNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (obrigatório) |
BoolEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "BoolEquals" (obrigatório) |
| valor | O valor do filtro booleano. | bool |
IsNotNullAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "IsNotNull" (obrigatório) |
IsNullOrUndefinedAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "IsNullOrUndefined" (obrigatório) |
NumberGreaterThanAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberGreaterThan" (obrigatório) |
| valor | O valor do filtro. | int |
NumberGreaterThanOrEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberGreaterThanOrEquals" (obrigatório) |
| valor | O valor do filtro. | int |
NumberInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberIn" (obrigatório) |
| values | O conjunto de valores de filtro. | int[] |
NumberInRangeAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberInRange" (obrigatório) |
| values | O conjunto de valores de filtro. | int[][] |
NumberLessThanAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberLessThan" (obrigatório) |
| valor | O valor do filtro. | int |
NumberLessThanOrEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberLessThanOrEquals" (obrigatório) |
| valor | O valor do filtro. | int |
NumberNotInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberNotIn" (obrigatório) |
| values | O conjunto de valores de filtro. | int[] |
NumberNotInRangeAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberNotInRange" (obrigatório) |
| values | O conjunto de valores de filtro. | int[][] |
StringBeginsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringBeginsWith" (obrigatório) |
| values | O conjunto de valores de filtro. | cadeia[] |
StringContainsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringContains" (obrigatório) |
| values | O conjunto de valores de filtro. | cadeia[] |
StringEndsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringEndsWith" (obrigatório) |
| values | O conjunto de valores de filtro. | cadeia[] |
StringInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringIn" (obrigatório) |
| values | O conjunto de valores de filtro. | cadeia[] |
StringNotBeginsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotBeginsWith" (obrigatório) |
| values | O conjunto de valores de filtro. | string[] |
StringNotContainsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotContains" (obrigatório) |
| values | O conjunto de valores de filtro. | string[] |
StringNotEndsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotEndsWith" (obrigatório) |
| values | O conjunto de valores de filtro. | string[] |
StringNotInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotIn" (obrigatório) |
| values | O conjunto de valores de filtro. | string[] |
RetryPolicy
| Nome | Descrição | Valor |
|---|---|---|
| eventTimeToLiveInMinutes | Time To Live (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 seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
Criar Azure Event Grid Tópico e Subscrição Personalizados |
Cria um tópico personalizado Azure Event Grid e uma subscrição de webhook. Modelo originalmente criado por John Downs. |
| Tópico/Subscrição de Azure Event Grid Personalizado com o CloudEvents |
Cria um tópico de Azure Event Grid personalizado, uma subscrição de webhook com esquema CloudEvents e uma Aplicação Lógica como processador de eventos. Modelo originalmente criado por Justin Yoo. |
| Criar tópico personalizado do Event Grid e processador do hub de eventos |
Cria uma Azure Event Grid tópico personalizado e um hub de eventos para processar os eventos. |
| Criar uma subscrição do Event Grid para eventos de recursos |
Cria uma subscrição do Event Grid para um grupo de recursos ou uma subscrição do Azure. |
| Criar Azure Event Grid Tópico Personalizado e Subscrição de Fila |
Cria um tópico personalizado Azure Event Grid e uma subscrição de fila do service bus. Modelo originalmente criado por Markus Meyer. |
| Criar Azure Event Grid Subscrição de Tópico Personalizado |
Cria um tópico personalizado Azure Event Grid e uma subscrição de tópico do service bus. Modelo originalmente criado por Markus Meyer. |
Definição de recurso do modelo arm
O tipo de recurso eventSubscriptions é um recurso de extensão, o que significa que pode aplicá-lo a outro recurso.
Utilize a scope propriedade neste recurso para definir o âmbito deste recurso. Veja Definir âmbito nos recursos de extensão nos modelos do ARM.
O tipo de recurso eventSubscriptions pode ser implementado com operações que visam:
- Grupos de recursos – veja os comandos de implementação do grupo de recursos
- Subscrições – veja os comandos de implementação da subscrição
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o seguinte JSON ao seu 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, utilize:
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "string",
"resourceId": "string"
}
Objetos EventSubscriptionDestination
Defina a propriedade endpointType para especificar o tipo de objeto.
Para AzureFunction, utilize:
"endpointType": "AzureFunction",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"maxEventsPerBatch": "int",
"preferredBatchSizeInKilobytes": "int",
"resourceId": "string"
}
Para o EventHub, utilize:
"endpointType": "EventHub",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"resourceId": "string"
}
Para HybridConnection, utilize:
"endpointType": "HybridConnection",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"resourceId": "string"
}
Para MonitorAlert, utilize:
"endpointType": "MonitorAlert",
"properties": {
"actionGroups": [ "string" ],
"description": "string",
"severity": "string"
}
Para NamespaceTopic, utilize:
"endpointType": "NamespaceTopic",
"properties": {
"resourceId": "string"
}
Para PartnerDestination, utilize:
"endpointType": "PartnerDestination",
"properties": {
"resourceId": "string"
}
Para ServiceBusQueue, utilize:
"endpointType": "ServiceBusQueue",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"resourceId": "string"
}
Para ServiceBusTopic, utilize:
"endpointType": "ServiceBusTopic",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"resourceId": "string"
}
Para StorageQueue, utilize:
"endpointType": "StorageQueue",
"properties": {
"queueMessageTimeToLiveInSeconds": "int",
"queueName": "string",
"resourceId": "string"
}
Para o WebHook, utilize:
"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, utilize:
"type": "Dynamic",
"properties": {
"sourceField": "string"
}
Para Estático, utilize:
"type": "Static",
"properties": {
"isSecret": "bool",
"value": "string"
}
Objetos AdvancedFilter
Defina a propriedade operatorType para especificar o tipo de objeto.
Para BoolEquals, utilize:
"operatorType": "BoolEquals",
"value": "bool"
Para IsNotNull, utilize:
"operatorType": "IsNotNull"
Para IsNullOrUndefined, utilize:
"operatorType": "IsNullOrUndefined"
Para NumberGreaterThan, utilize:
"operatorType": "NumberGreaterThan",
"value": "int"
Para NumberGreaterThanOrEquals, utilize:
"operatorType": "NumberGreaterThanOrEquals",
"value": "int"
Para NumberIn, utilize:
"operatorType": "NumberIn",
"values": [ "int" ]
Para NumberInRange, utilize:
"operatorType": "NumberInRange",
"values": [ [ "int" ] ]
Para NumberLessThan, utilize:
"operatorType": "NumberLessThan",
"value": "int"
Para NumberLessThanOrEquals, utilize:
"operatorType": "NumberLessThanOrEquals",
"value": "int"
Para NumberNotIn, utilize:
"operatorType": "NumberNotIn",
"values": [ "int" ]
Para NumberNotInRange, utilize:
"operatorType": "NumberNotInRange",
"values": [ [ "int" ] ]
Para StringBeginsWith, utilize:
"operatorType": "StringBeginsWith",
"values": [ "string" ]
Para StringContains, utilize:
"operatorType": "StringContains",
"values": [ "string" ]
Para StringEndsWith, utilize:
"operatorType": "StringEndsWith",
"values": [ "string" ]
Para StringIn, utilize:
"operatorType": "StringIn",
"values": [ "string" ]
Para StringNotBeginsWith, utilize:
"operatorType": "StringNotBeginsWith",
"values": [ "string" ]
Para StringNotContains, utilize:
"operatorType": "StringNotContains",
"values": [ "string" ]
Para StringNotEndsWith, utilize:
"operatorType": "StringNotEndsWith",
"values": [ "string" ]
Para StringNotIn, utilize:
"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 de recursos | '2023-12-15-preview' |
| name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 3-64 Carateres válidos: Alfanuméricos e hífenes. |
| scope | Utilize ao criar um recurso de extensão num âmbito diferente do âmbito de implementação. | Recurso de destino Para JSON, defina o valor como o nome completo do recurso ao qual pretende aplicar o recurso de extensão . |
| propriedades | Propriedades da subscrição do evento. | EventSubscriptionProperties |
EventSubscriptionProperties
| Nome | Descrição | Valor |
|---|---|---|
| deadLetterDestination | O destino da carta não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do mesmo é enviado para o destino da carta não entregue. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues. |
DeadLetterDestination |
| deadLetterWithResourceIdentity | O destino da carta não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do mesmo é enviado para o destino da carta não entregue. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues. |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues. |
DeliveryWithResourceIdentity |
| destino | Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues. |
EventSubscriptionDestination |
| eventDeliverySchema | O esquema de entrega de eventos para a subscrição do evento. | 'CloudEventSchemaV1_0' "CustomInputSchema" "EventGridSchema" |
| expirationTimeUtc | Hora de expiração da subscrição do evento. | string |
| filter | Informações sobre o filtro para a subscrição de eventos. | EventSubscriptionFilter |
| etiquetas | Lista de etiquetas definidas pelo utilizador. | string[] |
| retryPolicy | A política de repetição para eventos. Isto pode ser utilizado para configurar o número máximo de tentativas de entrega e tempo de duração para eventos. | RetryPolicy |
DeadLetterDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Definir o tipo de objeto | StorageBlob (obrigatório) |
StorageBlobDeadLetterDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo de ponto final para o destino da letra não entregue | "StorageBlob" (obrigatório) |
| propriedades | As propriedades do destino deadletter baseado no Blob de Armazenamento | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| blobContainerName | O nome do contentor de blobs de armazenamento que é o destino dos eventos deadletter | string |
| resourceId | O 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 onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/letra não entregue. |
DeadLetterDestination |
| identidade | A identidade a utilizar quando são apresentados eventos de letra não entregue. | EventSubscriptionIdentity |
EventSubscriptionIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade. | "SystemAssigned" "UserAssigned" |
| userAssignedIdentity | A identidade de utilizador associada ao recurso. | string |
DeliveryWithResourceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| destino | Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/sem letras. |
EventSubscriptionDestination |
| identidade | A identidade a utilizar ao entregar eventos. | EventSubscriptionIdentity |
EventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Definir o tipo de objeto | AzureFunction EventHub Ligação Híbrida MonitorAlert NamespaceTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook (obrigatório) |
AzureFunctionEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "AzureFunction" (obrigatório) |
| propriedades | Propriedades da Função do Azure do destino da subscrição de eventos. | 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 preferencial do lote em Kilobytes. | int |
| resourceId | O ID de Recurso do Azure que representa o ponto final do destino da Função do Azure de uma subscrição de evento. | string |
DeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| name | Nome do atributo ou cabeçalho de entrega. | string |
| tipo | Definir o tipo de objeto | Dinâmico Estático (obrigatório) |
DynamicDeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de atributo de entrega ou nome de cabeçalho. | "Dinâmico" (obrigatório) |
| propriedades | Propriedades do mapeamento de atributos 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 de atributo de entrega ou nome de cabeçalho. | "Estático" (obrigatório) |
| propriedades | Propriedades do mapeamento de atributos de entrega estática. | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
| Nome | Descrição | Valor |
|---|---|---|
| isSecret | Sinalizador booleano para saber se o atributo contém informações confidenciais. | bool |
| valor | Valor do atributo de entrega. | string |
EventHubEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo de ponto final para o destino da subscrição de eventos. | "EventHub" (obrigatório) |
| propriedades | Propriedades do Hub de Eventos do destino da subscrição de eventos. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | O ID de Recurso do Azure que representa o ponto final de um destino do Hub de Eventos de uma subscrição de evento. | string |
HybridConnectionEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo de ponto final para o destino da subscrição de eventos. | "HybridConnection" (obrigatório) |
| propriedades | Ligação híbrida Propriedades do destino da subscrição de eventos. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | O ID de Recurso do Azure de uma ligação híbrida que é o destino de uma subscrição de evento. | string |
MonitorAlertEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo de ponto final para o destino da subscrição de eventos. | "MonitorAlert" (obrigatório) |
| propriedades | Monitorizar as propriedades do Alerta do destino da subscrição de eventos. | MonitorAlertEventSubscriptionDestinationProperties |
MonitorAlertEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| actionGroups | A lista de IDs arm de Grupos de Ações que serão acionados em cada Alerta acionado através desta subscrição de evento. Cada ID 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 todos os Alertas acionados através desta subscrição de evento. | string |
| gravidade | A gravidade que será anexada a cada Alerta acionado através desta subscrição de evento. Este campo tem de ser fornecido. |
'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4' |
NamespaceTopicEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "NamespaceTopic" (obrigatório) |
| propriedades | Propriedades do Tópico do Espaço de Nomes do destino da subscrição de eventos. | NamespaceTopicEventSubscriptionDestinationProperties |
NamespaceTopicEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | O ID de recurso do Azure que representa o ponto final do destino do Tópico do Espaço de Nomes do Event Grid de uma subscrição de evento. Este campo é necessário e o recurso tópico espaço de nomes listado já tem de existir. O ID arm do recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}. |
string |
PartnerEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "PartnerDestination" (obrigatório) |
| propriedades | Propriedades de Destino do Parceiro do destino da subscrição de eventos. | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | O ID de Recurso do Azure que representa o ponto final de um Destino de Parceiro de uma subscrição de evento. | string |
ServiceBusQueueEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "ServiceBusQueue" (obrigatório) |
| propriedades | Propriedades do Service Bus do destino da subscrição de eventos. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | O ID de Recurso do Azure que representa o ponto final do destino do Service Bus de uma subscrição de evento. | string |
ServiceBusTopicEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "ServiceBusTopic" (obrigatório) |
| propriedades | Propriedades do Tópico do Service Bus do destino da subscrição de eventos. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | O ID de Recurso do Azure que representa o ponto final do destino do Tópico do Service Bus de uma subscrição de evento. | string |
StorageQueueEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "StorageQueue" (obrigatório) |
| propriedades | Propriedades da Fila de Armazenamento do destino da subscrição de eventos. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| queueMessageTimeToLiveInSeconds | Tempo de espera da fila de armazenamento para viver em segundos. Este valor não pode ser zero ou negativo, com exceção da utilização de -1 para indicar que o Time To Live da mensagem é Infinito. | int |
| queueName | O nome da fila de Armazenamento numa conta de armazenamento que é o destino de uma subscrição de evento. | string |
| resourceId | O ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma subscrição de evento. | string |
WebHookEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "WebHook" (obrigatório) |
| propriedades | Propriedades do WebHook do destino da subscrição de eventos. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | O ID ou o URI da Aplicação do Azure Active Directory para obter o token de acesso que será incluído como token de portador nos pedidos de entrega. | string |
| azureActiveDirectoryTenantId | O ID de Inquilino do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nos pedidos de entrega. | string |
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| endpointUrl | O URL que representa o ponto final do destino de uma subscrição de evento. | string Restrições: Valor sensível. Transmita 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 suportada pelo ponto final do webhook | '1.0' '1.1' '1.2' |
| preferredBatchSizeInKilobytes | Tamanho preferencial do lote em Kilobytes. | int |
EventSubscriptionFilter
| Nome | Descrição | Valor |
|---|---|---|
| advancedFilters | Uma matriz de filtros avançados que são utilizados para filtrar subscrições de eventos. | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | Permite que os filtros avançados sejam avaliados relativamente a uma matriz de valores em vez de esperar um valor singular. | bool |
| includedEventTypes | Uma lista dos tipos de evento aplicáveis que têm de fazer parte da subscrição do evento. Se quiser subscrever todos os tipos de eventos predefinidos, defina IncludedEventTypes como nulo. | cadeia[] |
| isSubjectCaseSensitive | Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de forma sensível a maiúsculas e minúsculas. |
bool |
| subjectBeginsWith | Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num prefixo de caminho de recurso. O formato deste procedimento depende do publicador dos eventos. Os carateres universais não são suportados neste caminho. |
string |
| subjectEndsWith | Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num sufixo de caminho de recurso. Os carateres universais não são suportados neste caminho. |
string |
AdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| chave | O campo/propriedade no evento com base no qual pretende 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 utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "BoolEquals" (obrigatório) |
| valor | O valor do filtro booleano. | bool |
IsNotNullAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "IsNotNull" (obrigatório) |
IsNullOrUndefinedAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "IsNullOrUndefined" (obrigatório) |
NumberGreaterThanAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberGreaterThan" (obrigatório) |
| valor | O valor do filtro. | int |
NumberGreaterThanOrEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberGreaterThanOrEquals" (obrigatório) |
| valor | O valor do filtro. | int |
NumberInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberIn" (obrigatório) |
| values | O conjunto de valores de filtro. | int[] |
NumberInRangeAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberInRange" (obrigatório) |
| values | O conjunto de valores de filtro. | int[][] |
NumberLessThanAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberLessThan" (obrigatório) |
| valor | O valor do filtro. | int |
NumberLessThanOrEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberLessThanOrEquals" (obrigatório) |
| valor | O valor do filtro. | int |
NumberNotInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberNotIn" (obrigatório) |
| values | O conjunto de valores de filtro. | int[] |
NumberNotInRangeAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberNotInRange" (obrigatório) |
| values | O conjunto de valores de filtro. | int[][] |
StringBeginsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringBeginsWith" (obrigatório) |
| values | O conjunto de valores de filtro. | string[] |
StringContainsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringContains" (obrigatório) |
| values | O conjunto de valores de filtro. | string[] |
StringEndsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringEndsWith" (obrigatório) |
| values | O conjunto de valores de filtro. | string[] |
StringInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringIn" (obrigatório) |
| values | O conjunto de valores de filtro. | string[] |
StringNotBeginsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotBeginsWith" (obrigatório) |
| values | O conjunto de valores de filtro. | string[] |
StringNotContainsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotContains" (obrigatório) |
| values | O conjunto de valores de filtro. | string[] |
StringNotEndsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotEndsWith" (obrigatório) |
| values | O conjunto de valores de filtro. | string[] |
StringNotInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotIn" (obrigatório) |
| values | O conjunto de valores de filtro. | string[] |
RetryPolicy
| Nome | Descrição | Valor |
|---|---|---|
| eventTimeToLiveInMinutes | Time To Live (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 seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
| Criar Azure Event Grid Tópico e Subscrição Personalizados |
Cria um tópico personalizado Azure Event Grid e uma subscrição de webhook. Modelo originalmente criado por John Downs. |
| Tópico/Subscrição de Azure Event Grid Personalizado com o CloudEvents |
Cria um tópico de Azure Event Grid personalizado, uma subscrição de webhook com esquema CloudEvents e uma Aplicação Lógica como processador de eventos. Modelo originalmente criado por Justin Yoo. |
| Criar tópico personalizado do Event Grid e processador do hub de eventos |
Cria uma Azure Event Grid tópico personalizado e um hub de eventos para processar os eventos. |
| Criar uma subscrição do Event Grid para eventos de recursos |
Cria uma subscrição do Event Grid para um grupo de recursos ou uma subscrição do Azure. |
| Criar Azure Event Grid Tópico Personalizado e Subscrição de Fila |
Cria um tópico personalizado Azure Event Grid e uma subscrição de fila do service bus. Modelo originalmente criado por Markus Meyer. |
| Criar Azure Event Grid Subscrição de Tópico Personalizado |
Cria um tópico personalizado Azure Event Grid e uma subscrição de tópico do service bus. Modelo originalmente criado por Markus Meyer. |
Definição de recurso terraform (fornecedor AzAPI)
O tipo de recurso eventSubscriptions é um recurso de extensão, o que significa que pode aplicá-lo a outro recurso.
Utilize a parent_id propriedade neste recurso para definir o âmbito deste recurso.
O tipo de recurso eventSubscriptions pode ser implementado com operações que visam:
- Grupos de recursos
- Subscrições
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o seguinte Terraform ao seu 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, utilize:
endpointType = "StorageBlob"
properties = {
blobContainerName = "string"
resourceId = "string"
}
Objetos EventSubscriptionDestination
Defina a propriedade endpointType para especificar o tipo de objeto.
Para AzureFunction, utilize:
endpointType = "AzureFunction"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
maxEventsPerBatch = int
preferredBatchSizeInKilobytes = int
resourceId = "string"
}
Para o EventHub, utilize:
endpointType = "EventHub"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
Para HybridConnection, utilize:
endpointType = "HybridConnection"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
Para MonitorAlert, utilize:
endpointType = "MonitorAlert"
properties = {
actionGroups = [
"string"
]
description = "string"
severity = "string"
}
Para NamespaceTopic, utilize:
endpointType = "NamespaceTopic"
properties = {
resourceId = "string"
}
Para PartnerDestination, utilize:
endpointType = "PartnerDestination"
properties = {
resourceId = "string"
}
Para ServiceBusQueue, utilize:
endpointType = "ServiceBusQueue"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
Para ServiceBusTopic, utilize:
endpointType = "ServiceBusTopic"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
Para StorageQueue, utilize:
endpointType = "StorageQueue"
properties = {
queueMessageTimeToLiveInSeconds = int
queueName = "string"
resourceId = "string"
}
Para o WebHook, utilize:
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, utilize:
type = "Dynamic"
properties = {
sourceField = "string"
}
Para Estático, utilize:
type = "Static"
properties = {
isSecret = bool
value = "string"
}
Objetos AdvancedFilter
Defina a propriedade operatorType para especificar o tipo de objeto.
Para BoolEquals, utilize:
operatorType = "BoolEquals"
value = bool
Para IsNotNull, utilize:
operatorType = "IsNotNull"
Para IsNullOrUndefined, utilize:
operatorType = "IsNullOrUndefined"
Para NumberGreaterThan, utilize:
operatorType = "NumberGreaterThan"
value = int
Para NumberGreaterThanOrEquals, utilize:
operatorType = "NumberGreaterThanOrEquals"
value = int
Para NumberIn, utilize:
operatorType = "NumberIn"
values = [
int
]
Para NumberInRange, utilize:
operatorType = "NumberInRange"
values = [
[
int
]
]
Para NumberLessThan, utilize:
operatorType = "NumberLessThan"
value = int
Para NumberLessThanOrEquals, utilize:
operatorType = "NumberLessThanOrEquals"
value = int
Para NumberNotIn, utilize:
operatorType = "NumberNotIn"
values = [
int
]
Para NumberNotInRange, utilize:
operatorType = "NumberNotInRange"
values = [
[
int
]
]
Para StringBeginsWith, utilize:
operatorType = "StringBeginsWith"
values = [
"string"
]
Para StringContains, utilize:
operatorType = "StringContains"
values = [
"string"
]
Para StringEndsWith, utilize:
operatorType = "StringEndsWith"
values = [
"string"
]
Para StringIn, utilize:
operatorType = "StringIn"
values = [
"string"
]
Para StringNotBeginsWith, utilize:
operatorType = "StringNotBeginsWith"
values = [
"string"
]
Para StringNotContains, utilize:
operatorType = "StringNotContains"
values = [
"string"
]
Para StringNotEndsWith, utilize:
operatorType = "StringNotEndsWith"
values = [
"string"
]
Para StringNotIn, utilize:
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 (obrigatório) Limite de carateres: 3-64 Carateres válidos: Alfanuméricos e hífenes. |
| parent_id | O ID do recurso ao quais aplicar este recurso de extensão. | cadeia (obrigatório) |
| propriedades | Propriedades da subscrição do evento. | EventSubscriptionProperties |
EventSubscriptionProperties
| Nome | Descrição | Valor |
|---|---|---|
| deadLetterDestination | O destino da carta não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do mesmo é enviado para o destino da carta não entregue. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues. |
DeadLetterDestination |
| deadLetterWithResourceIdentity | O destino da carta não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do mesmo é enviado para o destino da carta não entregue. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues. |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/letra não entregue. |
DeliveryWithResourceIdentity |
| destino | Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/sem letras. |
EventSubscriptionDestination |
| eventDeliverySchema | O esquema de entrega de eventos para a subscrição do evento. | "CloudEventSchemaV1_0" "CustomInputSchema" "EventGridSchema" |
| expirationTimeUtc | Tempo de expiração da subscrição do evento. | string |
| filter | Informações sobre o filtro da subscrição do evento. | EventSubscriptionFilter |
| etiquetas | Lista de etiquetas definidas pelo utilizador. | cadeia[] |
| retryPolicy | A política de repetição para eventos. Isto pode ser utilizado para configurar o número máximo de tentativas de entrega e tempo de transmissão em direto para eventos. | RetryPolicy |
DeadLetterDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Definir o tipo de objeto | StorageBlob (obrigatório) |
StorageBlobDeadLetterDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo de ponto final para o destino da letra não entregue | "StorageBlob" (obrigatório) |
| propriedades | As propriedades do destino deadletter baseado em Blobs de Armazenamento | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| blobContainerName | O nome do contentor de blobs de armazenamento que é o destino dos eventos deadletter | string |
| resourceId | O 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 onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/letra não entregue. |
DeadLetterDestination |
| identidade | A identidade a utilizar quando são apresentados eventos de letra não entregue. | EventSubscriptionIdentity |
EventSubscriptionIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade. | "SystemAssigned" "UserAssigned" |
| userAssignedIdentity | A identidade de utilizador associada ao recurso. | string |
DeliveryWithResourceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| destino | Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/sem letras. |
EventSubscriptionDestination |
| identidade | A identidade a utilizar ao entregar eventos. | EventSubscriptionIdentity |
EventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Definir o tipo de objeto | AzureFunction EventHub Ligação Híbrida MonitorAlert NamespaceTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook (obrigatório) |
AzureFunctionEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "AzureFunction" (obrigatório) |
| propriedades | Propriedades da Função do Azure do destino da subscrição de eventos. | 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 preferencial do lote em Kilobytes. | int |
| resourceId | O ID de Recurso do Azure que representa o ponto final do destino da Função do Azure de uma subscrição de evento. | string |
DeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| name | Nome do atributo ou cabeçalho de entrega. | string |
| tipo | Definir o tipo de objeto | Dinâmico Estático (obrigatório) |
DynamicDeliveryAttributeMapping
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo do atributo de entrega ou nome do cabeçalho. | "Dinâmico" (obrigatório) |
| propriedades | Propriedades do mapeamento de atributos 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 nome do cabeçalho. | "Estático" (obrigatório) |
| propriedades | Propriedades do mapeamento de atributos de entrega estática. | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
| Nome | Descrição | Valor |
|---|---|---|
| isSecret | Sinalizador booleano para saber se o atributo contém informações confidenciais. | bool |
| valor | Valor do atributo de entrega. | string |
EventHubEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "EventHub" (obrigatório) |
| propriedades | Propriedades do Hub de Eventos do destino da subscrição de eventos. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | O ID de Recurso do Azure que representa o ponto final de um destino do Hub de Eventos de uma subscrição de evento. | string |
HybridConnectionEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "HybridConnection" (obrigatório) |
| propriedades | Propriedades da ligação híbrida do destino da subscrição de eventos. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | O ID de Recurso do Azure de uma ligação híbrida que é o destino de uma subscrição de evento. | string |
MonitorAlertEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "MonitorAlert" (obrigatório) |
| propriedades | Monitorizar as propriedades de Alerta do destino da subscrição de eventos. | MonitorAlertEventSubscriptionDestinationProperties |
MonitorAlertEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| actionGroups | A lista de IDs do ARM dos Grupos de Ações que serão acionados em todos os Alertas acionados através desta subscrição de evento. Cada ID arm de recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}. |
cadeia[] |
| descrição | A descrição que será anexada a todos os Alertas acionados através desta subscrição de evento. | string |
| gravidade | A gravidade que será anexada a todos os Alertas acionados através desta subscrição de evento. Este campo tem de ser fornecido. |
"Sev0" "Sev1" "Sev2" "Sev3" "Sev4" |
NamespaceTopicEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "NamespaceTopic" (obrigatório) |
| propriedades | Propriedades do Tópico do Espaço de Nomes do destino da subscrição de eventos. | NamespaceTopicEventSubscriptionDestinationProperties |
NamespaceTopicEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | O ID de recurso do Azure que representa o ponto final do destino do Tópico do Espaço de Nomes do Event Grid de uma subscrição de evento. Este campo é necessário e o recurso tópico espaço de nomes listado já tem de existir. O ID arm do recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}. |
string |
PartnerEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "PartnerDestination" (obrigatório) |
| propriedades | Propriedades de Destino do Parceiro do destino da subscrição de eventos. | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | O ID de Recurso do Azure que representa o ponto final de um Destino de Parceiro de uma subscrição de evento. | string |
ServiceBusQueueEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto final para o destino da subscrição de eventos. | "ServiceBusQueue" (obrigatório) |
| propriedades | Propriedades do Service Bus do destino da subscrição de eventos. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | O ID de Recurso do Azure que representa o ponto final do destino do Service Bus de uma subscrição de evento. | string |
ServiceBusTopicEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo de ponto final para o destino da subscrição de eventos. | "ServiceBusTopic" (obrigatório) |
| propriedades | Propriedades do Tópico do Service Bus do destino da subscrição do evento. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
| Nome | Descrição | Valor |
|---|---|---|
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| resourceId | O ID de Recurso do Azure que representa o ponto final do destino do Tópico do Service Bus de uma subscrição de evento. | string |
StorageQueueEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo de ponto final para o destino da subscrição de eventos. | "StorageQueue" (obrigatório) |
| propriedades | Propriedades da Fila de Armazenamento do destino da subscrição do evento. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| queueMessageTimeToLiveInSeconds | Tempo de vida da mensagem da fila de armazenamento em segundos. Este valor não pode ser zero ou negativo, com a exceção de utilizar -1 para indicar que o Time To Live da mensagem é Infinito. | int |
| queueName | O nome da fila de Armazenamento numa conta de armazenamento que é o destino de uma subscrição de evento. | string |
| resourceId | O ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma subscrição de evento. | string |
WebHookEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo de ponto final para o destino da subscrição de eventos. | "WebHook" (obrigatório) |
| propriedades | Propriedades do WebHook do destino da subscrição do evento. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | O ID ou URI da Aplicação do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nos pedidos de entrega. | string |
| azureActiveDirectoryTenantId | O ID de Inquilino do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nos pedidos de entrega. | string |
| deliveryAttributeMappings | Detalhes do atributo de entrega. | DeliveryAttributeMapping[] |
| endpointUrl | O URL que representa o ponto final do destino de uma subscrição de evento. | string Restrições: Valor confidencial. Transmita 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 suportada pelo ponto final do webhook | "1.0" "1.1" "1.2" |
| preferredBatchSizeInKilobytes | Tamanho preferencial do lote em Kilobytes. | int |
EventSubscriptionFilter
| Nome | Descrição | Valor |
|---|---|---|
| advancedFilters | Uma matriz de filtros avançados que são utilizados para filtrar subscrições de eventos. | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | Permite que os filtros avançados sejam avaliados relativamente a uma matriz de valores em vez de esperar um valor singular. | bool |
| includedEventTypes | Uma lista dos tipos de evento aplicáveis que têm de fazer parte da subscrição do evento. Se pretender subscrever todos os tipos de eventos predefinidos, defina IncludedEventTypes como nulo. | string[] |
| isSubjectCaseSensitive | Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de forma sensível a maiúsculas e minúsculas. |
bool |
| subjectBeginsWith | Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num prefixo de caminho de recurso. O formato depende do publicador dos eventos. Os carateres universais não são suportados neste caminho. |
string |
| subjectEndsWith | Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num sufixo de caminho de recurso. Os carateres universais não são suportados neste caminho. |
string |
AdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| chave | O campo/propriedade no evento com base no qual pretende filtrar. | string |
| operatorType | Definir o tipo de objeto | BoolEquals IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NúmNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (obrigatório) |
BoolEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "BoolEquals" (obrigatório) |
| valor | O valor do filtro booleano. | bool |
IsNotNullAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "IsNotNull" (obrigatório) |
IsNullOrUndefinedAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "IsNullOrUndefined" (obrigatório) |
NumberGreaterThanAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberGreaterThan" (obrigatório) |
| valor | O valor do filtro. | int |
NumberGreaterThanOrEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberGreaterThanOrEquals" (obrigatório) |
| valor | O valor do filtro. | int |
NumberInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberIn" (obrigatório) |
| values | O conjunto de valores de filtro. | int[] |
NumberInRangeAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberInRange" (obrigatório) |
| values | O conjunto de valores de filtro. | int[][] |
NumberLessThanAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberLessThan" (obrigatório) |
| valor | O valor do filtro. | int |
NumberLessThanOrEqualsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberLessThanOrEquals" (obrigatório) |
| valor | O valor do filtro. | int |
NumberNotInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberNotIn" (obrigatório) |
| values | O conjunto de valores de filtro. | int[] |
NumberNotInRangeAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "NumberNotInRange" (obrigatório) |
| values | O conjunto de valores de filtro. | int[][] |
StringBeginsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringBeginsWith" (obrigatório) |
| values | O conjunto de valores de filtro. | cadeia[] |
StringContainsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringContains" (obrigatório) |
| values | O conjunto de valores de filtro. | cadeia[] |
StringEndsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringEndsWith" (obrigatório) |
| values | O conjunto de valores de filtro. | cadeia[] |
StringInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringIn" (obrigatório) |
| values | O conjunto de valores de filtro. | cadeia[] |
StringNotBeginsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotBeginsWith" (obrigatório) |
| values | O conjunto de valores de filtro. | cadeia[] |
StringNotContainsAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotContains" (obrigatório) |
| values | O conjunto de valores de filtro. | cadeia[] |
StringNotEndsWithAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotEndsWith" (obrigatório) |
| values | O conjunto de valores de filtro. | cadeia[] |
StringNotInAdvancedFilter
| Nome | Descrição | Valor |
|---|---|---|
| operatorType | O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. | "StringNotIn" (obrigatório) |
| values | O conjunto de valores de filtro. | cadeia[] |
RetryPolicy
| Nome | Descrição | Valor |
|---|---|---|
| eventTimeToLiveInMinutes | Time To Live (em minutos) para eventos. | int |
| maxDeliveryAttempts | Número máximo de tentativas de repetição de entrega para eventos. | int |
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários