Compartir vía

Azure API Management como origen de Event Grid

  • Artículo

En este artículo se proporcionan las propiedades y el esquema de los eventos de Azure API Management. Para una introducción a los esquemas de eventos, consulte Esquema de eventos de Azure Event Grid. También se proporcionan vínculos a artículos para usar API Management como origen de eventos.

Tipos de eventos disponibles

API Management emite los siguientes tipos de eventos:

Tipo de evento Descripción
Microsoft.ApiManagement.UserCreated Se genera cuando se crea un usuario.
Microsoft.ApiManagement.UserUpdated Se genera cuando se actualiza un usuario.
Microsoft.ApiManagement.UserDeleted Se genera cuando se elimina un usuario.
Microsoft.ApiManagement.APICreated Se genera cuando se crea una API.
Microsoft.ApiManagement.APIUpdated Se genera cuando se actualiza una API.
Microsoft.ApiManagement.APIDeleted Se genera cuando se elimina una API.
Microsoft.ApiManagement.ProductCreated Se genera cuando se crea un producto.
Microsoft.ApiManagement.ProductUpdated Se genera cuando se actualiza un producto.
Microsoft.ApiManagement.ProductDeleted Se genera cuando se elimina un producto.
Microsoft.ApiManagement.ReleaseCreated Se genera cuando se crea una versión de API.
Microsoft.ApiManagement.ReleaseUpdated Se genera cuando se actualiza una versión de API.
Microsoft.ApiManagement.ReleaseDeleted Se genera cuando se elimina una versión de API.
Microsoft.ApiManagement.SubscriptionCreated Se genera cuando se crea una suscripción.
Microsoft.ApiManagement.SubscriptionUpdated Se genera cuando se actualiza una suscripción.
Microsoft.ApiManagement.SubscriptionDeleted Se genera cuando se elimina una suscripción.
Microsoft.ApiManagement.GatewayCreated Se genera cuando se crea una puerta de enlace autohospedada.
Microsoft.ApiManagement.GatewayDeleted Se genera cuando se actualiza una puerta de enlace autohospedada.
Microsoft.ApiManagement.GatewayUpdated Se genera cuando se elimina una puerta de enlace autohospedada.
Microsoft.ApiManagement.GatewayAPIAdded Se genera cuando se ha quitado una API de una puerta de enlace autohospedada.
Microsoft.ApiManagement.GatewayAPIRemoved Se genera cuando se ha quitado una API de una puerta de enlace autohospedada.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Se genera cuando se ha actualizado una entidad de certificación para una puerta de enlace autohospedada.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Se genera cuando se ha eliminado una entidad de certificación para una puerta de enlace autohospedada.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Se genera cuando se ha actualizado una entidad de certificación para una puerta de enlace autohospedada.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Se genera cuando se ha creado una configuración de nombre de host para una puerta de enlace autohospedada.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Se genera cuando se ha eliminado una configuración de nombre de host para una puerta de enlace autohospedada.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Se genera cuando se ha actualizado una configuración de nombre de host para una puerta de enlace autohospedada.

Evento de ejemplo

En el ejemplo siguiente se muestra el esquema de un evento de producto creado. El esquema de otros eventos de recurso creado de API Management es similar.

[{
  "id": "81dac958-49cf-487e-8805-d0baf0ee485a",
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/products/myproduct",
  "data": {
    "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/products/myproduct"
  },
  "Type": "Microsoft.ApiManagement.ProductCreated",
  "Time": "2021-07-02T00:38:44.3978295Z",
  "specversion":"1.0"
}]

En el ejemplo siguiente se muestra el esquema de un evento de usuario eliminado. El esquema de otros eventos de recurso eliminado de API Management es similar.

[{
  "id": "81dac958-49cf-487e-8805-d0baf0ee485a",
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/users/apimuser-contoso-com",
  "data": {
    "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/users/apimuser-contoso-com"
  },
  "Type": "Microsoft.ApiManagement.UserDeleted",
  "Time": "2021-07-02T00:38:44.3978295Z",
  "specversion":"1.0"
}]

En el ejemplo siguiente se muestra el esquema de un evento de API actualizada. El esquema de otros eventos de recurso actualizado de API Management es similar.

[{
  "id": "95015754-aa51-4eb6-98d9-9ee322b82ad7",
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/apis/myapi;Rev=1",
  "data": {
    "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/apis/myapi;Rev=1"
  },
  "Type": "Microsoft.ApiManagement.APIUpdated",
  "Time": "2021-07-12T23:13:44.9048323Z",
  "specversion":1.0
}]

Propiedades de evento

Un evento tiene los siguientes datos de nivel superior:

Propiedad Tipo Description
source string Ruta de acceso completa a los recursos del origen del evento. En este campo no se puede escribir. Event Grid proporciona este valor.
subject string Ruta al asunto del evento definida por el anunciante.
type string Uno de los tipos de eventos registrados para este origen de eventos.
time string La hora de generación del evento en función de la hora UTC del proveedor.
id string Identificador único para el evento
data object Datos de eventos de API Management.
specversion string Versión de especificación del esquema CloudEvents.

El objeto data tiene las siguientes propiedades:

Propiedad Tipo Description
resourceUri string Id. completo del recurso para el que se cambia el estado de cumplimiento, incluido el nombre del recurso y el tipo de recurso. Usa el formato /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Tutoriales y procedimientos

Título Descripción
Envío de eventos de API Management a Event Grid Procedimiento para suscribirse a eventos de API Management mediante Event Grid.

Pasos siguientes