Event Grid ソースとしての Azure App Service

[アーティクル]
03/05/2024

この記事では、Azure App Service イベントのプロパティとスキーマについて説明します。イベントスキーマの概要については、「Azure Event Grid イベントスキーマ」を参照してください。また、Azure App Service をイベントソースとして使用するためのクイックスタートとチュートリアルの一覧も示されています。

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

Azure App Service から出力されるイベントの種類は次のとおりです。

イベントの種類	説明
Microsoft.Web/sites.BackupOperationStarted	バックアップが開始されたときにトリガーされます
Microsoft.Web/sites.BackupOperationCompleted	バックアップが完了したときにトリガーされます
Microsoft.Web/sites.BackupOperationFailed	バックアップが失敗したときにトリガーされます
Microsoft.Web/sites.RestoreOperationStarted	バックアップからの復元が開始されたときにトリガーされます
Microsoft.Web/sites.RestoreOperationCompleted	バックアップからの復元が完了したときにトリガーされます
Microsoft.Web/sites.RestoreOperationFailed	バックアップからの復元に失敗したときにトリガーされます
Microsoft.Web/sites.SlotSwapStarted	スロットのスワップが開始されたときにトリガーされます
Microsoft.Web/sites.SlotSwapCompleted	スロットのスワップが完了したときにトリガーされます
Microsoft.Web/sites.SlotSwapFailed	スロットのスワップに失敗したときにトリガーされます
Microsoft.Web/sites.SlotSwapWithPreviewStarted	プレビューでのスロットのスワップが開始されたときにトリガーされます
Microsoft.Web/sites.SlotSwapWithPreviewCancelled	プレビューでのスロットのスワップが取り消されたときにトリガーされます
Microsoft.Web/sites.AppUpdated.Restarted	サイトが再起動されたときにトリガーされます
Microsoft.Web/sites.AppUpdated.Stopped	サイトが停止されたときにトリガーされます
Microsoft.Web/sites.AppUpdated.ChangedAppSettings	サイトのアプリ設定が変更されたときにトリガーされます
Microsoft.Web/serverfarms.AppServicePlanUpdated	App Service プランが更新されたときにトリガーされます

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

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

プロパティ	タイプ	説明
`topic`	string	イベントソースの完全なリソースパス。このフィールドは書き込み可能ではありません。この値は Event Grid によって指定されます。
`subject`	string	発行元が定義したイベントの対象のパス。
`eventType`	string	このイベントソース用に登録されたイベントの種類のいずれか。
`eventTime`	string	プロバイダーの UTC 時刻に基づくイベントの生成時刻。
`id`	string	イベントの一意識別子。
`data`	object	Blob Storage イベントのデータ。
`dataVersion`	string	データオブジェクトのスキーマバージョン。スキーマバージョンは発行元によって定義されます。
`metadataVersion`	string	イベントメタデータのスキーマバージョン。最上位プロパティのスキーマは Event Grid によって定義されます。この値は Event Grid によって指定されます。

イベントの例

BackupOperationStarted、BackupOperationCompleted、BackupOperationFailed

クラウドイベントスキーマ
Event Grid イベントスキーマ

{
	"id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8",
	"source": "/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.Web/sites/<site-name>",
	"subject": "/Microsoft.Web/sites/<site-name>",
	"type": "Microsoft.Web.BackupOperationStarted",
	"time": "2020-01-28T18:26:51.7194887Z",
	"data": {
		"appEventTypeDetail": {
			"action": "Started"
		},
		"name": "<site-name>",
		"clientRequestId": "None",
		"correlationRequestId": "None",
		"requestId": "292f499d-04ee-4066-994d-c2df57b99198",
		"address": "None",
		"verb": "None"
	},
	"specversion": "1.0"
}

{
	"id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8",
	"topic": "/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.Web/sites/<site-name>",
	"subject": "/Microsoft.Web/sites/<site-name>",
	"eventType": "Microsoft.Web.BackupOperationStarted",
	"eventTime": "2020-01-28T18:26:51.7194887Z",
	"data": {
		"appEventTypeDetail": {
			"action": "Started"
		},
		"name": "<site-name>",
		"clientRequestId": "None",
		"correlationRequestId": "None",
		"requestId": "292f499d-04ee-4066-994d-c2df57b99198",
		"address": "None",
		"verb": "None"
	},
	"dataVersion": "1",
	"metaDataVersion": "1"
}

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

