Compartir a través de

Event Subscriptions - Get

  • Referencia
Servicio:
Event Grid
Versión de la API:
2025-02-15

Obtenga una suscripción de eventos.
Obtiene las propiedades de una suscripción de eventos.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
eventSubscriptionName
 path True

string

Nombre de la suscripción de eventos que se va a encontrar.
scope
 path True

string

Ámbito de la suscripción de eventos. El ámbito puede ser una suscripción, un grupo de recursos o un recurso de nivel superior que pertenezca a un espacio de nombres del proveedor de recursos o un tema de EventGrid. Por ejemplo, use '/subscriptions/{subscriptionId}/' para una suscripción, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para un grupo de recursos, y '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para un recurso y '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para un tema de EventGrid.
api-version
 query True

string

Versión de la API que se va a usar con la solicitud de cliente.

Respuestas

Nombre Tipo Description
200 OK

EventSubscription

De acuerdo
Other Status Codes

Respuestas de error: ***

  • 400 Solicitud incorrecta.

  • Error interno del servidor 500.

Ejemplos

EventSubscriptions_GetForCustomTopic
EventSubscriptions_GetForCustomTopic_AzureFunctionDestination
EventSubscriptions_GetForCustomTopic_EventHubDestination
EventSubscriptions_GetForCustomTopic_HybridConnectionDestination
EventSubscriptions_GetForCustomTopic_ServiceBusQueueDestination
EventSubscriptions_GetForCustomTopic_ServiceBusTopicDestination
EventSubscriptions_GetForCustomTopic_StorageQueueDestination
EventSubscriptions_GetForCustomTopic_WebhookDestination
EventSubscriptions_GetForResource
EventSubscriptions_GetForResourceGroup
EventSubscriptions_GetForSubscription

EventSubscriptions_GetForCustomTopic

Solicitud de ejemplo

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

Respuesta de muestra

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

EventSubscriptions_GetForCustomTopic_AzureFunctionDestination

Solicitud de ejemplo

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

Respuesta de muestra

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

EventSubscriptions_GetForCustomTopic_EventHubDestination

Solicitud de ejemplo

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

Respuesta de muestra

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

EventSubscriptions_GetForCustomTopic_HybridConnectionDestination

Solicitud de ejemplo

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

Respuesta de muestra

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

EventSubscriptions_GetForCustomTopic_ServiceBusQueueDestination

Solicitud de ejemplo

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

Respuesta de muestra

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

EventSubscriptions_GetForCustomTopic_ServiceBusTopicDestination

Solicitud de ejemplo

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

Respuesta de muestra

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

EventSubscriptions_GetForCustomTopic_StorageQueueDestination

Solicitud de ejemplo

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

Respuesta de muestra

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

EventSubscriptions_GetForCustomTopic_WebhookDestination

Solicitud de ejemplo

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

Respuesta de muestra

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

EventSubscriptions_GetForResource

Solicitud de ejemplo

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

Respuesta de muestra

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

EventSubscriptions_GetForResourceGroup

Solicitud de ejemplo

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

Respuesta de muestra

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

EventSubscriptions_GetForSubscription

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
AzureFunctionEventSubscriptionDestination

Información sobre el destino de la función de Azure para una suscripción de eventos.
BoolEqualsAdvancedFilter

Filtro avanzado boolEquals.
createdByType

Tipo de identidad que creó el recurso.
DeadLetterWithResourceIdentity

Información sobre el destino de deadletter con la identidad del recurso.
DeliveryWithResourceIdentity

Información sobre la entrega de una suscripción de eventos con identidad de recurso.
DynamicDeliveryAttributeMapping

Detalles de asignación de atributos de entrega dinámica.
EventDeliverySchema

Esquema de entrega de eventos para la suscripción de eventos.
EventHubEventSubscriptionDestination

Información sobre el destino del centro de eventos para una suscripción de eventos.
EventSubscription

Suscripción de eventos.
EventSubscriptionFilter

