Compartir a través de


Microsoft.EventGrid eventSuscripciones

Definición de recursos de Bicep

El tipo de recurso eventSubscriptions se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.EventGrid/eventSubscriptions, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2025-04-01-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        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

Establezca la propiedad endpointType para especificar el tipo de objeto.

Para StorageBlob, use:

{
  endpointType: 'StorageBlob'
  properties: {
    blobContainerName: 'string'
    resourceId: 'string'
  }
}

Objetos EventSubscriptionDestination

Establezca la propiedad endpointType para especificar el 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 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

Establezca el tipo propiedad para especificar el tipo de objeto.

Para Dynamic, use:

{
  properties: {
    sourceField: 'string'
  }
  type: 'Dynamic'
}

Para Static, use:

{
  properties: {
    isSecret: bool
    value: 'string'
  }
  type: 'Static'
}

Objetos AdvancedFilter

Establezca la propiedad operatorType para especificar el 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 propiedad

Microsoft.EventGrid/eventSubscriptions

Name Description Value
name El nombre del recurso string (obligatorio)
properties Propiedades de la suscripción de eventos. EventSubscriptionProperties
scope Use al crear un recurso en un ámbito diferente del ámbito de implementación. Establezca esta propiedad en el nombre simbólico de un recurso para aplicar el recurso de extensión.

AdvancedFilter

Name Description Value
key Campo o propiedad del evento en función del cual desea filtrar. string
operatorType Establezca en "BoolEquals" para el tipo BoolEqualsAdvancedFilter. Establézcalo en 'IsNotNull' para el tipo IsNotNullAdvancedFilter. Establézcalo en 'IsNullOrUndefined' para el tipo IsNullOrUndefinedAdvancedFilter. Establezca en "NumberGreaterThan" para el tipo NumberGreaterThanAdvancedFilter. Establezca en "NumberGreaterThanOrEquals" para el tipo NumberGreaterThanOrEqualsAdvancedFilter. Establezca en "NumberIn" para el tipo NumberInAdvancedFilter. Establézcalo en 'NumberInRange' para el tipo NumberInRangeAdvancedFilter. Establezca en "NumberLessThan" para el tipo NumberLessThanAdvancedFilter. Establezca en "NumberLessThanOrEquals" para el tipo NumberLessThanOrEqualsAdvancedFilter. Establezca en "NumberNotIn" para el tipo NumberNotInAdvancedFilter. Establézcalo en 'NumberNotInRange' para el tipo NumberNotInRangeAdvancedFilter. Establezca en "StringBeginsWith" para el tipo StringBeginsWithAdvancedFilter. Establezca en "StringContains" para el tipo StringContainsAdvancedFilter. Establezca en "StringEndsWith" para el tipo StringEndsWithAdvancedFilter. Establezca en "StringIn" para el tipo StringInAdvancedFilter. Establézcalo en 'StringNotBeginsWith' para el tipo StringNotBeginsWithAdvancedFilter. Establézcalo en 'StringNotContains' para el tipo StringNotContainsAdvancedFilter. Establézcalo en 'StringNotEndsWith' para el tipo StringNotEndsWithAdvancedFilter. Establezca en "StringNotIn" para el tipo StringNotInAdvancedFilter. 'BoolEquals'
'IsNotNull'
'IsNullOrUndefined'
'NumberGreaterThan'
'NumberGreaterThanOrEquals'
'NumberIn'
'NumberInRange'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'NumberNotInRange'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn'
'StringNotBeginsWith'
'StringNotContains'
'StringNotEndsWith'
'StringNotIn' (obligatorio)

AzureFunctionEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'AzureFunction' (obligatorio)
properties Propiedades de la función de Azure del destino de la suscripción de eventos. AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
maxEventsPerBatch Número máximo de eventos por lote. int
preferredBatchSizeInKilobytes Tamaño de lote preferido en Kilobytes. int
resourceId Identificador de recurso de Azure que representa el punto de conexión del destino de la función de Azure de una suscripción de eventos. string

BoolEqualsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'BoolEquals' (obligatorio)
value Valor de filtro booleano. bool

DeadLetterDestination

Name Description Value
endpointType Establezca en "StorageBlob" para el tipo StorageBlobDeadLetterDestination. 'StorageBlob' (obligatorio)

DeadLetterWithResourceIdentity

Name Description Value
deadLetterDestination Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos.
Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega de mensajes fallidos.
DeadLetterDestination
identity Identidad que se va a usar cuando se produzcan eventos de mensajes fallidos. EventSubscriptionIdentity

DeliveryAttributeMapping

Name Description Value
name Nombre del atributo o encabezado de entrega. string
type Establézcalo en "Dynamic" para el tipo DynamicDeliveryAttributeMapping. Establézcalo en "Static" para el tipo StaticDeliveryAttributeMapping. 'Dynamic'
'Estático' (obligatorio)

DeliveryWithResourceIdentity

Name Description Value
destination Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos.
Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega.
EventSubscriptionDestination
identity Identidad que se va a usar al entregar eventos. EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Name Description Value
properties Propiedades de la asignación de atributos de entrega dinámica. DynamicDeliveryAttributeMappingProperties
type Tipo del atributo de entrega o nombre de encabezado. 'Dinámico' (obligatorio)

DynamicDeliveryAttributeMappingProperties

Name Description Value
sourceField Ruta de acceso JSON en el evento que contiene el valor del atributo. string

EventHubEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'EventHub' (obligatorio)
properties Propiedades del centro de eventos del destino de la suscripción de eventos. EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
resourceId Identificador de recurso de Azure que representa el punto de conexión de un destino del centro de eventos de una suscripción de eventos. string

EventSubscriptionDestination

Name Description Value
endpointType Establezca en "AzureFunction" para el tipo AzureFunctionEventSubscriptionDestination. Establezca en "EventHub" para el tipo EventHubEventSubscriptionDestination. Establezca en "HybridConnection" para el tipo HybridConnectionEventSubscriptionDestination. Establézcalo en 'MonitorAlert' para el tipo MonitorAlertEventSubscriptionDestination. Establézcalo en 'NamespaceTopic' para el tipo NamespaceTopicEventSubscriptionDestination. Establézcalo en "PartnerDestination" para el tipo PartnerEventSubscriptionDestination. Establezca en "ServiceBusQueue" para el tipo ServiceBusQueueEventSubscriptionDestination. Establezca en "ServiceBusTopic" para el tipo ServiceBusTopicEventSubscriptionDestination. Establezca en "StorageQueue" para el tipo StorageQueueEventSubscriptionDestination. Establezca en "WebHook" para el tipo WebHookEventSubscriptionDestination. 'AzureFunction'
'EventHub'
'HybridConnection'
'MonitorAlert'
'NamespaceTopic'
'PartnerDestination'
'ServiceBusQueue'
'ServiceBusTopic'
'StorageQueue'
'WebHook' (obligatorio)