プロパティ	タイプ	内容
`appEventTypeDetail`	object	アプリでのアクションの詳細
`action`	string	操作のアクションの種類
`name`	string	このイベントが発生した Web サイトの名前
`clientRequestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成されたクライアント要求 ID
`correlationRequestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成された相関要求 ID
`requestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成された要求 ID
`address`	string	この操作の HTTP 要求 URL
`verb`	string	この操作の HTTP 動詞

RestoreOperationStarted、RestoreOperationCompleted、RestoreOperationFailed

クラウドイベントスキーマ
Event Grid イベントスキーマ

{
	"id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8",
	"source": "/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.Web/sites/<site-name>",
	"subject": "/Microsoft.Web/sites/<site-name>",
	"type": "Microsoft.Web.RestoreOperationStarted",
	"time": "2020-01-28T18:26:51.7194887Z",
	"data": {
		"appEventTypeDetail": {
			"action": "Started"
		},
		"name": "<site-name>",
		"clientRequestId": "None",
		"correlationRequestId": "None",
		"requestId": "292f499d-04ee-4066-994d-c2df57b99198",
		"address": "None",
		"verb": "POST"
	},
	"specversion": "1.0"
}

{
	"id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8",
	"topic": "/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.Web/sites/<site-name>",
	"subject": "/Microsoft.Web/sites/<site-name>",
	"eventType": "Microsoft.Web.RestoreOperationStarted",
	"eventTime": "2020-01-28T18:26:51.7194887Z",
	"data": {
		"appEventTypeDetail": {
			"action": "Started"
		},
		"name": "<site-name>",
		"clientRequestId": "None",
		"correlationRequestId": "None",
		"requestId": "292f499d-04ee-4066-994d-c2df57b99198",
		"address": "None",
		"verb": "POST"
	},
	"dataVersion": "1",
	"metaDataVersion": "1"
}

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

プロパティ	タイプ	内容
`appEventTypeDetail`	object	アプリでのアクションの詳細
`action`	string	操作のアクションの種類
`name`	string	このイベントが発生した Web サイトの名前
`clientRequestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成されたクライアント要求 ID
`correlationRequestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成された相関要求 ID
`requestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成された要求 ID
`address`	string	この操作の HTTP 要求 URL
`verb`	string	この操作の HTTP 動詞

SlotSwapStarted、SlotSwapCompleted、SlotSwapFailed

クラウドイベントスキーマ
Event Grid イベントスキーマ

{
	"id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8",
	"source": "/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.Web/sites/<site-name>",
	"subject": "/Microsoft.Web/sites/<site-name>",
	"type": "Microsoft.Web.SlotSwapStarted",
	"time": "2020-01-28T18:26:51.7194887Z",
	"data": {
		"appEventTypeDetail": null,
		"name": "<site-name>",
		"clientRequestId": "922f4841-20d9-4dd6-8c5b-23f0d85e5592",
		"correlationRequestId": "9ac46505-2b8a-4e06-834c-05ffbe2e8c3a",
		"requestId": "765117aa-eaf8-4bd2-a644-1dbf69c7b0fd",
		"address": "/websystems/WebSites/web/subscriptions/<id>/webspaces/<webspace>/sites/<site-name>/slots?Command=SWAP&targetSlot=production",
		"verb": "POST",
		"sourceSlot": "staging",
		"targetSlot": "production"
	},
    "specversion": "1.0"
}

{
	"id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8",
	"topic": "/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.Web/sites/<site-name>",
	"subject": "/Microsoft.Web/sites/<site-name>",
	"eventType": "Microsoft.Web.SlotSwapStarted",
	"eventTime": "2020-01-28T18:26:51.7194887Z",
	"data": {
		"appEventTypeDetail": null,
		"name": "<site-name>",
		"clientRequestId": "922f4841-20d9-4dd6-8c5b-23f0d85e5592",
		"correlationRequestId": "9ac46505-2b8a-4e06-834c-05ffbe2e8c3a",
		"requestId": "765117aa-eaf8-4bd2-a644-1dbf69c7b0fd",
		"address": "/websystems/WebSites/web/subscriptions/<id>/webspaces/<webspace>/sites/<site-name>/slots?Command=SWAP&targetSlot=production",
		"verb": "POST",
		"sourceSlot": "staging",
		"targetSlot": "production"
	},
	"dataVersion": "1",
	"metaDataVersion": "1"
}

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