Filtre por la suscripción de eventos.
EventSubscriptionIdentity

Información de identidad con la suscripción de eventos.
EventSubscriptionIdentityType

Tipo de identidad administrada usada. Puede ser "SystemAssigned" o "UserAssigned".
EventSubscriptionProvisioningState

Estado de aprovisionamiento de la suscripción de eventos.
HybridConnectionEventSubscriptionDestination

Información sobre el destino de HybridConnection para una suscripción de eventos.
IsNotNullAdvancedFilter

Filtro avanzado IsNotNull.
IsNullOrUndefinedAdvancedFilter

Filtro avanzado IsNullOrUndefined.
MonitorAlertEventSubscriptionDestination

Información sobre el destino de la alerta de supervisión de una suscripción de eventos.
MonitorAlertSeverity

Gravedad que se asociará a cada alerta desencadenada a través de esta suscripción de eventos. Este campo debe proporcionarse.
NamespaceTopicEventSubscriptionDestination

Información sobre el destino del tema de espacio de nombres para una suscripción de eventos.
NumberGreaterThanAdvancedFilter

NumberGreaterThan Advanced Filter.
NumberGreaterThanOrEqualsAdvancedFilter

Filtro avanzado NumberGreaterThanOrEquals.
NumberInAdvancedFilter

Filtro avanzado NumberIn.
NumberInRangeAdvancedFilter

Filtro avanzado NumberInRange.
NumberLessThanAdvancedFilter

Filtro avanzado NumberLessThan.
NumberLessThanOrEqualsAdvancedFilter

Filtro avanzado NumberLessThanOrEquals.
NumberNotInAdvancedFilter

Filtro avanzado NumberNotIn.
NumberNotInRangeAdvancedFilter

Filtro avanzado NumberNotInRange.
RetryPolicy

Información sobre la directiva de reintento de una suscripción de eventos.
ServiceBusQueueEventSubscriptionDestination

Información sobre el destino de Service Bus para una suscripción de eventos.
ServiceBusTopicEventSubscriptionDestination

Información sobre el destino del tema de Service Bus para una suscripción de eventos.
StaticDeliveryAttributeMapping

Detalles de asignación de atributos de entrega estática.
StorageBlobDeadLetterDestination

Información sobre el destino de mensajes fallidos basado en blobs de almacenamiento.
StorageQueueEventSubscriptionDestination

Información sobre el destino de la cola de almacenamiento para una suscripción de eventos.
StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter.
StringContainsAdvancedFilter

StringContains Advanced Filter.
StringEndsWithAdvancedFilter

StringEndsWith Advanced Filter.
StringInAdvancedFilter

Filtro avanzado StringIn.
StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter.
StringNotContainsAdvancedFilter

StringNotContains Advanced Filter.
StringNotEndsWithAdvancedFilter

StringNotEndsWith Advanced Filter.
StringNotInAdvancedFilter

Filtro avanzado StringNotIn.
systemData

Metadatos relativos a la creación y última modificación del recurso.
TlsVersion

Versión mínima de TLS del publicador que permite publicar en este dominio
WebHookEventSubscriptionDestination

Información sobre el destino del webhook para una suscripción de eventos.

AzureFunctionEventSubscriptionDestination

Object

Información sobre el destino de la función de Azure para una suscripción de eventos.

Nombre Tipo Valor predeterminado Description
endpointType string:

AzureFunction

Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalles del atributo de entrega.
properties.maxEventsPerBatch

integer

1

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

integer

64

Tamaño de lote preferido en Kilobytes.
properties.resourceId

string

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.

BoolEqualsAdvancedFilter

Object

Filtro avanzado boolEquals.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

BoolEquals

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
value

boolean

Valor de filtro booleano.

createdByType

Enumeration

Tipo de identidad que creó el recurso.

Valor Description
Application
Key
ManagedIdentity
User

DeadLetterWithResourceIdentity

Object

Información sobre el destino de deadletter con la identidad del recurso.

