你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

将 Azure API 管理用作事件网格源

  • 项目

本文提供了 Azure API 管理事件的属性和架构。 有关事件架构的简介，请参阅 Azure 事件网格事件架构。 它还提供了使用 API 管理作为事件源的文章链接。

可用事件类型

API Management 发出以下事件类型：

事件类型 说明
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.GatewayAPIRemoved 从自托管网关中移除 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
}]

事件属性

事件具有以下顶级数据：

属性 类型​​ 说明
source string 事件源的完整资源路径。 此字段不可写入。 事件网格提供此值。
subject string 事件主题的发布者定义路径。
type string 此事件源的一个注册事件类型。
time string 基于提供程序 UTC 时间的事件生成时间。
id string 事件的唯一标识符。
data object API 管理事件数据。
specversion 字符串 CloudEvents 架构规范版本。

数据对象具有以下属性：

属性 类型​​ 说明
resourceUri string 符合性状态更改所针对的资源的完全限定 ID，包括资源名称和资源类型。 使用 /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName> 格式

教程和操作指南

标题 说明
将事件从 API 管理发送到事件网格 如何使用事件网格订阅 API 管理事件。

后续步骤