プロパティ	タイプ	内容
`appEventTypeDetail`	object	アプリでのアクションの詳細
`action`	string	操作のアクションの種類
`name`	string	このイベントが発生した Web サイトの名前
`clientRequestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成されたクライアント要求 ID
`correlationRequestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成された相関要求 ID
`requestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成された要求 ID
`address`	string	この操作の HTTP 要求 URL
`verb`	string	この操作の HTTP 動詞
`sourceSlot`	string	スワップのソーススロット

SlotSwapWithPreviewStarted、SlotSwapWithPreviewCancelled

クラウドイベントスキーマ
Event Grid イベントスキーマ

{
	"id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8",
	"source": "/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.Web/sites/<site-name>",
	"subject": "/Microsoft.Web/sites/<site-name>",
	"type": "Microsoft.Web.SlotSwapWithPreviewStarted",
	"time": "2020-01-28T18:26:51.7194887Z",
	"data": {
		"appEventTypeDetail": null,
		"name": "<site-name>",
		"clientRequestId": "922f4841-20d9-4dd6-8c5b-23f0d85e5592",
		"correlationRequestId": "9ac46505-2b8a-4e06-834c-05ffbe2e8c3a",
		"requestId": "765117aa-eaf8-4bd2-a644-1dbf69c7b0fd",
		"address": "/websystems/WebSites/web/subscriptions/<id>/webspaces/<webspace>/sites/<site-name>/slots?Command=SWAP&targetSlot=production",
		"verb": "POST",
		"sourceSlot": "staging",
		"targetSlot": "production"
	},
    "specversion": "1.0"
}

{
	"id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8",
	"topic": "/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.Web/sites/<site-name>",
	"subject": "/Microsoft.Web/sites/<site-name>",
	"eventType": "Microsoft.Web.SlotSwapWithPreviewStarted",
	"eventTime": "2020-01-28T18:26:51.7194887Z",
	"data": {
		"appEventTypeDetail": null,
		"name": "<site-name>",
		"clientRequestId": "922f4841-20d9-4dd6-8c5b-23f0d85e5592",
		"correlationRequestId": "9ac46505-2b8a-4e06-834c-05ffbe2e8c3a",
		"requestId": "765117aa-eaf8-4bd2-a644-1dbf69c7b0fd",
		"address": "/websystems/WebSites/web/subscriptions/<id>/webspaces/<webspace>/sites/<site-name>/slots?Command=SWAP&targetSlot=production",
		"verb": "POST",
		"sourceSlot": "staging",
		"targetSlot": "production"
	},
	"dataVersion": "1",
	"metaDataVersion": "1"
}

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

プロパティ	タイプ	内容
`appEventTypeDetail`	object	アプリでのアクションの詳細
`action`	string	操作のアクションの種類
`name`	string	このイベントが発生した Web サイトの名前
`clientRequestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成されたクライアント要求 ID
`correlationRequestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成された相関要求 ID
`requestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成された要求 ID
`address`	string	この操作の HTTP 要求 URL
`verb`	string	この操作の HTTP 動詞

AppUpdated.Restarted、AppUpdated.Stopped、AppUpdated.ChangedAppSettings

クラウドイベントスキーマ
Event Grid イベントスキーマ

{
	"id": "b74ea56b-2a3f-4de5-a5d7-38e60c81cf23",
	"source": "/subscriptions/<id>/resourceGroups/<group>/providers/Microsoft.Web/sites/<site-name>",
	"subject": "/Microsoft.Web/sites/<site-name>",
	"type": "Microsoft.Web.AppUpdated",
	"time": "2020-01-28T18:22:30.2760952Z",
	"data": {
		"appEventTypeDetail": {
			"action": "Stopped"
		},
		"name": "<site-name>",
		"clientRequestId": "64a5e0aa-7cee-4ff1-9093-b9197b820014",
		"correlationRequestId": "25bb36a5-8f6c-4f04-b615-e9a0ee045756",
		"requestId": "f2e8eb3f-b190-42de-b99e-6acefe587374",
		"address": "/websystems/WebSites/web/subscriptions/<id>/webspaces/<webspace>/sites/<site-name>/stop",
		"verb": "POST"
	},
    "specversion": "1.0"
}

{
	"id": "b74ea56b-2a3f-4de5-a5d7-38e60c81cf23",
	"topic": "/subscriptions/<id>/resourceGroups/<group>/providers/Microsoft.Web/sites/<site-name>",
	"subject": "/Microsoft.Web/sites/<site-name>",
	"eventType": "Microsoft.Web.AppUpdated",
	"eventTime": "2020-01-28T18:22:30.2760952Z",
	"data": {
		"appEventTypeDetail": {
			"action": "Stopped"
		},
		"name": "<site-name>",
		"clientRequestId": "64a5e0aa-7cee-4ff1-9093-b9197b820014",
		"correlationRequestId": "25bb36a5-8f6c-4f04-b615-e9a0ee045756",
		"requestId": "f2e8eb3f-b190-42de-b99e-6acefe587374",
		"address": "/websystems/WebSites/web/subscriptions/<id>/webspaces/<webspace>/sites/<site-name>/stop",
		"verb": "POST"
	},
	"dataVersion": "1'",
	"metaDataVersion": "1"
}

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

