通过

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

将 Azure API 中心用作事件网格源（预览版）

  • 项目

本文提供了 Azure API 中心事件的属性和架构。 有关事件架构的简介，请参阅 Azure 事件网格事件架构。

注意

此功能目前处于预览状态。

可用事件类型

当客户端添加或更新 API 定义时，将触发这些事件。

事件名称 描述
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"
}]

事件属性

事件具有以下顶级数据：

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

数据对象具有以下属性：

属性 类型​​ 说明
title string API 定义的标题。
description string API 定义的说明。
specification string API 规范属性，由 name（规范名称）和 version（规范版本）组成

教程和操作指南

标题 说明
为 API 中心中的 API 治理启用 Lint 分析和分析 使用事件网格事件触发 Lint 分析，以分析 API 中心中的 API 定义。

相关内容