Nombre Tipo Description
deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

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.
identity

EventSubscriptionIdentity

Identidad que se va a usar cuando se produzcan eventos de mensajes fallidos.

DeliveryWithResourceIdentity

Object

Información sobre la entrega de una suscripción de eventos con identidad de recurso.

Nombre Tipo Description
destination EventSubscriptionDestination:

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.
identity

EventSubscriptionIdentity

Identidad que se va a usar al entregar eventos.

DynamicDeliveryAttributeMapping

Object

Detalles de asignación de atributos de entrega dinámica.

Nombre Tipo Description
name

string

Nombre del atributo o encabezado de entrega.
properties.sourceField

string

Ruta de acceso JSON en el evento que contiene el valor del atributo.
type string:

Dynamic

Tipo del atributo de entrega o nombre de encabezado.

EventDeliverySchema

Enumeration

Esquema de entrega de eventos para la suscripción de eventos.

Valor Description
CloudEventSchemaV1_0
CustomInputSchema
EventGridSchema

EventHubEventSubscriptionDestination

Object

Información sobre el destino del centro de eventos para una suscripción de eventos.

Nombre Tipo Description
endpointType string:

EventHub

Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalles del atributo de entrega.
properties.resourceId

string

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.

EventSubscription

Object

Suscripción de eventos.

Nombre Tipo Valor predeterminado Description
id

string

Identificador completo del recurso.
name

string

Nombre del recurso.
properties.deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

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.
properties.deadLetterWithResourceIdentity

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.
properties.deliveryWithResourceIdentity

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.
properties.destination EventSubscriptionDestination:

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.
properties.eventDeliverySchema

EventDeliverySchema

EventGridSchema

Esquema de entrega de eventos para la suscripción de eventos.
properties.expirationTimeUtc

string

Hora de expiración de la suscripción de eventos.
properties.filter

EventSubscriptionFilter

Información sobre el filtro de la suscripción de eventos.
properties.labels

string[]

Lista de etiquetas definidas por el usuario.
properties.provisioningState

EventSubscriptionProvisioningState

Estado de aprovisionamiento de la suscripción de eventos.
properties.retryPolicy

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.
properties.topic

string

Nombre del tema de la suscripción de eventos.
systemData

systemData

Metadatos del sistema relacionados con el recurso de Event Grid.
type

string

Tipo del recurso.

EventSubscriptionFilter

Object

Filtre por la suscripción de eventos.

Nombre Tipo Valor predeterminado Description
advancedFilters AdvancedFilter[]:

Matriz de filtros avanzados que se usan para filtrar suscripciones de eventos.
enableAdvancedFilteringOnArrays

boolean

Permite evaluar filtros avanzados en una matriz de valores en lugar de esperar un valor singular.
includedEventTypes

string[]

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.
isSubjectCaseSensitive

boolean

False

Especifica si las propiedades SubjectBeginsWith y SubjectEndsWith del filtro deben compararse de una manera que distingue mayúsculas de minúsculas.
subjectBeginsWith

string

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.
subjectEndsWith

string

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.

EventSubscriptionIdentity

Object

Información de identidad con la suscripción de eventos.

Nombre Tipo Description
type

EventSubscriptionIdentityType

Tipo de identidad administrada usada. Puede ser "SystemAssigned" o "UserAssigned".
userAssignedIdentity

string

Identidad de usuario asociada al recurso.

EventSubscriptionIdentityType

Enumeration

Tipo de identidad administrada usada. Puede ser "SystemAssigned" o "UserAssigned".

Valor Description
SystemAssigned
UserAssigned

EventSubscriptionProvisioningState

Enumeration

Estado de aprovisionamiento de la suscripción de eventos.

Valor Description
AwaitingManualAction
Canceled
Creating
Deleting
Failed
Succeeded
Updating

HybridConnectionEventSubscriptionDestination

Object

Información sobre el destino de HybridConnection para una suscripción de eventos.

