分享方式：

Azure API 中心作為事件方格來源 （預覽）

  • 文章

本文提供 Azure API 中心事件的屬性和架構。 如需事件結構描述的簡介，請參閱 Azure Event Grid 事件結構描述。

注意

此功能目前為預覽功能。

可用的事件類型

當用戶端新增或更新 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 字串 CloudEvents 結構描述規格版本。

資料物件具有下列屬性：

屬性 類型​ 描述
title 字串 API 定義的標題。
description 字串 API 定義的描述。
specification 字串 API 規格屬性，包含 name （規格名稱） 和 version （規格版本）

教學課程和操作說明

標題 描述
在 API 中心啟用 API 控管的 Linting 和分析 使用事件方格事件來觸發 linting 來分析 API 中心中的 API 定義。

相關內容