Compartir vía

Centro de API de Azure como origen de Event Grid (versión preliminar)

  • Artículo

En este artículo se proporcionan las propiedades y el esquema de los eventos del Centro de API de Azure. Para una introducción a los esquemas de eventos, consulte Esquema de eventos de Azure Event Grid.

Nota:

Esta funcionalidad actualmente está en su versión preliminar.

Tipos de eventos disponibles

Estos eventos se desencadenan cuando un cliente agrega o actualiza una definición de API.

Nombre del evento Descripción
Microsoft.ApiCenter.ApiDefinitionAdded Se desencadena cuando se agrega una definición de API en un centro de API.
Microsoft.ApiCenter.ApiDefinitionUpdated Se desencadena cuando se agrega una definición de API en un centro de API.

Evento de ejemplo

Cuando se desencadena un evento, el servicio del Centro de API envía datos sobre ese evento al punto de conexión de suscripción. Esta sección contiene un ejemplo de cómo se verían los datos para cada evento del Centro de API.

Evento Microsoft.ApiCenter.ApiDefinitionAdded

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionAdded",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "specversion": "1.0"
}]

Evento Microsoft.ApiCenter.ApiDefinitionUpdated

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionUpdated",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "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 del Centro de API de Azure.
specversion string Versión de especificación del esquema CloudEvents.

El objeto data tiene las siguientes propiedades:

Propiedad Tipo Description
title string Título de la definición de API.
description string Descripción de la definición de API.
specification string Las propiedades de especificación de API, que constan de name (nombre de especificación) y version (versión de especificación)

Tutoriales y procedimientos

Título Descripción
Habilitación de linting y análisis para la gobernanza de API en el centro de API Use eventos de Event Grid para desencadenar linting para analizar las definiciones de API en el centro de API.

Contenido relacionado