Nombre Tipo Description
endpointType string:

HybridConnection

Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalles del atributo de entrega.
properties.resourceId

string

Identificador de recurso de Azure de una conexión híbrida que es el destino de una suscripción de eventos.

IsNotNullAdvancedFilter

Object

Filtro avanzado IsNotNull.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

IsNotNull

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.

IsNullOrUndefinedAdvancedFilter

Object

Filtro avanzado IsNullOrUndefined.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

IsNullOrUndefined

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.

MonitorAlertEventSubscriptionDestination

Object

Información sobre el destino de la alerta de supervisión de una suscripción de eventos.

Nombre Tipo Description
endpointType string:

MonitorAlert

Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.actionGroups

string[]

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}.
properties.description

string

Descripción que se asociará a cada alerta desencadenada a través de esta suscripción de eventos.
properties.severity

MonitorAlertSeverity

Gravedad que se asociará a cada alerta desencadenada a través de esta suscripción de eventos. Este campo debe proporcionarse.

MonitorAlertSeverity

Enumeration

Gravedad que se asociará a cada alerta desencadenada a través de esta suscripción de eventos. Este campo debe proporcionarse.

Valor Description
Sev0
Sev1
Sev2
Sev3
Sev4

NamespaceTopicEventSubscriptionDestination

Object

Información sobre el destino del tema de espacio de nombres para una suscripción de eventos.

Nombre Tipo Description
endpointType string:

NamespaceTopic

Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.resourceId

string

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}.

NumberGreaterThanAdvancedFilter

Object

NumberGreaterThan Advanced Filter.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

NumberGreaterThan

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
value

number

Valor de filtro.

NumberGreaterThanOrEqualsAdvancedFilter

Object

Filtro avanzado NumberGreaterThanOrEquals.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

NumberGreaterThanOrEquals

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
value

number

Valor de filtro.

NumberInAdvancedFilter

Object

Filtro avanzado NumberIn.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

NumberIn

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values

number[]

Conjunto de valores de filtro.

NumberInRangeAdvancedFilter

Object

Filtro avanzado NumberInRange.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

NumberInRange

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values

number[]

Conjunto de valores de filtro.

NumberLessThanAdvancedFilter

Object

Filtro avanzado NumberLessThan.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

NumberLessThan

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
value

number

Valor de filtro.

NumberLessThanOrEqualsAdvancedFilter

Object

Filtro avanzado NumberLessThanOrEquals.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

NumberLessThanOrEquals

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
value

number

Valor de filtro.

NumberNotInAdvancedFilter

Object

Filtro avanzado NumberNotIn.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

NumberNotIn

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values

number[]

Conjunto de valores de filtro.

NumberNotInRangeAdvancedFilter

Object

Filtro avanzado NumberNotInRange.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

NumberNotInRange

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values

number[]

Conjunto de valores de filtro.

RetryPolicy

Object

Información sobre la directiva de reintento de una suscripción de eventos.

Nombre Tipo Valor predeterminado Description
eventTimeToLiveInMinutes

integer

1440

Período de vida (en minutos) para eventos.
maxDeliveryAttempts

integer

30

Número máximo de reintentos de entrega para eventos.

ServiceBusQueueEventSubscriptionDestination

Object

Información sobre el destino de Service Bus para una suscripción de eventos.

Nombre Tipo Description
endpointType string:

ServiceBusQueue

Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalles del atributo de entrega.
properties.resourceId

string

Identificador de recurso de Azure que representa el punto de conexión del destino de Service Bus de una suscripción de eventos.

ServiceBusTopicEventSubscriptionDestination

Object

Información sobre el destino del tema de Service Bus para una suscripción de eventos.

Nombre Tipo Description
endpointType string:

ServiceBusTopic

Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalles del atributo de entrega.
properties.resourceId

string

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.

StaticDeliveryAttributeMapping

Object

Detalles de asignación de atributos de entrega estática.

Nombre Tipo Valor predeterminado Description
name

string

