Поделиться через

Центр API Azure в качестве источника сетки событий (предварительная версия)

  • Статья

Эта статья содержит свойства и схему для событий Центра API Azure. Общие сведения о схемах событий см. в статье Схема событий службы "Сетка событий Azure".

Примечание.

Эта функция в настоящее время доступна для предварительного ознакомления.

Доступные типы событий

Эти события активируются при добавлении или обновлении определения API клиентом.

Имя события Description
Microsoft.ApiCenter.ApiDefinitionAdded Активируется при добавлении определения API в центр API.
Microsoft.ApiCenter.ApiDefinitionUpdated Активируется при обновлении определения API в центре API.

Пример события

При активации события служба Центра API отправляет данные об этом событии в подписку конечной точке. В этом разделе содержится пример того, как выглядят эти данные для каждого события Центра API.

Событие 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"
}]

Событие 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"
}]

Свойства событий

Событие содержит следующие высокоуровневые данные:

Свойство Type Описание:
source строка Полный путь к ресурсу источника событий. Это поле защищено от записи. Это значение предоставляет Сетка событий.
subject строка Определенный издателем путь к субъекту события.
type строка Один из зарегистрированных типов событий для этого источника событий.
time строка Время создания события с учетом времени поставщика в формате UTC.
id строка Уникальный идентификатор события.
data объект Данные событий Центра API Azure.
specversion строка Версия спецификации схемы CloudEvents.

Объект данных имеет следующие свойства:

Свойство Type Описание:
title строка Заголовок определения API.
description строка Описание определения API.
specification строка Свойства спецификации API, состоящие из name (имя спецификации) и version (версия спецификации)

Практические руководства и другие учебные материалы

Заголовок Description
Включение встраивание и анализ для управления API в центре API Используйте события сетки событий, чтобы активировать подкладку для анализа определений API в центре API.

Связанный контент