Использование Управления API в качестве источника Сетки событий

  • Статья

В этой статье описаны свойства и схема для событий службы Управление API Azure. Общие сведения о схемах событий см. в статье Схема событий службы "Сетка событий Azure". Здесь также приведены ссылки на статьи, посвященные использованию службы "Управление API" в качестве источника событий.

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

Служба "Управление API"выдает следующие типы событий:

Тип события Description
Microsoft.ApiManagement.UserCreated Возникает при создании пользователя.
Microsoft.ApiManagement.UserUpdated Возникает при обновлении пользователя.
Microsoft.ApiManagement.UserDeleted Возникает при удалении пользователя.
Microsoft.ApiManagement.APICreated Возникает при создании API.
Microsoft.ApiManagement.APIUpdated Возникает при обновлении API.
Microsoft.ApiManagement.APIDeleted Возникает при удалении API.
Microsoft.ApiManagement.ProductCreated Возникает при создании продукта.
Microsoft.ApiManagement.ProductUpdated Возникает при обновлении продукта.
Microsoft.ApiManagement.ProductDeleted Возникает при удалении продукта.
Microsoft.ApiManagement.ReleaseCreated Возникает при создании выпуска API.
Microsoft.ApiManagement.ReleaseUpdated Возникает при обновлении выпуска API.
Microsoft.ApiManagement.ReleaseDeleted Возникает при удалении выпуска API.
Microsoft.ApiManagement.SubscriptionCreated Возникает при создании подписки.
Microsoft.ApiManagement.SubscriptionUpdated Возникает при обновлении подписки.
Microsoft.ApiManagement.SubscriptionDeleted Возникает при удалении подписки.
Microsoft.ApiManagement.GatewayCreated Вызывается при создании локального шлюза.
Microsoft.ApiManagement.GatewayDeleted Вызывается при обновлении локального шлюза.
Microsoft.ApiManagement.GatewayUpdated Вызывается при удалении локального шлюза.
Microsoft.ApiManagement.GatewayAPIAdded Вызывается при удалении API из локального шлюза.
Microsoft.ApiManagement.GatewayAPI Delete Вызывается при удалении API из локального шлюза.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Вызывается при обновлении центра сертификации для локального размещения.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Вызывается при удалении центра сертификации для локального размещения.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Вызывается при обновлении центра сертификации для локального размещения.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Вызывается при создании конфигурации имени узла для локального размещения.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Вызывается при удалении конфигурации имени узла для локального размещения.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Вызывается при обновлении конфигурации имени узла для локального размещения.

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

В указанном ниже примере показана схема события создания продукта. Схема других событий создания ресурсов службы "Управление API" аналогична.

[{
  "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"
}]

В примере ниже показана схема события удаления пользователя. Схема других событий удаления ресурсов службы "Управление API" аналогична.

[{
  "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"
}]

В примере ниже показана схема события обновления API. Схема других событий обновления ресурсов службы "Управление API" аналогична.

[{
  "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
}]

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

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

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

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

Свойство Type Описание:
resourceUri строка Полный идентификатор ресурса, состояние соответствия требованиям которого изменяется, содержит имя и тип ресурса. Использует формат /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

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

Заголовок Description
Отправка событий из Azure API Management в Сетку событий Сведения об оформлении подписки на события службы "Управление API" с помощью Сетки событий.

Следующие шаги