EventSubscriptionFilter

Name Description Value
advancedFilters Matriz de filtros avanzados que se usan para filtrar suscripciones de eventos. AdvancedFilter[]
enableAdvancedFilteringOnArrays Permite evaluar filtros avanzados en una matriz de valores en lugar de esperar un valor singular. bool
includedEventTypes Lista de tipos de eventos aplicables que deben formar parte de la suscripción de eventos. Si desea suscribirse a todos los tipos de eventos predeterminados, establezca IncludedEventTypes en null. string[]
isSubjectCaseSensitive Especifica si las propiedades SubjectBeginsWith y SubjectEndsWith del filtro
debe compararse de forma confidencial entre mayúsculas y minúsculas.
bool
subjectBeginsWith Cadena opcional para filtrar eventos de una suscripción de eventos en función de un prefijo de ruta de acceso de recurso.
El formato de esto depende del publicador de los eventos.
Los caracteres comodín no se admiten en esta ruta de acceso.
string
subjectEndsWith Cadena opcional para filtrar eventos de una suscripción de eventos en función de un sufijo de ruta de acceso de recurso.
Los caracteres comodín no se admiten en esta ruta de acceso.
string

EventSubscriptionIdentity

Name Description Value
federatedIdentityCredentialInfo Detalles de la credencial de identidad federada (FIC) que se usa con la entrega de recursos. FederatedIdentityCredentialInfo
type Tipo de identidad administrada usada. Puede ser "SystemAssigned" o "UserAssigned". 'SystemAssigned'
'UserAssigned'
userAssignedIdentity Identidad de usuario asociada al recurso. string

EventSubscriptionProperties

Name Description Value
deadLetterDestination Destino de mensajes fallidos de la suscripción de eventos. Cualquier evento que no se pueda entregar a su destino se envía al destino de mensajes fallidos.
Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.
DeadLetterDestination
deadLetterWithResourceIdentity Destino de mensajes fallidos de la suscripción de eventos. Cualquier evento que no se pueda entregar a su destino se envía al destino de mensajes fallidos.
Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos.
Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.
DeliveryWithResourceIdentity
destination Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos.
Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.
EventSubscriptionDestination
eventDeliverySchema Esquema de entrega de eventos para la suscripción de eventos. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Hora de expiración de la suscripción de eventos. string
filter Información sobre el filtro de la suscripción de eventos. EventSubscriptionFilter
labels Lista de etiquetas definidas por el usuario. string[]
retryPolicy Directiva de reintento para eventos. Se puede usar para configurar el número máximo de intentos de entrega y el tiempo de vida de los eventos. RetryPolicy

FederatedIdentityCredentialInfo

Name Description Value
federatedClientId La aplicación de identificador de Microsoft Entra multiinquilino a la que está asociada la credencial de identidad federada (FIC). string

Constraints:
Longitud mínima = 36
Longitud máxima = 36
Patrón = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (obligatorio)

HybridConnectionEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'HybridConnection' (obligatorio)
properties Propiedades de conexión híbrida del destino de la suscripción de eventos. HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
resourceId Identificador de recurso de Azure de una conexión híbrida que es el destino de una suscripción de eventos. string

IsNotNullAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'IsNotNull' (obligatorio)

IsNullOrUndefinedAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'IsNullOrUndefined' (obligatorio)

MonitorAlertEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'MonitorAlert' (obligatorio)
properties Supervise las propiedades de alerta del destino de la suscripción de eventos. MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

Name Description Value
actionGroups Lista de identificadores de ARM de grupos de acciones que se desencadenarán en cada alerta desencadenada a través de esta suscripción de eventos.
Cada identificador de ARM de recurso debe seguir este patrón: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
description Descripción que se asociará a cada alerta desencadenada a través de esta suscripción de eventos. string
severity Gravedad que se asociará a cada alerta desencadenada a través de esta suscripción de eventos.
Este campo debe proporcionarse.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'NamespaceTopic' (obligatorio)
properties Propiedades del tema espacio de nombres del destino de la suscripción de eventos. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Name Description Value
resourceId Identificador de recurso de Azure que representa el punto de conexión del destino del tema del espacio de nombres de Event Grid de una suscripción de eventos.
Este campo es obligatorio y el recurso Tema de espacio de nombres enumerado ya debe existir.
El identificador de ARM del recurso debe seguir este patrón: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.
string

NumberGreaterThanAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberGreaterThan' (obligatorio)
value Valor de filtro. int

NumberGreaterThanOrEqualsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberGreaterThanOrEquals' (obligatorio)
value Valor de filtro. int

NumberInAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberIn' (obligatorio)
values Conjunto de valores de filtro. int[]

NumberInRangeAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberInRange' (obligatorio)
values Conjunto de valores de filtro. int[][]

NumberLessThanAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberLessThan' (obligatorio)
value Valor de filtro. int

NumberLessThanOrEqualsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberLessThanOrEquals' (obligatorio)
value Valor de filtro. int

NumberNotInAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberNotIn' (obligatorio)
values Conjunto de valores de filtro. int[]

NumberNotInRangeAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberNotInRange' (obligatorio)
values Conjunto de valores de filtro. int[][]

PartnerEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'PartnerDestination' (obligatorio)
properties Propiedades de destino del asociado del destino de la suscripción de eventos. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

Name Description Value
resourceId Identificador de recurso de Azure que representa el punto de conexión de un destino de asociado de una suscripción de eventos. string

RetryPolicy

Name Description Value
eventTimeToLiveInMinutes Período de vida (en minutos) para eventos. int
maxDeliveryAttempts Número máximo de reintentos de entrega para eventos. int

ServiceBusQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'ServiceBusQueue' (obligatorio)
properties Propiedades de Service Bus del destino de la suscripción de eventos. ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
resourceId Identificador de recurso de Azure que representa el punto de conexión del destino de Service Bus de una suscripción de eventos. string

ServiceBusTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'ServiceBusTopic' (obligatorio)
properties Propiedades del tema de Service Bus del destino de la suscripción de eventos. ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
resourceId Identificador de recurso de Azure que representa el punto de conexión del destino del tema de Service Bus de una suscripción de eventos. string

StaticDeliveryAttributeMapping

Name Description Value
properties Propiedades de la asignación de atributos de entrega estática. StaticDeliveryAttributeMappingProperties
type Tipo del atributo de entrega o nombre de encabezado. 'Estático' (obligatorio)

StaticDeliveryAttributeMappingProperties

Name Description Value
isSecret Marca booleana para indicar si el atributo contiene información confidencial . bool
value Valor del atributo de entrega. string

StorageBlobDeadLetterDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de mensajes fallidos 'StorageBlob' (obligatorio)
properties Las propiedades del destino de deadletter basado en blobs de almacenamiento StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Name Description Value
blobContainerName Nombre del contenedor de blobs de Storage que es el destino de los eventos deadletter. string
resourceId Identificador de recurso de Azure de la cuenta de almacenamiento que es el destino de los eventos deadletter. string

StorageQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'StorageQueue' (obligatorio)
properties Propiedades de la cola de almacenamiento del destino de la suscripción de eventos. StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Name Description Value
queueMessageTimeToLiveInSeconds Tiempo de vida del mensaje de cola de almacenamiento en segundos. Este valor no puede ser cero o negativo con la excepción de usar -1 para indicar que el período de vida del mensaje es Infinito. int
queueName Nombre de la cola de Storage en una cuenta de almacenamiento que es el destino de una suscripción de eventos. string
resourceId Identificador de recurso de Azure de la cuenta de almacenamiento que contiene la cola que es el destino de una suscripción de eventos. string

StringBeginsWithAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringBeginsWith' (obligatorio)
values Conjunto de valores de filtro. string[]

StringContainsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringContains' (obligatorio)
values Conjunto de valores de filtro. string[]

StringEndsWithAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringEndsWith' (obligatorio)
values Conjunto de valores de filtro. string[]

StringInAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringIn' (obligatorio)
values Conjunto de valores de filtro. string[]

StringNotBeginsWithAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringNotBeginsWith' (obligatorio)
values Conjunto de valores de filtro. string[]

StringNotContainsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringNotContains' (obligatorio)
values Conjunto de valores de filtro. string[]

StringNotEndsWithAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringNotEndsWith' (obligatorio)
values Conjunto de valores de filtro. string[]

StringNotInAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringNotIn' (obligatorio)
values Conjunto de valores de filtro. string[]

WebHookEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'WebHook' (obligatorio)
properties Propiedades de webHook del destino de la suscripción de eventos. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Name Description Value
azureActiveDirectoryApplicationIdOrUri El identificador de aplicación o URI de Microsoft Entra para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. string
azureActiveDirectoryTenantId El identificador de inquilino de Microsoft Entra ID para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. string
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
endpointUrl Dirección URL que representa el punto de conexión del destino de una suscripción de eventos. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
maxEventsPerBatch Número máximo de eventos por lote. int
minimumTlsVersionAllowed Versión mínima de TLS que debe ser compatible con el punto de conexión de webhook '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Tamaño de lote preferido en Kilobytes. int

Ejemplos de uso

Ejemplos de inicio rápido de Azure

Los siguientes plantillas de inicio rápido de Azure contienen ejemplos de Bicep para implementar este tipo de recurso.

Archivo de Bicep Description
Creación de un tema personalizado de Azure Event Grid y una suscripción de cola Crea un tema personalizado de Azure Event Grid y una suscripción de cola de Service Bus. Plantilla originalmente creadas por Markus Meyer.
Creación de un tema y una suscripción personalizados de Azure Event Grid Crea un tema personalizado de Azure Event Grid y una suscripción de webhook. Plantilla originalmente creadas por John Downs.

Definición de recursos de plantilla de ARM

