Espacios de nombres Microsoft.EventGrid/topics/eventSubscriptions 2023-12-15-preview
Definición de recursos de Bicep
El tipo de recurso namespaces/topics/eventSubscriptions se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.EventGrid/namespaces/topics/eventSubscriptions, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
deliveryConfiguration: {
deliveryMode: 'string'
push: {
deadLetterDestinationWithResourceIdentity: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
deliveryWithResourceIdentity: {
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
eventTimeToLive: 'string'
maxDeliveryCount: int
}
queue: {
deadLetterDestinationWithResourceIdentity: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
eventTimeToLive: 'string'
maxDeliveryCount: int
receiveLockDurationInSeconds: int
}
}
eventDeliverySchema: 'CloudEventSchemaV1_0'
filtersConfiguration: {
filters: [
{
key: 'string'
operatorType: 'string'
// For remaining properties, see Filter objects
}
]
includedEventTypes: [
'string'
]
}
}
}
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 la propiedad type para especificar el tipo de objeto.
Para Dynamic, use:
type: 'Dynamic'
properties: {
sourceField: 'string'
}
Para Static, use:
type: 'Static'
properties: {
isSecret: bool
value: 'string'
}
Filtrar objetos
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
namespaces/topics/eventSubscriptions
| Nombre | Descripción | Value |
|---|---|---|
| name | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep. |
string (obligatorio) |
| primario | En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario. Para más información, consulte Recurso secundario fuera del recurso primario. |
Nombre simbólico del recurso de tipo: temas |
| properties | Propiedades de la suscripción de eventos. | SubscriptionProperties |
SubscriptionProperties
| Nombre | Descripción | Valor |
|---|---|---|
| deliveryConfiguration | Información sobre la configuración de entrega de la suscripción de eventos. | DeliveryConfiguration |
| eventDeliverySchema | Esquema de entrega de eventos para la suscripción de eventos. | 'CloudEventSchemaV1_0' |
| filtersConfiguration | Información sobre el filtro de la suscripción de eventos. | FiltersConfiguration |
DeliveryConfiguration
| Nombre | Descripción | Valor |
|---|---|---|
| deliveryMode | Modo de entrega de la suscripción de eventos. | 'Push' 'Cola' |
| push | Esta propiedad debe rellenarse cuando deliveryMode se inserta y representa información sobre la suscripción de inserción. | PushInfo |
| cola | Esta propiedad debe rellenarse cuando deliveryMode está en cola y representa información sobre la suscripción de cola. | QueueInfo |
PushInfo
| Nombre | Descripción | Valor |
|---|---|---|
| deadLetterDestinationWithResourceIdentity | 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, el espacio de nombres) para adquirir los tokens de autenticación que se usan durante la entrega o los mensajes fallidos. |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | Información sobre el destino donde 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 los mensajes fallidos. |
DeliveryWithResourceIdentity |
| eventTimeToLive | Duración del intervalo de tiempo en formato ISO 8601 que determina cuánto tiempo están disponibles los mensajes para la suscripción desde el momento en que se publicó el mensaje. Este valor de duración se expresa con el siguiente formato: "P(n)Y(n)M(n)DT(n)H(n)M(n)S", donde: - (n) se reemplaza por el valor de cada elemento de tiempo que sigue a (n). - P es el designador de duración (o período) y siempre se coloca al principio de la duración. - Y es el designador de año y sigue el valor del número de años. - M es el designador de mes y sigue el valor del número de meses. - W es el designador de semana y sigue el valor del número de semanas. - D es el designador de día y sigue el valor del número de días. - T es el designador de tiempo y precede a los componentes de hora. - H es el designador de hora y sigue el valor del número de horas. - M es el designador de minutos y sigue el valor del número de minutos. - S es el segundo designador y sigue el valor del número de segundos. Este valor de duración no se puede establecer mayor que EventRetentionInDays del tema. Es un campo opcional donde su valor mínimo es de 1 minuto y se determina su máximo. por el valor EventRetentionInDays del tema. A continuación se muestran ejemplos de valores válidos: - "P0DT23H12M" o "PT23H12M": durante 23 horas y 12 minutos. - "P1D" o "P1DT0H0M0S": durante 1 día. |
string |
| maxDeliveryCount | Recuento máximo de entregas de los eventos. | int |
DeadLetterWithResourceIdentity
| Nombre | Descripción | Valor |
|---|---|---|
| deadLetterDestination | Información sobre el destino donde 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 los mensajes fallidos. |
DeadLetterDestination |
| identidad | Identidad que se va a usar cuando se produzcan eventos de mensajes fallidos. | EventSubscriptionIdentity |
DeadLetterDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Establecimiento del tipo de objeto | StorageBlob (obligatorio) |
StorageBlobDeadLetterDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Tipo del punto de conexión para el destino de mensajes fallidos | 'StorageBlob' (obligatorio) |
| properties | Las propiedades del destino de mensajes fallidos basados en Storage Blob | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
EventSubscriptionIdentity
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad. | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | Identidad del usuario asociada al recurso. | string |
DeliveryWithResourceIdentity
| Nombre | Descripción | Valor |
|---|---|---|
| destination | Información sobre el destino donde 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 los mensajes fallidos. |
EventSubscriptionDestination |
| identidad | Identidad que se va a usar al entregar eventos. | EventSubscriptionIdentity |
EventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Establecimiento del tipo de objeto | AzureFunction EventHub HybridConnection MonitorAlert NamespaceTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook (obligatorio) |
AzureFunctionEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
DeliveryAttributeMapping
| Nombre | Descripción | Value |
|---|---|---|
| name | Nombre del atributo o encabezado de entrega. | string |
| type | Establecimiento del tipo de objeto | Dinámica Estático (obligatorio) |
DynamicDeliveryAttributeMapping
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo del atributo de entrega o el nombre del encabezado. | 'Dynamic' (obligatorio) |
| properties | Propiedades de la asignación de atributos de entrega dinámica. | DynamicDeliveryAttributeMappingProperties |
DynamicDeliveryAttributeMappingProperties
| Nombre | Descripción | Valor |
|---|---|---|
| sourceField | Ruta de acceso JSON en el evento que contiene el valor del atributo. | string |
StaticDeliveryAttributeMapping
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo del atributo de entrega o el nombre del encabezado. | 'Static' (obligatorio) |
| properties | Propiedades de la asignación de atributos de entrega estática. | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
| Nombre | Descripción | Valor |
|---|---|---|
| isSecret | Marca booleana para indicar si el atributo contiene información confidencial. | bool |
| value | Valor del atributo de entrega. | string |
EventHubEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
HybridConnectionEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
MonitorAlertEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | 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 que aparece 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 |
PartnerEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | 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 |
ServiceBusQueueEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
StorageQueueEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| queueMessageTimeToLiveInSeconds | Tiempo de vida del mensaje de la 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 |
WebHookEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | Identificador o URI de aplicación de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. | string |
| azureActiveDirectoryTenantId | Identificador de inquilino de Azure Active Directory 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 Restricciones: 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 |
QueueInfo
| Nombre | Descripción | Valor |
|---|---|---|
| deadLetterDestinationWithResourceIdentity | 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) para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos. |
DeadLetterWithResourceIdentity |
| eventTimeToLive | Duración del intervalo de tiempo en formato ISO 8601 que determina cuánto tiempo están disponibles los mensajes para la suscripción desde el momento en que se publicó el mensaje. Este valor de duración se expresa con el siguiente formato: "P(n)Y(n)M(n)DT(n)H(n)M(n)S", donde: - (n) se reemplaza por el valor de cada elemento de tiempo que sigue a (n). - P es el designador de duración (o período) y siempre se coloca al principio de la duración. - Y es el designador de año y sigue el valor del número de años. - M es el designador de mes y sigue el valor del número de meses. - W es el designador de semana y sigue el valor del número de semanas. - D es el designador de día y sigue el valor del número de días. - T es el designador de tiempo y precede a los componentes de hora. - H es el designador de hora y sigue el valor del número de horas. - M es el designador de minutos y sigue el valor del número de minutos. - S es el segundo designador y sigue el valor del número de segundos. Este valor de duración no se puede establecer mayor que EventRetentionInDays del tema. Es un campo opcional donde su valor mínimo es de 1 minuto y se determina su máximo. por el valor EventRetentionInDays del tema. A continuación se muestran ejemplos de valores válidos: - "P0DT23H12M" o "PT23H12M": durante 23 horas y 12 minutos. - "P1D" o "P1DT0H0M0S": durante 1 día. |
string |
| maxDeliveryCount | Recuento máximo de entregas de los eventos. | int |
| receiveLockDurationInSeconds | Período máximo en segundos en el que el estado recibido (por el cliente) recibe el mensaje y espera a ser aceptado, liberado o rechazado. Si este tiempo transcurrido después de que el cliente haya recibido un mensaje y no haya pasado a aceptado (no procesado), liberado o rechazado, el mensaje está disponible para la reelivery. Se trata de un campo opcional, donde el valor predeterminado es de 60 segundos, el mínimo es de 60 segundos y el máximo es de 300 segundos. |
int |
FiltersConfiguration
| Nombre | Descripción | Valor |
|---|---|---|
| filters | Matriz de filtros que se usan para filtrar suscripciones de eventos. | Filtro[] |
| 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[] |
Filtrar
| Nombre | Descripción | Valor |
|---|---|---|
| key | Campo o propiedad en el evento en función del cual desea filtrar. | string |
| operatorType | Establecimiento del tipo de objeto | BoolEquals IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (obligatorio) |
BoolEqualsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'BoolEquals' (obligatorio) |
| value | Valor de filtro booleano. | bool |
IsNotNullFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'IsNotNull' (obligatorio) |
IsNullOrUndefinedFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'IsNullOrUndefined' (obligatorio) |
NumberGreaterThanFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberGreaterThan' (obligatorio) |
| value | El valor de filtro. | int |
NumberGreaterThanOrEqualsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberGreaterThanOrEquals' (obligatorio) |
| value | El valor de filtro. | int |
NumberInFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberIn' (obligatorio) |
| valores | Conjunto de valores de filtro. | int[] |
NumberInRangeFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberInRange' (obligatorio) |
| valores | Conjunto de valores de filtro. | int[][] |
NumberLessThanFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberLessThan' (obligatorio) |
| value | El valor de filtro. | int |
NumberLessThanOrEqualsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberLessThanOrEquals' (obligatorio) |
| value | El valor de filtro. | int |
NumberNotInFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberNotIn' (obligatorio) |
| valores | Conjunto de valores de filtro. | int[] |
NumberNotInRangeFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberNotInRange' (obligatorio) |
| valores | Conjunto de valores de filtro. | int[][] |
StringBeginsWithFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringBeginsWith' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringContainsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringContains' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringEndsWithFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringEndsWith' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringInFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringIn' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringNotBeginsWithFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringNotBeginsWith' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringNotContainsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringNotContains' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringNotEndsWithFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringNotEndsWith' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringNotInFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringNotIn' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
Definición de recursos de plantilla de ARM
El tipo de recurso namespaces/topics/eventSubscriptions se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.EventGrid/namespaces/topics/eventSubscriptions, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.EventGrid/namespaces/topics/eventSubscriptions",
"apiVersion": "2023-12-15-preview",
"name": "string",
"properties": {
"deliveryConfiguration": {
"deliveryMode": "string",
"push": {
"deadLetterDestinationWithResourceIdentity": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"deliveryWithResourceIdentity": {
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"eventTimeToLive": "string",
"maxDeliveryCount": "int"
},
"queue": {
"deadLetterDestinationWithResourceIdentity": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"eventTimeToLive": "string",
"maxDeliveryCount": "int",
"receiveLockDurationInSeconds": "int"
}
},
"eventDeliverySchema": "CloudEventSchemaV1_0",
"filtersConfiguration": {
"filters": [
{
"key": "string",
"operatorType": "string"
// For remaining properties, see Filter objects
}
],
"includedEventTypes": [ "string" ]
}
}
}
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 la propiedad type para especificar el tipo de objeto.
Para Dynamic, use:
"type": "Dynamic",
"properties": {
"sourceField": "string"
}
Para Static, use:
"type": "Static",
"properties": {
"isSecret": "bool",
"value": "string"
}
Filtrar objetos
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
namespaces/topics/eventSubscriptions
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.EventGrid/namespaces/topics/eventSubscriptions" |
| apiVersion | La versión de la API de recursos | "2023-12-15-preview" |
| name | El nombre del recurso Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json. |
string (obligatorio) |
| properties | Propiedades de la suscripción de eventos. | SubscriptionProperties |
SubscriptionProperties
| Nombre | Descripción | Valor |
|---|---|---|
| deliveryConfiguration | Información sobre la configuración de entrega de la suscripción de eventos. | DeliveryConfiguration |
| eventDeliverySchema | Esquema de entrega de eventos para la suscripción de eventos. | 'CloudEventSchemaV1_0' |
| filtersConfiguration | Información sobre el filtro de la suscripción de eventos. | FiltersConfiguration |
DeliveryConfiguration
| Nombre | Descripción | Valor |
|---|---|---|
| deliveryMode | Modo de entrega de la suscripción de eventos. | 'Push' 'Cola' |
| push | Esta propiedad debe rellenarse cuando deliveryMode es push y representa información sobre la suscripción de inserción. | PushInfo |
| cola | Esta propiedad debe rellenarse cuando deliveryMode es una cola y representa información sobre la suscripción de cola. | QueueInfo |
PushInfo
| Nombre | Descripción | Valor |
|---|---|---|
| deadLetterDestinationWithResourceIdentity | 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, el espacio de nombres) para adquirir los tokens de autenticación que se usan durante la entrega o los 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 los mensajes fallidos. |
DeliveryWithResourceIdentity |
| eventTimeToLive | Duración del intervalo de tiempo en formato ISO 8601 que determina cuánto tiempo están disponibles los mensajes para la suscripción a partir del momento en que se publicó el mensaje. Este valor de duración se expresa con el siguiente formato: "P(n)Y(n)M(n)DT(n)H(n)M(n)S", donde: - (n) se reemplaza por el valor de cada elemento de hora que sigue a (n). - P es el designador de duración (o período) y siempre se coloca al principio de la duración. - Y es el designador de año y sigue el valor del número de años. - M es el designador de mes y sigue el valor del número de meses. - W es el designador de semana y sigue el valor del número de semanas. - D es el designador de día y sigue el valor del número de días. - T es el designador de tiempo y precede a los componentes de hora. - H es el designador de hora y sigue el valor del número de horas. - M es el designador de minutos y sigue el valor del número de minutos. - S es el segundo designador y sigue el valor del número de segundos. Este valor de duración no se puede establecer mayor que eventRetentionInDays del tema. Es un campo opcional donde su valor mínimo es de 1 minuto y se determina su máximo. por el valor EventRetentionInDays del tema. A continuación se muestran ejemplos de valores válidos: - "P0DT23H12M" o "PT23H12M": durante 23 horas y 12 minutos. - "P1D" o "P1DT0H0M0S": durante 1 día. |
string |
| maxDeliveryCount | Número máximo de entregas de los eventos. | int |
DeadLetterWithResourceIdentity
| Nombre | Descripción | Valor |
|---|---|---|
| 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 o los mensajes fallidos. |
DeadLetterDestination |
| identidad | Identidad que se va a usar cuando se produzcan mensajes fallidos. | EventSubscriptionIdentity |
DeadLetterDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Establecimiento del tipo de objeto | StorageBlob (obligatorio) |
StorageBlobDeadLetterDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Tipo del punto de conexión para el destino de mensajes fallidos | 'StorageBlob' (obligatorio) |
| properties | Las propiedades del destino de mensajes fallidos basados en Storage Blob | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
EventSubscriptionIdentity
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad. | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | Identidad del usuario asociada al recurso. | string |
DeliveryWithResourceIdentity
| Nombre | Descripción | Valor |
|---|---|---|
| destination | Información sobre el destino donde 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 los mensajes fallidos. |
EventSubscriptionDestination |
| identidad | Identidad que se va a usar al entregar eventos. | EventSubscriptionIdentity |
EventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Establecimiento del tipo de objeto | AzureFunction EventHub HybridConnection MonitorAlert Espacio de nombresTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook (obligatorio) |
AzureFunctionEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
DeliveryAttributeMapping
| Nombre | Descripción | Value |
|---|---|---|
| name | Nombre del atributo o encabezado de entrega. | string |
| type | Establecimiento del tipo de objeto | Dinámica Estático (obligatorio) |
DynamicDeliveryAttributeMapping
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo del atributo de entrega o el nombre del encabezado. | 'Dynamic' (obligatorio) |
| properties | Propiedades de la asignación de atributos de entrega dinámica. | DynamicDeliveryAttributeMappingProperties |
DynamicDeliveryAttributeMappingProperties
| Nombre | Descripción | Valor |
|---|---|---|
| sourceField | Ruta de acceso JSON en el evento que contiene el valor del atributo. | string |
StaticDeliveryAttributeMapping
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo del atributo de entrega o el nombre del encabezado. | 'Static' (obligatorio) |
| properties | Propiedades de la asignación de atributos de entrega estática. | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
| Nombre | Descripción | Valor |
|---|---|---|
| isSecret | Marca booleana para indicar si el atributo contiene información confidencial. | bool |
| value | Valor del atributo de entrega. | string |
EventHubEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
HybridConnectionEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
MonitorAlertEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | 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 que aparece 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 |
PartnerEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | 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 |
ServiceBusQueueEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
StorageQueueEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| queueMessageTimeToLiveInSeconds | Tiempo de vida del mensaje de la 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 |
WebHookEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | Identificador o URI de aplicación de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. | string |
| azureActiveDirectoryTenantId | Identificador de inquilino de Azure Active Directory 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 Restricciones: 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 |
QueueInfo
| Nombre | Descripción | Valor |
|---|---|---|
| deadLetterDestinationWithResourceIdentity | 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) para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos. |
DeadLetterWithResourceIdentity |
| eventTimeToLive | Duración del intervalo de tiempo en formato ISO 8601 que determina cuánto tiempo están disponibles los mensajes para la suscripción desde el momento en que se publicó el mensaje. Este valor de duración se expresa con el siguiente formato: "P(n)Y(n)M(n)DT(n)H(n)M(n)S", donde: - (n) se reemplaza por el valor de cada elemento de tiempo que sigue a (n). - P es el designador de duración (o período) y siempre se coloca al principio de la duración. - Y es el designador de año y sigue el valor del número de años. - M es el designador de mes y sigue el valor del número de meses. - W es el designador de semana y sigue el valor del número de semanas. - D es el designador de día y sigue el valor del número de días. - T es el designador de tiempo y precede a los componentes de hora. - H es el designador de hora y sigue el valor del número de horas. - M es el designador de minutos y sigue el valor del número de minutos. - S es el segundo designador y sigue el valor del número de segundos. Este valor de duración no se puede establecer mayor que EventRetentionInDays del tema. Es un campo opcional donde su valor mínimo es de 1 minuto y se determina su máximo. por el valor EventRetentionInDays del tema. A continuación se muestran ejemplos de valores válidos: - "P0DT23H12M" o "PT23H12M": durante 23 horas y 12 minutos. - "P1D" o "P1DT0H0M0S": durante 1 día. |
string |
| maxDeliveryCount | Recuento máximo de entregas de los eventos. | int |
| receiveLockDurationInSeconds | Período máximo en segundos en el que el estado recibido (por el cliente) recibe el mensaje y espera a ser aceptado, liberado o rechazado. Si este tiempo transcurrido después de que el cliente haya recibido un mensaje y no haya pasado a aceptado (no procesado), liberado o rechazado, el mensaje está disponible para la reelivery. Se trata de un campo opcional, donde el valor predeterminado es de 60 segundos, el mínimo es de 60 segundos y el máximo es de 300 segundos. |
int |
FiltersConfiguration
| Nombre | Descripción | Valor |
|---|---|---|
| filters | Matriz de filtros que se usan para filtrar suscripciones de eventos. | Filtro[] |
| 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[] |
Filtrar
| Nombre | Descripción | Valor |
|---|---|---|
| key | Campo o propiedad en el evento en función del cual desea filtrar. | string |
| operatorType | Establecimiento del tipo de objeto | BoolEquals IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (obligatorio) |
BoolEqualsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'BoolEquals' (obligatorio) |
| value | Valor de filtro booleano. | bool |
IsNotNullFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'IsNotNull' (obligatorio) |
IsNullOrUndefinedFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'IsNullOrUndefined' (obligatorio) |
NumberGreaterThanFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberGreaterThan' (obligatorio) |
| value | El valor de filtro. | int |
NumberGreaterThanOrEqualsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberGreaterThanOrEquals' (obligatorio) |
| value | El valor de filtro. | int |
NumberInFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberIn' (obligatorio) |
| valores | Conjunto de valores de filtro. | int[] |
NumberInRangeFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberInRange' (obligatorio) |
| valores | Conjunto de valores de filtro. | int[][] |
NumberLessThanFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberLessThan' (obligatorio) |
| value | El valor de filtro. | int |
NumberLessThanOrEqualsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberLessThanOrEquals' (obligatorio) |
| value | El valor de filtro. | int |
NumberNotInFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberNotIn' (obligatorio) |
| valores | Conjunto de valores de filtro. | int[] |
NumberNotInRangeFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'NumberNotInRange' (obligatorio) |
| valores | Conjunto de valores de filtro. | int[][] |
StringBeginsWithFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringBeginsWith' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringContainsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringContains' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringEndsWithFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringEndsWith' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringInFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringIn' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringNotBeginsWithFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringNotBeginsWith' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringNotContainsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringNotContains' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringNotEndsWithFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringNotEndsWith' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringNotInFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | 'StringNotIn' (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso namespaces/topics/eventSubscriptions se puede implementar con operaciones destinadas a:
- Grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.EventGrid/namespaces/topics/eventSubscriptions, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
deliveryConfiguration = {
deliveryMode = "string"
push = {
deadLetterDestinationWithResourceIdentity = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
deliveryWithResourceIdentity = {
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
eventTimeToLive = "string"
maxDeliveryCount = int
}
queue = {
deadLetterDestinationWithResourceIdentity = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
eventTimeToLive = "string"
maxDeliveryCount = int
receiveLockDurationInSeconds = int
}
}
eventDeliverySchema = "CloudEventSchemaV1_0"
filtersConfiguration = {
filters = [
{
key = "string"
operatorType = "string"
// For remaining properties, see Filter objects
}
]
includedEventTypes = [
"string"
]
}
}
})
}
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 la propiedad type para especificar el tipo de objeto.
Para Dynamic, use:
type = "Dynamic"
properties = {
sourceField = "string"
}
Para Static, use:
type = "Static"
properties = {
isSecret = bool
value = "string"
}
Filtrar objetos
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
namespaces/topics/eventSubscriptions
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview" |
| name | El nombre del recurso | string (obligatorio) |
| parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: temas |
| properties | Propiedades de la suscripción de eventos. | SubscriptionProperties |
SubscriptionProperties
| Nombre | Descripción | Valor |
|---|---|---|
| deliveryConfiguration | Información sobre la configuración de entrega de la suscripción de eventos. | DeliveryConfiguration |
| eventDeliverySchema | Esquema de entrega de eventos para la suscripción de eventos. | "CloudEventSchemaV1_0" |
| filtersConfiguration | Información sobre el filtro de la suscripción de eventos. | FiltersConfiguration |
DeliveryConfiguration
| Nombre | Descripción | Valor |
|---|---|---|
| deliveryMode | Modo de entrega de la suscripción de eventos. | "Push" "Cola" |
| push | Esta propiedad debe rellenarse cuando deliveryMode se inserta y representa información sobre la suscripción de inserción. | PushInfo |
| cola | Esta propiedad debe rellenarse cuando deliveryMode está en cola y representa información sobre la suscripción de cola. | QueueInfo |
PushInfo
| Nombre | Descripción | Valor |
|---|---|---|
| deadLetterDestinationWithResourceIdentity | 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, el espacio de nombres) para adquirir los tokens de autenticación que se usan durante la entrega o los 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 los mensajes fallidos. |
DeliveryWithResourceIdentity |
| eventTimeToLive | Duración del intervalo de tiempo en formato ISO 8601 que determina cuánto tiempo están disponibles los mensajes para la suscripción a partir del momento en que se publicó el mensaje. Este valor de duración se expresa con el siguiente formato: "P(n)Y(n)M(n)DT(n)H(n)M(n)S", donde: - (n) se reemplaza por el valor de cada elemento de hora que sigue a (n). - P es el designador de duración (o período) y siempre se coloca al principio de la duración. - Y es el designador de año y sigue el valor del número de años. - M es el designador de mes y sigue el valor del número de meses. - W es el designador de semana y sigue el valor del número de semanas. - D es el designador de día y sigue el valor del número de días. - T es el designador de tiempo y precede a los componentes de hora. - H es el designador de hora y sigue el valor del número de horas. - M es el designador de minutos y sigue el valor del número de minutos. - S es el segundo designador y sigue el valor del número de segundos. Este valor de duración no se puede establecer mayor que eventRetentionInDays del tema. Es un campo opcional donde su valor mínimo es de 1 minuto y se determina su máximo. por el valor EventRetentionInDays del tema. A continuación se muestran ejemplos de valores válidos: - "P0DT23H12M" o "PT23H12M": durante 23 horas y 12 minutos. - "P1D" o "P1DT0H0M0S": durante 1 día. |
string |
| maxDeliveryCount | Número máximo de entregas de los eventos. | int |
DeadLetterWithResourceIdentity
| Nombre | Descripción | Valor |
|---|---|---|
| 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 o los mensajes fallidos. |
DeadLetterDestination |
| identidad | Identidad que se va a usar cuando se produzcan mensajes fallidos. | EventSubscriptionIdentity |
DeadLetterDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Establecimiento del tipo de objeto | StorageBlob (obligatorio) |
StorageBlobDeadLetterDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Tipo del punto de conexión para el destino de mensajes fallidos | "StorageBlob" (obligatorio) |
| properties | Las propiedades del destino de la instancia de Storage Blob based deadletter | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Nombre | Descripción | Valor |
|---|---|---|
| blobContainerName | Nombre del contenedor de blobs de Storage que es el destino de los eventos de mensajes fallidos. | string |
| resourceId | El identificador de recurso de Azure de la cuenta de almacenamiento que es el destino de los eventos fallidos. | string |
EventSubscriptionIdentity
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad. | "SystemAssigned" "UserAssigned" |
| userAssignedIdentity | Identidad de usuario asociada al recurso. | string |
DeliveryWithResourceIdentity
| Nombre | Descripción | Valor |
|---|---|---|
| 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 los mensajes fallidos. |
EventSubscriptionDestination |
| identidad | Identidad que se va a usar al entregar eventos. | EventSubscriptionIdentity |
EventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Establecimiento del tipo de objeto | AzureFunction EventHub HybridConnection MonitorAlert Espacio de nombresTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook (obligatorio) |
AzureFunctionEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
DeliveryAttributeMapping
| Nombre | Descripción | Value |
|---|---|---|
| name | Nombre del atributo o encabezado de entrega. | string |
| type | Establecimiento del tipo de objeto | Dinámica Estático (obligatorio) |
DynamicDeliveryAttributeMapping
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo del atributo de entrega o el nombre del encabezado. | "Dinámico" (obligatorio) |
| properties | Propiedades de la asignación de atributos de entrega dinámica. | DynamicDeliveryAttributeMappingProperties |
DynamicDeliveryAttributeMappingProperties
| Nombre | Descripción | Valor |
|---|---|---|
| sourceField | Ruta de acceso JSON en el evento que contiene el valor del atributo. | string |
StaticDeliveryAttributeMapping
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo del atributo de entrega o el nombre del encabezado. | "Estático" (obligatorio) |
| properties | Propiedades de la asignación de atributos de entrega estática. | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
| Nombre | Descripción | Valor |
|---|---|---|
| isSecret | Marca booleana para indicar si el atributo contiene información confidencial. | bool |
| value | Valor del atributo de entrega. | string |
EventHubEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
HybridConnectionEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
MonitorAlertEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | 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 que aparece 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 |
PartnerEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | 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 |
ServiceBusQueueEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| 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. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
| Nombre | Descripción | Valor |
|---|---|---|
| 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 |
StorageQueueEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| queueMessageTimeToLiveInSeconds | Tiempo de vida del mensaje de la 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 |
WebHookEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| 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
| Nombre | Descripción | Valor |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | Identificador o URI de aplicación de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. | string |
| azureActiveDirectoryTenantId | Identificador de inquilino de Azure Active Directory 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 Restricciones: 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 |
QueueInfo
| Nombre | Descripción | Valor |
|---|---|---|
| deadLetterDestinationWithResourceIdentity | 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) para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos. |
DeadLetterWithResourceIdentity |
| eventTimeToLive | Duración del intervalo de tiempo en formato ISO 8601 que determina cuánto tiempo están disponibles los mensajes para la suscripción desde el momento en que se publicó el mensaje. Este valor de duración se expresa con el siguiente formato: "P(n)Y(n)M(n)DT(n)H(n)M(n)S", donde: - (n) se reemplaza por el valor de cada elemento de tiempo que sigue a (n). - P es el designador de duración (o período) y siempre se coloca al principio de la duración. - Y es el designador de año y sigue el valor del número de años. - M es el designador de mes y sigue el valor del número de meses. - W es el designador de semana y sigue el valor del número de semanas. - D es el designador de día y sigue el valor del número de días. - T es el designador de tiempo y precede a los componentes de hora. - H es el designador de hora y sigue el valor del número de horas. - M es el designador de minutos y sigue el valor del número de minutos. - S es el segundo designador y sigue el valor del número de segundos. Este valor de duración no se puede establecer mayor que EventRetentionInDays del tema. Es un campo opcional donde su valor mínimo es de 1 minuto y se determina su máximo. por el valor EventRetentionInDays del tema. A continuación se muestran ejemplos de valores válidos: - "P0DT23H12M" o "PT23H12M": durante 23 horas y 12 minutos. - "P1D" o "P1DT0H0M0S": durante 1 día. |
string |
| maxDeliveryCount | Recuento máximo de entregas de los eventos. | int |
| receiveLockDurationInSeconds | Período máximo en segundos en el que el estado recibido (por el cliente) recibe el mensaje y espera a ser aceptado, liberado o rechazado. Si este tiempo transcurrido después de que el cliente haya recibido un mensaje y no haya pasado a aceptado (no procesado), liberado o rechazado, el mensaje está disponible para la reelivery. Se trata de un campo opcional, donde el valor predeterminado es de 60 segundos, el mínimo es de 60 segundos y el máximo es de 300 segundos. |
int |
FiltersConfiguration
| Nombre | Descripción | Valor |
|---|---|---|
| filters | Matriz de filtros que se usan para filtrar suscripciones de eventos. | Filtro[] |
| 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[] |
Filtrar
| Nombre | Descripción | Valor |
|---|---|---|
| key | Campo o propiedad en el evento en función del cual desea filtrar. | string |
| operatorType | Establecimiento del tipo de objeto | BoolEquals IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (obligatorio) |
BoolEqualsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "BoolEquals" (obligatorio) |
| value | Valor de filtro booleano. | bool |
IsNotNullFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "IsNotNull" (obligatorio) |
IsNullOrUndefinedFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "IsNullOrUndefined" (obligatorio) |
NumberGreaterThanFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "NumberGreaterThan" (obligatorio) |
| value | El valor de filtro. | int |
NumberGreaterThanOrEqualsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "NumberGreaterThanOrEquals" (obligatorio) |
| value | El valor de filtro. | int |
NumberInFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "NumberIn" (obligatorio) |
| valores | Conjunto de valores de filtro. | int[] |
NumberInRangeFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "NumberInRange" (obligatorio) |
| valores | Conjunto de valores de filtro. | int[][] |
NumberLessThanFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "NumberLessThan" (obligatorio) |
| value | El valor de filtro. | int |
NumberLessThanOrEqualsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "NumberLessThanOrEquals" (obligatorio) |
| value | El valor de filtro. | int |
NumberNotInFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "NumberNotIn" (obligatorio) |
| valores | Conjunto de valores de filtro. | int[] |
NumberNotInRangeFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "NumberNotInRange" (obligatorio) |
| valores | Conjunto de valores de filtro. | int[][] |
StringBeginsWithFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "StringBeginsWith" (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringContainsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "StringContains" (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringEndsWithFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "StringEndsWith" (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringInFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "StringIn" (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringNotBeginsWithFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "StringNotBeginsWith" (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringNotContainsFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "StringNotContains" (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringNotEndsWithFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "StringNotEndsWith" (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |
StringNotInFilter
| Nombre | Descripción | Valor |
|---|---|---|
| operatorType | Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros. | "StringNotIn" (obligatorio) |
| valores | Conjunto de valores de filtro. | string[] |