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

Управление API Azure в качестве источника сетки событий

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

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

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

Тип события Описание
Microsoft.ApiManagement.UserCreated Вызывается при создании пользователя.
Microsoft.ApiManagement.UserUpdated Вызывается при обновлении пользователя.
Microsoft.ApiManagement.ПользовательУдалён Вызывается при удалении пользователя.
Microsoft.ApiManagement.APICreated Вызывается при создании API.
Обновление API Microsoft.ApiManagement Вызывается при обновлении API.
Microsoft.ApiManagement.APIDeleted Вызывается при удалении API.
Microsoft.ApiManagement.ProductCreated Вызывается при создании продукта.
Microsoft.ApiManagement.ProductUpdated Вызывается при обновлении продукта.
Microsoft.ApiManagement.ProductDeleted Вызывается при удалении продукта.
Microsoft.ApiManagement.APIReleaseCreated Вызывается при создании выпуска API.
Microsoft.ApiManagement.APIReleaseUpdated Инициируется при обновлении версии API.
Удалён Microsoft.ApiManagement.APIRelease Вызывается при удалении выпуска API.
Microsoft.ApiManagement.ПодпискаСоздана Вызывается при создании подписки.
Microsoft.ApiManagement.ОбновлениеПодписки Вызывается при обновлении подписки.
Microsoft.ApiManagement.SubscriptionDeleted Вызывается при удалении подписки.
Microsoft.ApiManagement.GatewayCreated Вызывается при создании локального шлюза.
Microsoft.ApiManagement.ШлюзУдалён Вызывается при обновлении локального шлюза.
Microsoft.ApiManagement.GatewayUpdated Вызывается при удалении самостоятельно размещённого шлюза.
Microsoft.ApiManagement.GatewayAPIAdded Вызывается при добавлении API в локальный шлюз.
Microsoft.ApiManagement.GatewayAPI Delete Вызывается при удалении API из локального шлюза.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Вызывается при обновлении центра сертификации для локального шлюза.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Вызывается при удалении центра сертификации для локального шлюза.
Microsoft.ApiManagement.ОбновленЦентрСертификацииШлюза Вызывается при обновлении центра сертификации для локального шлюза.
Microsoft.ApiManagement.ГостеваяКонфигурацияИменованияШлюзаСоздана Вызывается при создании конфигурации имени узла для локального шлюза.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Сигнализируется при удалении конфигурации имени узла для самостоятельно размещённого шлюза.
Microsoft.ApiManagement.ОбновленаКонфигурацияИмениХостаШлюза Вызывается при обновлении конфигурации имени узла для локального шлюза.
Microsoft.ApiManagement.GatewayTokenNearExpiry (предварительная версия) Вызывается, когда токен доступа к самоуправляемому шлюзу приближается к истечению срока действия.
Microsoft.ApiManagement.GatewayTokenExpired (предварительная версия) Вызывается при истечении срока действия маркера доступа к самостоятельно размещенному шлюзу.
Microsoft.ApiManagement.CircuitBreaker.Opened (предварительная версия) Вызывается при открытии серверного выключателя.
Microsoft.ApiManagement.CircuitBreaker.Closed (предварительная версия) Вызывается при закрытии серверного выключателя.

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

В следующем примере показана схема события создания продукта. Схема других событий создания ресурса управления 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
}]

В следующем примере показана схема события, связанного с срабатыванием автоматического выключателя.

{
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/backends/{backend-name}/circuit-breaker/rules/{rule-name}",
  "type": "Microsoft.ApiManagement.CircuitBreaker.Opened",
  "time": "2025-04-02T00:47:47.8536532Z",
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "data": {
    "backendName": "{backend-name}",
    "circuitBreaker": {
      "rules": {
        "{rule-name}": {
          "tripDuration": "00:00:01"
        }
      }
    }
  },
  "specVersion": "1.0"
}

В следующем примере показана схема события с истекшим сроком действия маркера шлюза. Схема события почти истекающего срока действия маркера шлюза похожа, но заменяет свойство expiresAtUtc на свойство expiredAtUtc.

{
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/gateways/{gateway-name}/{instance-name}",
  "type": "Microsoft.ApiManagement.GatewayTokenExpired",
  "time": "2025-04-02T00:47:47.8536532Z",
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "data": {
    "gatewayInfo": {
      "gatewayId": "{gateway-name}",
      "instanceId": "{instance-name}"
    },
    "tokenInfo": {
      "expiredAtUtc": "2025-02-25T08:56:00.0000000Z"
    }
  },
  "specVersion": "1.0"
}

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

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

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

Свойства объекта данных

События контрольной плоскости

Объект data имеет следующие свойства для событий плоскости управления, таких как создание, обновление и удаление ресурсов управления API.

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

События разбиения цепи

Объект data имеет следующие свойства для событий разбиения цепи.

Недвижимость Тип Описание
backendNme струна Имя (идентификатор) серверной сущности, в которой настроен выключатель.
circuitBreaker объект Автоматический выключатель цепи, настроенный в серверной части, состоит из rules объекта, указывающего правило, которое привело к срабатыванию серверной части. Правило имеет tripDuration свойство в формате hh:mm:ss, указывающее длительность, на которую срабатывает автоматический выключатель.

События маркера проверки подлинности локального шлюза

Объект data имеет следующие свойства для событий токена аутентификации самостоятельно размещенного шлюза.

Недвижимость Тип Описание
gatewayInfo объект Сведения о локальном шлюзе, состоящие из следующих строковых свойств:

* gatewayId — полный квалифицированный идентификатор ресурса шлюза
* instanceId — уникальный идентификатор экземпляра развернутого шлюза
tokenInfo объект Информация о токене, состоящая из одного из следующих свойств в UTC-времени поставщика:

* expiresAtUtc — для GatewayTokenNearExpiry события или
* expiredAtUtc - для GatewayTokenExpired события

Учебники и инструкции

Название Описание
Отправка событий из службы "Управление API" в сетку событий Как подписаться на события управления API с помощью сетки событий.

Дальнейшие шаги

  • Last updated on