この記事では、Azure App Configuration イベントのプロパティとスキーマについて説明します。 イベント スキーマの概要については、「Azure Event Grid イベント スキーマ」を参照してください。 また、Azure App Configuration をイベント ソースとして使用するためのクイック スタートとチュートリアルの一覧も示されています。
使用可能なイベントの種類
Event Grid は、イベント サブスクリプションを使用して、イベント メッセージをサブスクライバーにルーティングします。 Azure App Configuration は次のイベントの種類を発行します。
| イベントの種類 | 説明 |
|---|---|
| Microsoft.AppConfiguration.KeyValueModified | キー/値が作成または置換されたときに発生します。 |
| Microsoft.AppConfiguration.KeyValueDeleted | キー/値が削除されたときに発生します。 |
| Microsoft.AppConfiguration.SnapshotCreated | スナップショットが作成されたときに発生します。 |
| Microsoft.AppConfiguration.SnapshotModified | スナップショットが変更されたときに発生します。 |
イベント スキーマ
イベントのトップレベルのデータを次に示します。
| プロパティ | タイプ | 説明 |
|---|---|---|
source |
string | イベント ソースの完全なリソース パス。 このフィールドは書き込み可能ではありません。 この値は Event Grid によって指定されます。 |
subject |
string | 発行元が定義したイベントの対象のパス。 |
type |
string | このイベント ソース用に登録されたイベントの種類のいずれか。 |
time |
string | プロバイダーの UTC 時刻に基づくイベントの生成時刻。 |
id |
string | イベントの一意識別子。 |
data |
object | App Configuration イベント データ。 |
specversion |
string | CloudEvents スキーマ仕様バージョン。 |
データ オブジェクトには、次のプロパティがあります。
キー値イベント
| プロパティ | タイプ | 説明 |
|---|---|---|
key |
string | 変更または削除されたキー/値のキー。 |
label |
string | 変更または削除されたキー/値のラベル (存在する場合)。 |
etag |
string | KeyValueModified の場合、新しいキー/値の etag。 KeyValueDeleted の場合、削除されたキー/値の etag。 |
syncToken |
string | キー値イベント後のサーバーの状態を表す同期トークン。 |
スナップショット イベント
| プロパティ | タイプ | 説明 |
|---|---|---|
name |
string | 作成または変更されたスナップショットの名前。 |
etag |
string | SnapshotCreated の場合、新しいスナップショットの etag。 SnapshotModified の場合、変更されたスナップショットの etag。 |
syncToken |
string | スナップショット イベント後のサーバーの状態を表す同期トークン。 |
イベントの例
次の例は、キー/値の変更イベントのスキーマを示します。
[{
"id": "84e17ea4-66db-4b54-8050-df8f7763f87b",
"source": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso",
"subject": "https://contoso.azconfig.io/kv/Foo?label=FizzBuzz",
"data": {
"key": "Foo",
"label": "FizzBuzz",
"etag": "FnUExLaj2moIi4tJX9AXn9sakm0"
},
"type": "Microsoft.AppConfiguration.KeyValueModified",
"time": "2019-05-31T20:05:03Z",
"specversion": "1.0"
}]
次の例は、キー値削除イベントのスキーマを示しています:
[{
"id": "84e17ea4-66db-4b54-8050-df8f7763f87b",
"source": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso",
"subject": "https://contoso.azconfig.io/kv/Foo?label=FizzBuzz",
"data": {
"key": "Foo",
"label": "FizzBuzz",
"etag": "FnUExLaj2moIi4tJX9AXn9sakm0"
},
"type": "Microsoft.AppConfiguration.KeyValueDeleted",
"time": "2019-05-31T20:05:03Z",
"specversion": "1.0"
}]
次の例は、スナップショット作成イベントのスキーマを示しています:
[{
"source": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso",
"subject": "https://contoso.azconfig.io/kvsnapshots/Foo",
"type": "Microsoft.AppConfiguration.SnapshotCreated",
"time": "2023-09-02T20:05:03.0000000Z",
"id": "84e17ea4-66db-4b54-8050-df8f7763f87b",
"data": {
"name": "Foo",
"etag": "FnUExLaj2moIi4tJX9AXn9sakm0",
"syncToken": "zAJw6V16=Njo1IzUxNjQ2NzM=;sn=5164673"
},
"specversion": "1.0"
}]
次の例は、スナップショット変更イベントのスキーマを示しています:
[{
"source": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso",
"subject": "https://contoso.azconfig.io/snapshots/Foo",
"type": "Microsoft.AppConfiguration.SnapshotModified",
"time": "2023-09-03T20:05:03.0000000Z",
"id": "84e17ea4-66db-4b54-8050-df8f7763f87b",
"data": {
"name": "Foo",
"etag": "FnUExLaj2moIi4tJX9AXn9sakm0",
"syncToken": "zAJw6V16=Njo1IzUxNjQ2NzM=;sn=5164673"
},
"specversion": "1.0"
}]
チュートリアルと方法
| タイトル | 説明 |
|---|---|
| Event Grid を使用して Azure App Configuration イベントに応答する | Azure App Configuration と Event Grid の統合の概要。 |
| データ変更通知に Event Grid を使用する | Azure App Configuration イベント サブスクリプションを使用して、キーと値の変更イベントを Web エンドポイントに送信する方法について説明します。 |
次のステップ
- Azure Event Grid の概要については、Event Grid の紹介に関する記事を参照してください。
- Azure Event Grid サブスクリプションの作成の詳細については、Event Grid サブスクリプション スキーマに関する記事を参照してください。
- Azure App Configuration イベントの操作の概要については、データ変更通知での Event Grid の使用に関する記事を参照してください。