次の方法で共有

Event Grid ソースとしての Azure API Center (プレビュー)

  • [アーティクル]

この記事では、Azure API Center イベントのプロパティとスキーマについて説明します。 イベント スキーマの概要については、「Azure Event Grid イベント スキーマ」を参照してください。

Note

この機能は現在はプレビュー中です。

使用可能なイベントの種類

クライアントが API 定義を追加または更新すると、これらのイベントがトリガーされます。

イベント名 説明
Microsoft.ApiCenter.ApiDefinitionAdded API 定義が API センターに追加されるとトリガーされます。
Microsoft.ApiCenter.ApiDefinitionUpdated API センターで API 定義が更新されるとトリガーされます。

イベントの例

イベントがトリガーされると、API Center サービスにより、そのイベントに関するデータがサブスクライブしているエンドポイントに送信されます。 このセクションには、各 API Center イベントでそのデータがどのように見えるかの例が含まれています。

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 イベント ソースの完全なリソース パス。 このフィールドは書き込み可能ではありません。 この値は Event Grid によって指定されます。
subject string 発行元が定義したイベントの対象のパス。
type string このイベント ソース用に登録されたイベントの種類のいずれか。
time string プロバイダーの UTC 時刻に基づくイベントの生成時刻。
id string イベントの一意識別子。
data オブジェクト Azure API Center イベント データ。
specversion string CloudEvents スキーマ仕様バージョン。

データ オブジェクトには、次のプロパティがあります。

プロパティ タイプ 説明
title string API 定義のタイトル。
description string API 定義の説明。
specification string API 仕様のプロパティ。name (仕様名) と version (仕様バージョン) で構成されます。

チュートリアルと方法

タイトル 説明
API センターで API ガバナンスのリンティングと分析を有効にする Event Grid イベントを使ってリンティングをトリガーし、API センターの API 定義を分析します。

関連するコンテンツ