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

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

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

チュートリアルと方法

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

次のステップ