次の方法で共有

Event Grid ソースとしての Azure API Management

この記事では、 Azure API Management イベントのプロパティとスキーマについて説明します。 イベント スキーマの概要については、「Azure Event Grid イベント スキーマ」を参照してください。 また、API Management をイベント ソースとして使用するための記事へのリンクも提供します。

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

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.プロダクト削除 製品が削除されたときに発生します。
マイクロソフト.ApiManagement.APIリリース作成 API リリースが作成されたときに発生します。
Microsoft.ApiManagement.APIReleaseUpdated API リリースが更新されたときに発生します。
Microsoft.ApiManagement.APIReleaseDeleted API リリースが削除されたときに発生します。
Microsoft.ApiManagement.SubscriptionCreated サブスクリプションが作成されたときに発生します。
Microsoft.ApiManagement.SubscriptionUpdated（サブスクリプション更新） サブスクリプションが更新されたときに発生します。
Microsoft.ApiManagement.サブスクリプション削除 サブスクリプションが削除されたときに発生します。
Microsoft.ApiManagement.GatewayCreated セルフホステッド ゲートウェイが作成されたときに発生します。
Microsoft.ApiManagement.ゲートウェイ削除 セルフホステッド ゲートウェイが更新されたときに発生します。
Microsoft.ApiManagement.GatewayUpdated セルフホステッド ゲートウェイが削除されたときに発生します。
Microsoft.ApiManagement.GatewayAPIAdded API がセルフホステッド ゲートウェイに追加されたときに発生します。
Microsoft.ApiManagement.GatewayAPIが削除されました セルフホステッド ゲートウェイから API が削除されたときに発生します。
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated 認証局がセルフホステッド ゲートウェイ向けに更新されたときに発生します。
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted 認証局がセルフホステッド ゲートウェイに対し削除されたときに発生します。
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated 認証局がセルフホステッド ゲートウェイ向けに更新されたときに発生します。
Microsoft.ApiManagement.Gatewayのホスト名構成が作成されました ホスト名構成がセルフホステッド ゲートウェイ向けに作成されたときに発生します。
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted ホスト名構成がセルフホステッド ゲートウェイに対し削除されたときに発生します。
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated ホスト名構成がセルフホステッド ゲートウェイ向けに更新されたときに発生します。
Microsoft.ApiManagement.GatewayTokenNearExpiry (プレビュー) セルフホステッド ゲートウェイ アクセス トークンの有効期限が近づいているときに発生します。
Microsoft.ApiManagement.GatewayTokenExpired (プレビュー) セルフホステッド ゲートウェイ アクセス トークンの有効期限が切れると発生します。
Microsoft.ApiManagement.CircuitBreaker.Opened (プレビュー) バックエンド サーキット ブレーカーがオープンしたときに発生します。
Microsoft.ApiManagement.CircuitBreaker.Closed (プレビュー) バックエンド サーキット ブレーカーがクローズしたときに発生します。

イベントの例

次の例は、製品が作成したイベントのスキーマを示しています。 他の API Management リソース作成イベントのスキーマも同様です。

[{
  "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 Management リソース削除イベントのスキーマも同様です。

[{
  "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 Management リソース更新イベントのスキーマも同様です。

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

データ オブジェクトのプロパティ

コントロール プレーン イベント

data オブジェクトには、API Management リソースの作成、更新、削除などのコントロール プレーン イベントに関する次のプロパティがあります。

プロパティ タイプ 説明
resourceUri ひも リソース名とリソースの種類など、コンプライアンス状態の変更の対象となるリソースの完全修飾 ID。 形式を使用 /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

サーキット ブレーカー イベント

data オブジェクトには、サーキット ブレーカー イベントの次のプロパティがあります。

プロパティ タイプ 説明
backendNme ひも サーキットブレーカーが設定されているバックエンドエンティティの名称 (ID)。
circuitBreaker オブジェクト バックエンドで構成されたサーキット ブレーカー。そのバックエンドをトリップしたルールを指定する rules オブジェクトで構成されています。 この規則には、サーキット ブレーカーがトリップさる期間を指定する、tripDuration プロパティ (hh:mm:ss 形式) が含まれます。

セルフホステッド ゲートウェイ認証トークン イベント

data オブジェクトには、セルフホステッド ゲートウェイ認証トークン イベントの次のプロパティがあります。

プロパティ タイプ 説明
gatewayInfo オブジェクト 次の文字列プロパティで構成されるセルフホステッド ゲートウェイ情報。

* gatewayId - ゲートウェイリソースのID（完全修飾）
* instanceId - デプロイされたゲートウェイの一意のインスタンス ID
tokenInfo オブジェクト プロバイダーの UTC 時刻の次のいずれかのプロパティで構成されるトークン情報。

* expiresAtUtc - GatewayTokenNearExpiry イベントの場合、または
* expiredAtUtc - GatewayTokenExpired イベントの場合

チュートリアルとハウツー

タイトル 説明
API Management から Event Grid にイベントを送信する Event Grid を使用して API Management イベントをサブスクライブする方法。

次のステップ