El tipo de recurso eventSubscriptions se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.EventGrid/eventSubscriptions, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2025-04-01-preview",
  "name": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "deadLetterWithResourceIdentity": {
      "deadLetterDestination": {
        "endpointType": "string"
        // For remaining properties, see DeadLetterDestination objects
      },
      "identity": {
        "federatedIdentityCredentialInfo": {
          "federatedClientId": "string"
        },
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "deliveryWithResourceIdentity": {
      "destination": {
        "endpointType": "string"
        // For remaining properties, see EventSubscriptionDestination objects
      },
      "identity": {
        "federatedIdentityCredentialInfo": {
          "federatedClientId": "string"
        },
        "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

Establezca la propiedad endpointType para especificar el tipo de objeto.

Para StorageBlob, use:

{
  "endpointType": "StorageBlob",
  "properties": {
    "blobContainerName": "string",
    "resourceId": "string"
  }
}

Objetos EventSubscriptionDestination

Establezca la propiedad endpointType para especificar el 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 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

Establezca el tipo propiedad para especificar el tipo de objeto.

Para Dynamic, use:

{
  "properties": {
    "sourceField": "string"
  },
  "type": "Dynamic"
}

Para Static, use:

{
  "properties": {
    "isSecret": "bool",
    "value": "string"
  },
  "type": "Static"
}

Objetos AdvancedFilter

Establezca la propiedad operatorType para especificar el 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 propiedad

Microsoft.EventGrid/eventSubscriptions

Name Description Value
apiVersion La versión de api '2025-04-01-preview'
name El nombre del recurso string (obligatorio)
properties Propiedades de la suscripción de eventos. EventSubscriptionProperties
type El tipo de recurso 'Microsoft.EventGrid/eventSubscriptions'

AdvancedFilter

Name Description Value
key Campo o propiedad del evento en función del cual desea filtrar. string
operatorType Establezca en "BoolEquals" para el tipo BoolEqualsAdvancedFilter. Establézcalo en 'IsNotNull' para el tipo IsNotNullAdvancedFilter. Establézcalo en 'IsNullOrUndefined' para el tipo IsNullOrUndefinedAdvancedFilter. Establezca en "NumberGreaterThan" para el tipo NumberGreaterThanAdvancedFilter. Establezca en "NumberGreaterThanOrEquals" para el tipo NumberGreaterThanOrEqualsAdvancedFilter. Establezca en "NumberIn" para el tipo NumberInAdvancedFilter. Establézcalo en 'NumberInRange' para el tipo NumberInRangeAdvancedFilter. Establezca en "NumberLessThan" para el tipo NumberLessThanAdvancedFilter. Establezca en "NumberLessThanOrEquals" para el tipo NumberLessThanOrEqualsAdvancedFilter. Establezca en "NumberNotIn" para el tipo NumberNotInAdvancedFilter. Establézcalo en 'NumberNotInRange' para el tipo NumberNotInRangeAdvancedFilter. Establezca en "StringBeginsWith" para el tipo StringBeginsWithAdvancedFilter. Establezca en "StringContains" para el tipo StringContainsAdvancedFilter. Establezca en "StringEndsWith" para el tipo StringEndsWithAdvancedFilter. Establezca en "StringIn" para el tipo StringInAdvancedFilter. Establézcalo en 'StringNotBeginsWith' para el tipo StringNotBeginsWithAdvancedFilter. Establézcalo en 'StringNotContains' para el tipo StringNotContainsAdvancedFilter. Establézcalo en 'StringNotEndsWith' para el tipo StringNotEndsWithAdvancedFilter. Establezca en "StringNotIn" para el tipo StringNotInAdvancedFilter. 'BoolEquals'
'IsNotNull'
'IsNullOrUndefined'
'NumberGreaterThan'
'NumberGreaterThanOrEquals'
'NumberIn'
'NumberInRange'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'NumberNotInRange'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn'
'StringNotBeginsWith'
'StringNotContains'
'StringNotEndsWith'
'StringNotIn' (obligatorio)

AzureFunctionEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'AzureFunction' (obligatorio)
properties Propiedades de la función de Azure del destino de la suscripción de eventos. AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
maxEventsPerBatch Número máximo de eventos por lote. int
preferredBatchSizeInKilobytes Tamaño de lote preferido en Kilobytes. int
resourceId Identificador de recurso de Azure que representa el punto de conexión del destino de la función de Azure de una suscripción de eventos. string

BoolEqualsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'BoolEquals' (obligatorio)
value Valor de filtro booleano. bool

DeadLetterDestination

Name Description Value
endpointType Establezca en "StorageBlob" para el tipo StorageBlobDeadLetterDestination. 'StorageBlob' (obligatorio)

DeadLetterWithResourceIdentity

Name Description Value
deadLetterDestination Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos.
Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega de mensajes fallidos.
DeadLetterDestination
identity Identidad que se va a usar cuando se produzcan eventos de mensajes fallidos. EventSubscriptionIdentity

DeliveryAttributeMapping

Name Description Value
name Nombre del atributo o encabezado de entrega. string
type Establézcalo en "Dynamic" para el tipo DynamicDeliveryAttributeMapping. Establézcalo en "Static" para el tipo StaticDeliveryAttributeMapping. 'Dynamic'
'Estático' (obligatorio)

DeliveryWithResourceIdentity

Name Description Value
destination Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos.
Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega.
EventSubscriptionDestination
identity Identidad que se va a usar al entregar eventos. EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Name Description Value
properties Propiedades de la asignación de atributos de entrega dinámica. DynamicDeliveryAttributeMappingProperties
type Tipo del atributo de entrega o nombre de encabezado. 'Dinámico' (obligatorio)

DynamicDeliveryAttributeMappingProperties

Name Description Value
sourceField Ruta de acceso JSON en el evento que contiene el valor del atributo. string

EventHubEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'EventHub' (obligatorio)
properties Propiedades del centro de eventos del destino de la suscripción de eventos. EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
resourceId Identificador de recurso de Azure que representa el punto de conexión de un destino del centro de eventos de una suscripción de eventos. string

EventSubscriptionDestination

Name Description Value
endpointType Establezca en "AzureFunction" para el tipo AzureFunctionEventSubscriptionDestination. Establezca en "EventHub" para el tipo EventHubEventSubscriptionDestination. Establezca en "HybridConnection" para el tipo HybridConnectionEventSubscriptionDestination. Establézcalo en 'MonitorAlert' para el tipo MonitorAlertEventSubscriptionDestination. Establézcalo en 'NamespaceTopic' para el tipo NamespaceTopicEventSubscriptionDestination. Establézcalo en "PartnerDestination" para el tipo PartnerEventSubscriptionDestination. Establezca en "ServiceBusQueue" para el tipo ServiceBusQueueEventSubscriptionDestination. Establezca en "ServiceBusTopic" para el tipo ServiceBusTopicEventSubscriptionDestination. Establezca en "StorageQueue" para el tipo StorageQueueEventSubscriptionDestination. Establezca en "WebHook" para el tipo WebHookEventSubscriptionDestination. 'AzureFunction'
'EventHub'
'HybridConnection'
'MonitorAlert'
'NamespaceTopic'
'PartnerDestination'
'ServiceBusQueue'
'ServiceBusTopic'
'StorageQueue'
'WebHook' (obligatorio)

EventSubscriptionFilter

Name Description Value
advancedFilters Matriz de filtros avanzados que se usan para filtrar suscripciones de eventos. AdvancedFilter[]
enableAdvancedFilteringOnArrays Permite evaluar filtros avanzados en una matriz de valores en lugar de esperar un valor singular. bool
includedEventTypes Lista de tipos de eventos aplicables que deben formar parte de la suscripción de eventos. Si desea suscribirse a todos los tipos de eventos predeterminados, establezca IncludedEventTypes en null. string[]
isSubjectCaseSensitive Especifica si las propiedades SubjectBeginsWith y SubjectEndsWith del filtro
debe compararse de forma confidencial entre mayúsculas y minúsculas.
bool
subjectBeginsWith Cadena opcional para filtrar eventos de una suscripción de eventos en función de un prefijo de ruta de acceso de recurso.
El formato de esto depende del publicador de los eventos.
Los caracteres comodín no se admiten en esta ruta de acceso.
string
subjectEndsWith Cadena opcional para filtrar eventos de una suscripción de eventos en función de un sufijo de ruta de acceso de recurso.
Los caracteres comodín no se admiten en esta ruta de acceso.
string

EventSubscriptionIdentity

Name Description Value
federatedIdentityCredentialInfo Detalles de la credencial de identidad federada (FIC) que se usa con la entrega de recursos. FederatedIdentityCredentialInfo
type Tipo de identidad administrada usada. Puede ser "SystemAssigned" o "UserAssigned". 'SystemAssigned'
'UserAssigned'
userAssignedIdentity Identidad de usuario asociada al recurso. string

EventSubscriptionProperties

Name Description Value
deadLetterDestination Destino de mensajes fallidos de la suscripción de eventos. Cualquier evento que no se pueda entregar a su destino se envía al destino de mensajes fallidos.
Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.
DeadLetterDestination
deadLetterWithResourceIdentity Destino de mensajes fallidos de la suscripción de eventos. Cualquier evento que no se pueda entregar a su destino se envía al destino de mensajes fallidos.
Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos.
Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.
DeliveryWithResourceIdentity
destination Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos.
Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.
EventSubscriptionDestination
eventDeliverySchema Esquema de entrega de eventos para la suscripción de eventos. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Hora de expiración de la suscripción de eventos. string
filter Información sobre el filtro de la suscripción de eventos. EventSubscriptionFilter
labels Lista de etiquetas definidas por el usuario. string[]
retryPolicy Directiva de reintento para eventos. Se puede usar para configurar el número máximo de intentos de entrega y el tiempo de vida de los eventos. RetryPolicy

FederatedIdentityCredentialInfo

Name Description Value
federatedClientId La aplicación de identificador de Microsoft Entra multiinquilino a la que está asociada la credencial de identidad federada (FIC). string

Constraints:
Longitud mínima = 36
Longitud máxima = 36
Patrón = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (obligatorio)

HybridConnectionEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'HybridConnection' (obligatorio)
properties Propiedades de conexión híbrida del destino de la suscripción de eventos. HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
resourceId Identificador de recurso de Azure de una conexión híbrida que es el destino de una suscripción de eventos. string

IsNotNullAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'IsNotNull' (obligatorio)

IsNullOrUndefinedAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'IsNullOrUndefined' (obligatorio)

MonitorAlertEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'MonitorAlert' (obligatorio)
properties Supervise las propiedades de alerta del destino de la suscripción de eventos. MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

Name Description Value
actionGroups Lista de identificadores de ARM de grupos de acciones que se desencadenarán en cada alerta desencadenada a través de esta suscripción de eventos.
Cada identificador de ARM de recurso debe seguir este patrón: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
description Descripción que se asociará a cada alerta desencadenada a través de esta suscripción de eventos. string
severity Gravedad que se asociará a cada alerta desencadenada a través de esta suscripción de eventos.
Este campo debe proporcionarse.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'NamespaceTopic' (obligatorio)
properties Propiedades del tema espacio de nombres del destino de la suscripción de eventos. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Name Description Value
resourceId Identificador de recurso de Azure que representa el punto de conexión del destino del tema del espacio de nombres de Event Grid de una suscripción de eventos.
Este campo es obligatorio y el recurso Tema de espacio de nombres enumerado ya debe existir.
El identificador de ARM del recurso debe seguir este patrón: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.
string

NumberGreaterThanAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberGreaterThan' (obligatorio)
value Valor de filtro. int

NumberGreaterThanOrEqualsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberGreaterThanOrEquals' (obligatorio)
value Valor de filtro. int

NumberInAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberIn' (obligatorio)
values Conjunto de valores de filtro. int[]

NumberInRangeAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberInRange' (obligatorio)
values Conjunto de valores de filtro. int[][]

NumberLessThanAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberLessThan' (obligatorio)
value Valor de filtro. int

NumberLessThanOrEqualsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberLessThanOrEquals' (obligatorio)
value Valor de filtro. int

NumberNotInAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberNotIn' (obligatorio)
values Conjunto de valores de filtro. int[]

NumberNotInRangeAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberNotInRange' (obligatorio)
values Conjunto de valores de filtro. int[][]

PartnerEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'PartnerDestination' (obligatorio)
properties Propiedades de destino del asociado del destino de la suscripción de eventos. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

Name Description Value
resourceId Identificador de recurso de Azure que representa el punto de conexión de un destino de asociado de una suscripción de eventos. string

RetryPolicy

Name Description Value
eventTimeToLiveInMinutes Período de vida (en minutos) para eventos. int
maxDeliveryAttempts Número máximo de reintentos de entrega para eventos. int

ServiceBusQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'ServiceBusQueue' (obligatorio)
properties Propiedades de Service Bus del destino de la suscripción de eventos. ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
resourceId Identificador de recurso de Azure que representa el punto de conexión del destino de Service Bus de una suscripción de eventos. string

ServiceBusTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'ServiceBusTopic' (obligatorio)
properties Propiedades del tema de Service Bus del destino de la suscripción de eventos. ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
resourceId Identificador de recurso de Azure que representa el punto de conexión del destino del tema de Service Bus de una suscripción de eventos. string

StaticDeliveryAttributeMapping

Name Description Value
properties Propiedades de la asignación de atributos de entrega estática. StaticDeliveryAttributeMappingProperties
type Tipo del atributo de entrega o nombre de encabezado. 'Estático' (obligatorio)

StaticDeliveryAttributeMappingProperties

Name Description Value
isSecret Marca booleana para indicar si el atributo contiene información confidencial . bool
value Valor del atributo de entrega. string

StorageBlobDeadLetterDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de mensajes fallidos 'StorageBlob' (obligatorio)
properties Las propiedades del destino de deadletter basado en blobs de almacenamiento StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Name Description Value
blobContainerName Nombre del contenedor de blobs de Storage que es el destino de los eventos deadletter. string
resourceId Identificador de recurso de Azure de la cuenta de almacenamiento que es el destino de los eventos deadletter. string

StorageQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'StorageQueue' (obligatorio)
properties Propiedades de la cola de almacenamiento del destino de la suscripción de eventos. StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Name Description Value
queueMessageTimeToLiveInSeconds Tiempo de vida del mensaje de cola de almacenamiento en segundos. Este valor no puede ser cero o negativo con la excepción de usar -1 para indicar que el período de vida del mensaje es Infinito. int
queueName Nombre de la cola de Storage en una cuenta de almacenamiento que es el destino de una suscripción de eventos. string
resourceId Identificador de recurso de Azure de la cuenta de almacenamiento que contiene la cola que es el destino de una suscripción de eventos. string

StringBeginsWithAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringBeginsWith' (obligatorio)
values Conjunto de valores de filtro. string[]

StringContainsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringContains' (obligatorio)
values Conjunto de valores de filtro. string[]

StringEndsWithAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringEndsWith' (obligatorio)
values Conjunto de valores de filtro. string[]

StringInAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringIn' (obligatorio)
values Conjunto de valores de filtro. string[]

StringNotBeginsWithAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringNotBeginsWith' (obligatorio)
values Conjunto de valores de filtro. string[]

StringNotContainsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringNotContains' (obligatorio)
values Conjunto de valores de filtro. string[]

StringNotEndsWithAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringNotEndsWith' (obligatorio)
values Conjunto de valores de filtro. string[]

StringNotInAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringNotIn' (obligatorio)
values Conjunto de valores de filtro. string[]

WebHookEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'WebHook' (obligatorio)
properties Propiedades de webHook del destino de la suscripción de eventos. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Name Description Value
azureActiveDirectoryApplicationIdOrUri El identificador de aplicación o URI de Microsoft Entra para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. string
azureActiveDirectoryTenantId El identificador de inquilino de Microsoft Entra ID para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. string
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
endpointUrl Dirección URL que representa el punto de conexión del destino de una suscripción de eventos. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
maxEventsPerBatch Número máximo de eventos por lote. int
minimumTlsVersionAllowed Versión mínima de TLS que debe ser compatible con el punto de conexión de webhook '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Tamaño de lote preferido en Kilobytes. int

Ejemplos de uso

Plantillas de inicio rápido de Azure

Los siguientes plantillas de inicio rápido de Azure implementar este tipo de recurso.

Template Description
Creación de un tema personalizado de Azure Event Grid y una suscripción de cola

Implementación en Azure
Crea un tema personalizado de Azure Event Grid y una suscripción de cola de Service Bus. Plantilla originalmente creadas por Markus Meyer.
Creación de un tema y una suscripción personalizados de Azure Event Grid

Implementación en Azure
Crea un tema personalizado de Azure Event Grid y una suscripción de webhook. Plantilla originalmente creadas por John Downs.
Creación de una suscripción a temas personalizados de Azure Event Grid

Implementación en Azure
Crea un tema personalizado de Azure Event Grid y una suscripción a temas de Service Bus. Plantilla originalmente creadas por Markus Meyer.
Creación de un tema personalizado de Event Grid y un controlador del centro de eventos

Implementación en Azure
Crea un tema personalizado de Azure Event Grid y un centro de eventos para controlar los eventos.
Creación de una suscripción de Event Grid para eventos de recursos

Implementación en Azure
Crea una suscripción de Event Grid a un grupo de recursos o a una suscripción de Azure.
Tema o suscripción personalizados de Azure Event Grid con CloudEvents

Implementación en Azure
Crea un tema personalizado de Azure Event Grid, una suscripción de webhook que tiene el esquema CloudEvents y una aplicación lógica como controlador de eventos. Plantilla originalmente creadas por Justin Yoo.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso eventSubscriptions se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.EventGrid/eventSubscriptions, agregue el siguiente Terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2025-04-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      deadLetterWithResourceIdentity = {
        deadLetterDestination = {
          endpointType = "string"
          // For remaining properties, see DeadLetterDestination objects
        }
        identity = {
          federatedIdentityCredentialInfo = {
            federatedClientId = "string"
          }
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      deliveryWithResourceIdentity = {
        destination = {
          endpointType = "string"
          // For remaining properties, see EventSubscriptionDestination objects
        }
        identity = {
          federatedIdentityCredentialInfo = {
            federatedClientId = "string"
          }
          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

Establezca la propiedad endpointType para especificar el tipo de objeto.

Para StorageBlob, use:

{
  endpointType = "StorageBlob"
  properties = {
    blobContainerName = "string"
    resourceId = "string"
  }
}

Objetos EventSubscriptionDestination

Establezca la propiedad endpointType para especificar el 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 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

Establezca el tipo propiedad para especificar el tipo de objeto.

Para Dynamic, use:

{
  properties = {
    sourceField = "string"
  }
  type = "Dynamic"
}

Para Static, use:

{
  properties = {
    isSecret = bool
    value = "string"
  }
  type = "Static"
}

Objetos AdvancedFilter

Establezca la propiedad operatorType para especificar el 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 propiedad

Microsoft.EventGrid/eventSubscriptions

Name Description Value
name El nombre del recurso string (obligatorio)
parent_id Identificador del recurso al que se va a aplicar este recurso de extensión. string (obligatorio)
properties Propiedades de la suscripción de eventos. EventSubscriptionProperties
type El tipo de recurso "Microsoft.EventGrid/eventSubscriptions@2025-04-01-preview"

AdvancedFilter

Name Description Value
key Campo o propiedad del evento en función del cual desea filtrar. string
operatorType Establezca en "BoolEquals" para el tipo BoolEqualsAdvancedFilter. Establézcalo en 'IsNotNull' para el tipo IsNotNullAdvancedFilter. Establézcalo en 'IsNullOrUndefined' para el tipo IsNullOrUndefinedAdvancedFilter. Establezca en "NumberGreaterThan" para el tipo NumberGreaterThanAdvancedFilter. Establezca en "NumberGreaterThanOrEquals" para el tipo NumberGreaterThanOrEqualsAdvancedFilter. Establezca en "NumberIn" para el tipo NumberInAdvancedFilter. Establézcalo en 'NumberInRange' para el tipo NumberInRangeAdvancedFilter. Establezca en "NumberLessThan" para el tipo NumberLessThanAdvancedFilter. Establezca en "NumberLessThanOrEquals" para el tipo NumberLessThanOrEqualsAdvancedFilter. Establezca en "NumberNotIn" para el tipo NumberNotInAdvancedFilter. Establézcalo en 'NumberNotInRange' para el tipo NumberNotInRangeAdvancedFilter. Establezca en "StringBeginsWith" para el tipo StringBeginsWithAdvancedFilter. Establezca en "StringContains" para el tipo StringContainsAdvancedFilter. Establezca en "StringEndsWith" para el tipo StringEndsWithAdvancedFilter. Establezca en "StringIn" para el tipo StringInAdvancedFilter. Establézcalo en 'StringNotBeginsWith' para el tipo StringNotBeginsWithAdvancedFilter. Establézcalo en 'StringNotContains' para el tipo StringNotContainsAdvancedFilter. Establézcalo en 'StringNotEndsWith' para el tipo StringNotEndsWithAdvancedFilter. Establezca en "StringNotIn" para el tipo StringNotInAdvancedFilter. 'BoolEquals'
'IsNotNull'
'IsNullOrUndefined'
'NumberGreaterThan'
'NumberGreaterThanOrEquals'
'NumberIn'
'NumberInRange'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'NumberNotInRange'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn'
'StringNotBeginsWith'
'StringNotContains'
'StringNotEndsWith'
'StringNotIn' (obligatorio)

AzureFunctionEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'AzureFunction' (obligatorio)
properties Propiedades de la función de Azure del destino de la suscripción de eventos. AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
maxEventsPerBatch Número máximo de eventos por lote. int
preferredBatchSizeInKilobytes Tamaño de lote preferido en Kilobytes. int
resourceId Identificador de recurso de Azure que representa el punto de conexión del destino de la función de Azure de una suscripción de eventos. string

BoolEqualsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'BoolEquals' (obligatorio)
value Valor de filtro booleano. bool

DeadLetterDestination

Name Description Value
endpointType Establezca en "StorageBlob" para el tipo StorageBlobDeadLetterDestination. 'StorageBlob' (obligatorio)

DeadLetterWithResourceIdentity

Name Description Value
deadLetterDestination Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos.
Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega de mensajes fallidos.
DeadLetterDestination
identity Identidad que se va a usar cuando se produzcan eventos de mensajes fallidos. EventSubscriptionIdentity

DeliveryAttributeMapping

Name Description Value
name Nombre del atributo o encabezado de entrega. string
type Establézcalo en "Dynamic" para el tipo DynamicDeliveryAttributeMapping. Establézcalo en "Static" para el tipo StaticDeliveryAttributeMapping. 'Dynamic'
'Estático' (obligatorio)

DeliveryWithResourceIdentity

Name Description Value
destination Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos.
Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega.
EventSubscriptionDestination
identity Identidad que se va a usar al entregar eventos. EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Name Description Value
properties Propiedades de la asignación de atributos de entrega dinámica. DynamicDeliveryAttributeMappingProperties
type Tipo del atributo de entrega o nombre de encabezado. 'Dinámico' (obligatorio)

DynamicDeliveryAttributeMappingProperties

Name Description Value
sourceField Ruta de acceso JSON en el evento que contiene el valor del atributo. string

EventHubEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'EventHub' (obligatorio)
properties Propiedades del centro de eventos del destino de la suscripción de eventos. EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
resourceId Identificador de recurso de Azure que representa el punto de conexión de un destino del centro de eventos de una suscripción de eventos. string

EventSubscriptionDestination

Name Description Value
endpointType Establezca en "AzureFunction" para el tipo AzureFunctionEventSubscriptionDestination. Establezca en "EventHub" para el tipo EventHubEventSubscriptionDestination. Establezca en "HybridConnection" para el tipo HybridConnectionEventSubscriptionDestination. Establézcalo en 'MonitorAlert' para el tipo MonitorAlertEventSubscriptionDestination. Establézcalo en 'NamespaceTopic' para el tipo NamespaceTopicEventSubscriptionDestination. Establézcalo en "PartnerDestination" para el tipo PartnerEventSubscriptionDestination. Establezca en "ServiceBusQueue" para el tipo ServiceBusQueueEventSubscriptionDestination. Establezca en "ServiceBusTopic" para el tipo ServiceBusTopicEventSubscriptionDestination. Establezca en "StorageQueue" para el tipo StorageQueueEventSubscriptionDestination. Establezca en "WebHook" para el tipo WebHookEventSubscriptionDestination. 'AzureFunction'
'EventHub'
'HybridConnection'
'MonitorAlert'
'NamespaceTopic'
'PartnerDestination'
'ServiceBusQueue'
'ServiceBusTopic'
'StorageQueue'
'WebHook' (obligatorio)

EventSubscriptionFilter

Name Description Value
advancedFilters Matriz de filtros avanzados que se usan para filtrar suscripciones de eventos. AdvancedFilter[]
enableAdvancedFilteringOnArrays Permite evaluar filtros avanzados en una matriz de valores en lugar de esperar un valor singular. bool
includedEventTypes Lista de tipos de eventos aplicables que deben formar parte de la suscripción de eventos. Si desea suscribirse a todos los tipos de eventos predeterminados, establezca IncludedEventTypes en null. string[]
isSubjectCaseSensitive Especifica si las propiedades SubjectBeginsWith y SubjectEndsWith del filtro
debe compararse de forma confidencial entre mayúsculas y minúsculas.
bool
subjectBeginsWith Cadena opcional para filtrar eventos de una suscripción de eventos en función de un prefijo de ruta de acceso de recurso.
El formato de esto depende del publicador de los eventos.
Los caracteres comodín no se admiten en esta ruta de acceso.
string
subjectEndsWith Cadena opcional para filtrar eventos de una suscripción de eventos en función de un sufijo de ruta de acceso de recurso.
Los caracteres comodín no se admiten en esta ruta de acceso.
string

EventSubscriptionIdentity

Name Description Value
federatedIdentityCredentialInfo Detalles de la credencial de identidad federada (FIC) que se usa con la entrega de recursos. FederatedIdentityCredentialInfo
type Tipo de identidad administrada usada. Puede ser "SystemAssigned" o "UserAssigned". 'SystemAssigned'
'UserAssigned'
userAssignedIdentity Identidad de usuario asociada al recurso. string

EventSubscriptionProperties

Name Description Value
deadLetterDestination Destino de mensajes fallidos de la suscripción de eventos. Cualquier evento que no se pueda entregar a su destino se envía al destino de mensajes fallidos.
Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.
DeadLetterDestination
deadLetterWithResourceIdentity Destino de mensajes fallidos de la suscripción de eventos. Cualquier evento que no se pueda entregar a su destino se envía al destino de mensajes fallidos.
Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos.
Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.
DeliveryWithResourceIdentity
destination Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos.
Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.
EventSubscriptionDestination
eventDeliverySchema Esquema de entrega de eventos para la suscripción de eventos. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Hora de expiración de la suscripción de eventos. string
filter Información sobre el filtro de la suscripción de eventos. EventSubscriptionFilter
labels Lista de etiquetas definidas por el usuario. string[]
retryPolicy Directiva de reintento para eventos. Se puede usar para configurar el número máximo de intentos de entrega y el tiempo de vida de los eventos. RetryPolicy

FederatedIdentityCredentialInfo

Name Description Value
federatedClientId La aplicación de identificador de Microsoft Entra multiinquilino a la que está asociada la credencial de identidad federada (FIC). string

Constraints:
Longitud mínima = 36
Longitud máxima = 36
Patrón = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (obligatorio)

HybridConnectionEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'HybridConnection' (obligatorio)
properties Propiedades de conexión híbrida del destino de la suscripción de eventos. HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
resourceId Identificador de recurso de Azure de una conexión híbrida que es el destino de una suscripción de eventos. string

IsNotNullAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'IsNotNull' (obligatorio)

IsNullOrUndefinedAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'IsNullOrUndefined' (obligatorio)

MonitorAlertEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'MonitorAlert' (obligatorio)
properties Supervise las propiedades de alerta del destino de la suscripción de eventos. MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

Name Description Value
actionGroups Lista de identificadores de ARM de grupos de acciones que se desencadenarán en cada alerta desencadenada a través de esta suscripción de eventos.
Cada identificador de ARM de recurso debe seguir este patrón: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
description Descripción que se asociará a cada alerta desencadenada a través de esta suscripción de eventos. string
severity Gravedad que se asociará a cada alerta desencadenada a través de esta suscripción de eventos.
Este campo debe proporcionarse.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'NamespaceTopic' (obligatorio)
properties Propiedades del tema espacio de nombres del destino de la suscripción de eventos. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Name Description Value
resourceId Identificador de recurso de Azure que representa el punto de conexión del destino del tema del espacio de nombres de Event Grid de una suscripción de eventos.
Este campo es obligatorio y el recurso Tema de espacio de nombres enumerado ya debe existir.
El identificador de ARM del recurso debe seguir este patrón: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.
string

NumberGreaterThanAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberGreaterThan' (obligatorio)
value Valor de filtro. int

NumberGreaterThanOrEqualsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberGreaterThanOrEquals' (obligatorio)
value Valor de filtro. int

NumberInAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberIn' (obligatorio)
values Conjunto de valores de filtro. int[]

NumberInRangeAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberInRange' (obligatorio)
values Conjunto de valores de filtro. int[][]

NumberLessThanAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberLessThan' (obligatorio)
value Valor de filtro. int

NumberLessThanOrEqualsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberLessThanOrEquals' (obligatorio)
value Valor de filtro. int

NumberNotInAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberNotIn' (obligatorio)
values Conjunto de valores de filtro. int[]

NumberNotInRangeAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'NumberNotInRange' (obligatorio)
values Conjunto de valores de filtro. int[][]

PartnerEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'PartnerDestination' (obligatorio)
properties Propiedades de destino del asociado del destino de la suscripción de eventos. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

Name Description Value
resourceId Identificador de recurso de Azure que representa el punto de conexión de un destino de asociado de una suscripción de eventos. string

RetryPolicy

Name Description Value
eventTimeToLiveInMinutes Período de vida (en minutos) para eventos. int
maxDeliveryAttempts Número máximo de reintentos de entrega para eventos. int

ServiceBusQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'ServiceBusQueue' (obligatorio)
properties Propiedades de Service Bus del destino de la suscripción de eventos. ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
resourceId Identificador de recurso de Azure que representa el punto de conexión del destino de Service Bus de una suscripción de eventos. string

ServiceBusTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'ServiceBusTopic' (obligatorio)
properties Propiedades del tema de Service Bus del destino de la suscripción de eventos. ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
resourceId Identificador de recurso de Azure que representa el punto de conexión del destino del tema de Service Bus de una suscripción de eventos. string

StaticDeliveryAttributeMapping

Name Description Value
properties Propiedades de la asignación de atributos de entrega estática. StaticDeliveryAttributeMappingProperties
type Tipo del atributo de entrega o nombre de encabezado. 'Estático' (obligatorio)

StaticDeliveryAttributeMappingProperties

Name Description Value
isSecret Marca booleana para indicar si el atributo contiene información confidencial . bool
value Valor del atributo de entrega. string

StorageBlobDeadLetterDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de mensajes fallidos 'StorageBlob' (obligatorio)
properties Las propiedades del destino de deadletter basado en blobs de almacenamiento StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Name Description Value
blobContainerName Nombre del contenedor de blobs de Storage que es el destino de los eventos deadletter. string
resourceId Identificador de recurso de Azure de la cuenta de almacenamiento que es el destino de los eventos deadletter. string

StorageQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'StorageQueue' (obligatorio)
properties Propiedades de la cola de almacenamiento del destino de la suscripción de eventos. StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Name Description Value
queueMessageTimeToLiveInSeconds Tiempo de vida del mensaje de cola de almacenamiento en segundos. Este valor no puede ser cero o negativo con la excepción de usar -1 para indicar que el período de vida del mensaje es Infinito. int
queueName Nombre de la cola de Storage en una cuenta de almacenamiento que es el destino de una suscripción de eventos. string
resourceId Identificador de recurso de Azure de la cuenta de almacenamiento que contiene la cola que es el destino de una suscripción de eventos. string

StringBeginsWithAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringBeginsWith' (obligatorio)
values Conjunto de valores de filtro. string[]

StringContainsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringContains' (obligatorio)
values Conjunto de valores de filtro. string[]

StringEndsWithAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringEndsWith' (obligatorio)
values Conjunto de valores de filtro. string[]

StringInAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringIn' (obligatorio)
values Conjunto de valores de filtro. string[]

StringNotBeginsWithAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringNotBeginsWith' (obligatorio)
values Conjunto de valores de filtro. string[]

StringNotContainsAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringNotContains' (obligatorio)
values Conjunto de valores de filtro. string[]

StringNotEndsWithAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringNotEndsWith' (obligatorio)
values Conjunto de valores de filtro. string[]

StringNotInAdvancedFilter

Name Description Value
operatorType Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. 'StringNotIn' (obligatorio)
values Conjunto de valores de filtro. string[]

WebHookEventSubscriptionDestination

Name Description Value
endpointType Tipo del punto de conexión para el destino de la suscripción de eventos. 'WebHook' (obligatorio)
properties Propiedades de webHook del destino de la suscripción de eventos. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Name Description Value
azureActiveDirectoryApplicationIdOrUri El identificador de aplicación o URI de Microsoft Entra para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. string
azureActiveDirectoryTenantId El identificador de inquilino de Microsoft Entra ID para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. string
deliveryAttributeMappings Detalles del atributo de entrega. DeliveryAttributeMapping[]
endpointUrl Dirección URL que representa el punto de conexión del destino de una suscripción de eventos. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
maxEventsPerBatch Número máximo de eventos por lote. int
minimumTlsVersionAllowed Versión mínima de TLS que debe ser compatible con el punto de conexión de webhook '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Tamaño de lote preferido en Kilobytes. int

Ejemplos de uso

Ejemplos de Terraform

Un ejemplo básico de implementación de la suscripción a eventos de EventGrid.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "namespace" {
  type      = "Microsoft.EventHub/namespaces@2022-01-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      disableLocalAuth     = false
      isAutoInflateEnabled = false
      publicNetworkAccess  = "Enabled"
      zoneRedundant        = false
    }
    sku = {
      capacity = 1
      name     = "Standard"
      tier     = "Standard"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
      accessTier                   = "Hot"
      allowBlobPublicAccess        = true
      allowCrossTenantReplication  = true
      allowSharedKeyAccess         = true
      defaultToOAuthAuthentication = false
      encryption = {
        keySource = "Microsoft.Storage"
        services = {
          queue = {
            keyType = "Service"
          }
          table = {
            keyType = "Service"
          }
        }
      }
      isHnsEnabled      = false
      isNfsV3Enabled    = false
      isSftpEnabled     = false
      minimumTlsVersion = "TLS1_2"
      networkAcls = {
        defaultAction = "Allow"
      }
      publicNetworkAccess      = "Enabled"
      supportsHttpsTrafficOnly = true
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "eventhub" {
  type      = "Microsoft.EventHub/namespaces/eventhubs@2021-11-01"
  parent_id = azapi_resource.namespace.id
  name      = var.resource_name
  body = {
    properties = {
      messageRetentionInDays = 1
      partitionCount         = 1
      status                 = "Active"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "eventSubscription" {
  type      = "Microsoft.EventGrid/eventSubscriptions@2021-12-01"
  parent_id = azapi_resource.storageAccount.id
  name      = var.resource_name
  body = {
    properties = {
      deadLetterDestination = null
      destination = {
        endpointType = "EventHub"
        properties = {
          deliveryAttributeMappings = null
          resourceId                = azapi_resource.eventhub.id
        }
      }
      eventDeliverySchema = "EventGridSchema"
      filter = {
        includedEventTypes = [
          "Microsoft.Storage.BlobCreated",
          "Microsoft.Storage.BlobRenamed",
        ]
      }
      labels = [
      ]
      retryPolicy = {
        eventTimeToLiveInMinutes = 144
        maxDeliveryAttempts      = 10
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}