プロパティ	タイプ	内容
`appEventTypeDetail`	object	アプリでのアクションの詳細
`action`	string	操作のアクションの種類
`name`	string	このイベントが発生した Web サイトの名前
`clientRequestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成されたクライアント要求 ID
`correlationRequestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成された相関要求 ID
`requestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成された要求 ID
`address`	string	この操作の HTTP 要求 URL
`verb`	string	この操作の HTTP 動詞

Serverfarms.AppServicePlanUpdated

クラウドイベントスキーマ
Event Grid イベントスキーマ

{
	"id": "56501672-9150-40e1-893a-18420c7fdbf7",
	"source": "/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.Web/serverfarms/<serverfarm-name>",
	"subject": "/Microsoft.Web/serverfarms/<plan-name>",
	"type": "Microsoft.Web.AppServicePlanUpdated",
	"time": "2020-01-28T18:22:23.5516004Z",
	"data": {
		"serverFarmEventTypeDetail": {
			"stampKind": "Public",
			"action": "Updated",
			"status": "Started"
		},
		"serverFarmId": "0",
		"sku": {
			"name": "P1v2",
			"tier": "PremiumV2",
			"size": "P1v2",
			"family": "Pv2",
			"capacity": 1
		},
		"clientRequestId": "8f880321-a991-45c7-b743-6ff63fe4c004",
		"correlationRequestId": "1995c3be-ba7f-4ccf-94af-516df637ec8a",
		"requestId": "b973a8e6-6949-4783-b44c-ac778be831bb",
		"address": "/websystems/WebSites/serverfarms/subscriptions/<id>/webspaces/<webspace-id>/serverfarms/<plan-name>/async",
		"verb": "PUT"
	},
    "specversion": "1.0"
}

{
	"id": "56501672-9150-40e1-893a-18420c7fdbf7",
	"topic": "/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.Web/serverfarms/<serverfarm-name>",
	"subject": "/Microsoft.Web/serverfarms/<plan-name>",
	"eventType": "Microsoft.Web.AppServicePlanUpdated",
	"eventTime": "2020-01-28T18:22:23.5516004Z",
	"data": {
		"serverFarmEventTypeDetail": {
			"stampKind": "Public",
			"action": "Updated",
			"status": "Started"
		},
		"serverFarmId": "0",
		"sku": {
			"name": "P1v2",
			"tier": "PremiumV2",
			"size": "P1v2",
			"family": "Pv2",
			"capacity": 1
		},
		"clientRequestId": "8f880321-a991-45c7-b743-6ff63fe4c004",
		"correlationRequestId": "1995c3be-ba7f-4ccf-94af-516df637ec8a",
		"requestId": "b973a8e6-6949-4783-b44c-ac778be831bb",
		"address": "/websystems/WebSites/serverfarms/subscriptions/<id>/webspaces/<webspace-id>/serverfarms/<plan-name>/async",
		"verb": "PUT"
	},
	"dataVersion": "1",
	"metaDataVersion": "1"
}

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

プロパティ	タイプ	内容
`appServicePlanEventTypeDetail`	object	App Service プランのアクションの詳細
`stampKind`	string	App Service プランがある環境の種類
`action`	string	App Service プランでのアクションの種類
`status`	string	App Service プランでの操作の状態
`sku`	object	App Service プランの SKU
`name`	string	App Service プランの名前
`Tier`	string	App Service プランのサービスレベル
`Size`	string	App Service プランのサイズ
`Family`	string	App Service プランのファミリ
`Capacity`	string	App Service プランの容量
`action`	string	操作のアクションの種類
`name`	string	このイベントが発生した Web サイトの名前
`clientRequestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成されたクライアント要求 ID
`correlationRequestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成された相関要求 ID
`requestId`	string	このイベントをトリガーしたサイト API 操作に対してアプリサービスによって生成された要求 ID
`address`	string	この操作の HTTP 要求 URL
`verb`	string	この操作の HTTP 動詞

次のステップ

Azure Event Grid の概要については、Event Grid の紹介に関する記事を参照してください。
Azure Event Grid サブスクリプションの作成の詳細については、「Event Grid サブスクリプションスキーマ」を参照してください。

次の方法で共有

Event Grid ソースとしての Azure App Service

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

すべてのイベントに共通のプロパティ

イベントの例

BackupOperationStarted、BackupOperationCompleted、BackupOperationFailed

RestoreOperationStarted、RestoreOperationCompleted、RestoreOperationFailed

SlotSwapStarted、SlotSwapCompleted、SlotSwapFailed

SlotSwapWithPreviewStarted、SlotSwapWithPreviewCancelled

AppUpdated.Restarted、AppUpdated.Stopped、AppUpdated.ChangedAppSettings

Serverfarms.AppServicePlanUpdated

次のステップ

フィードバック

その他のリソース