Nombre del atributo o encabezado de entrega.
properties.isSecret

boolean

False

Marca booleana para indicar si el atributo contiene información confidencial .
properties.value

string

Valor del atributo de entrega.
type string:

Static

Tipo del atributo de entrega o nombre de encabezado.

StorageBlobDeadLetterDestination

Object

Información sobre el destino de mensajes fallidos basado en blobs de almacenamiento.

Nombre Tipo Description
endpointType string:

StorageBlob

Tipo del punto de conexión para el destino de mensajes fallidos
properties.blobContainerName

string

Nombre del contenedor de blobs de Storage que es el destino de los eventos deadletter.
properties.resourceId

string

Identificador de recurso de Azure de la cuenta de almacenamiento que es el destino de los eventos deadletter.

StorageQueueEventSubscriptionDestination

Object

Información sobre el destino de la cola de almacenamiento para una suscripción de eventos.

Nombre Tipo Description
endpointType string:

StorageQueue

Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.queueMessageTimeToLiveInSeconds

integer

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.
properties.queueName

string

Nombre de la cola de Storage en una cuenta de almacenamiento que es el destino de una suscripción de eventos.
properties.resourceId

string

Identificador de recurso de Azure de la cuenta de almacenamiento que contiene la cola que es el destino de una suscripción de eventos.

StringBeginsWithAdvancedFilter

Object

StringBeginsWith Advanced Filter.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

StringBeginsWith

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values

string[]

Conjunto de valores de filtro.

StringContainsAdvancedFilter

Object

StringContains Advanced Filter.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

StringContains

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values

string[]

Conjunto de valores de filtro.

StringEndsWithAdvancedFilter

Object

StringEndsWith Advanced Filter.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

StringEndsWith

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values

string[]

Conjunto de valores de filtro.

StringInAdvancedFilter

Object

Filtro avanzado StringIn.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

StringIn

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values

string[]

Conjunto de valores de filtro.

StringNotBeginsWithAdvancedFilter

Object

StringNotBeginsWith Advanced Filter.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

StringNotBeginsWith

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values

string[]

Conjunto de valores de filtro.

StringNotContainsAdvancedFilter

Object

StringNotContains Advanced Filter.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

StringNotContains

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values

string[]

Conjunto de valores de filtro.

StringNotEndsWithAdvancedFilter

Object

StringNotEndsWith Advanced Filter.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

StringNotEndsWith

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values

string[]

Conjunto de valores de filtro.

StringNotInAdvancedFilter

Object

Filtro avanzado StringNotIn.

Nombre Tipo Description
key

string

Campo o propiedad del evento en función del cual desea filtrar.
operatorType string:

StringNotIn

Tipo de operador usado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values

string[]

Conjunto de valores de filtro.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC).
createdBy

string

Identidad que creó el recurso.
createdByType

createdByType

Tipo de identidad que creó el recurso.
lastModifiedAt

string

Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy

string

Identidad que modificó por última vez el recurso.
lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.

TlsVersion

Enumeration

Versión mínima de TLS del publicador que permite publicar en este dominio

Valor Description
1.0
1.1
1.2

WebHookEventSubscriptionDestination

Object

Información sobre el destino del webhook para una suscripción de eventos.

Nombre Tipo Valor predeterminado Description
endpointType string:

WebHook

Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.azureActiveDirectoryApplicationIdOrUri

string

Identificador de aplicación o URI de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega.
properties.azureActiveDirectoryTenantId

string

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.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalles del atributo de entrega.
properties.endpointBaseUrl

string

Dirección URL base que representa el punto de conexión del destino de una suscripción de eventos.
properties.endpointUrl

string

Dirección URL que representa el punto de conexión del destino de una suscripción de eventos.
properties.maxEventsPerBatch

integer

1

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

TlsVersion

Versión mínima de TLS que debe ser compatible con el punto de conexión de webhook
properties.preferredBatchSizeInKilobytes

integer

64

Tamaño de lote preferido en Kilobytes.