Event Grid ソースとしての Azure メンテナンス構成
この記事では、Azure メンテナンス構成イベントのプロパティとスキーマについて説明します。 イベント スキーマの概要については、「Azure Event Grid イベント スキーマ」を参照してください。 また、イベント ソースとしてメンテナンス構成を使用するための記事へのリンクも提供します。
使用可能なイベントの種類
メンテナンス構成が生成するイベントの種類は以下のとおりです。
| イベントの種類 | 説明 |
|---|---|
| Microsoft.Maintenance.PreMaintenanceEvent | メンテナンス ジョブの開始前に発生し、ユーザーにメンテナンス前の操作を実行する機会を提供します。 |
| Microsoft.Maintenance.PostMaintenanceEvent | メンテナンス ジョブが完了した後に発生し、メンテナンス後の操作を実行する機会を提供します。 |
イベントの例
メンテナンス前イベントのスキーマの例を次に示します。
[{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Maintenance/maintenanceConfigurations/contosomaintenanceconfiguration/providers/microsoft.maintenance/applyupdates/20230509150000",
"source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Maintenance/maintenanceConfigurations/contosomaintenanceconfiguration",
"subject": "contosomaintenanceconfiguration",
"data":
{
"correlationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Maintenance/maintenanceConfigurations/contosomaintenanceconfiguration/providers/microsoft.maintenance/applyupdates/20230509150000",
"maintenanceConfigurationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Maintenance/maintenanceConfigurations/contosomaintenanceconfiguration",
"startDateTime": "2023-05-09T15:00:00Z",
"endDateTime": "2023-05-09T18:55:00Z",
"cancellationCutOffDateTime": "2023-05-09T14:59:00Z",
"resourceSubscriptionIds": ["subscription guid 1", "subscription guid 2"]
}
"type": "Microsoft.Maintenance.PreMaintenanceEvent",
"time": "2023-05-09T14:25:00.3717473Z",
"specversion": "1.0"
}]
メンテナンス後イベントの例を次に示します。
[{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Maintenance/maintenanceConfigurations/contosomaintenanceconfiguration/providers/microsoft.maintenance/applyupdates/20230509150000",
"source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Maintenance/maintenanceConfigurations/contosomaintenanceconfiguration",
"subject": "contosomaintenanceconfiguration",
"data":
{
"correlationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Maintenance/maintenanceConfigurations/contosomaintenanceconfiguration/providers/microsoft.maintenance/applyupdates/20230509150000",
"maintenanceConfigurationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Maintenance/maintenanceConfigurations/contosomaintenanceconfiguration",
"status": "Succeeded",
"startDateTime": "2023-05-09T15:00:00Z",
"endDateTime": "2023-05-09T18:55:00Z",
"resourceSubscriptionIds": ["subscription guid 1", "subscription guid 2"]
}
"type": "Microsoft.Maintenance.PostMaintenanceEvent",
"time": "2023-05-09T15:55:00.3717473Z",
"specversion": "1.0"
}]
イベントのプロパティ
イベントのトップレベルのデータを次に示します。
| プロパティ | Type | 説明 |
|---|---|---|
| source | string | イベント ソースの完全なリソース パス。 このフィールドは書き込み可能ではありません。 この値は Event Grid によって指定されます。 |
| subject | string | 発行元が定義したイベントの対象のパス。 |
| type | string | このイベント ソース用に登録されたイベントの種類のいずれか。 |
| time | string | プロバイダーの UTC 時刻に基づくイベントの生成時刻。 |
| ID | string | イベントの一意識別子。 |
| data | object | App Configuration イベント データ。 |
| specversion | string | CloudEvents スキーマ仕様バージョン。 |
データ オブジェクトには、次のプロパティがあります。
| プロパティ | Type | 説明 |
|---|---|---|
| correlationId | string | 特定のメンテナンス スケジュール インスタンスのリソース ID。 |
| maintenanceConfigurationId | string | メンテナンス構成のリソース ID。 |
| startDateTime | string | メンテナンス スケジュールの開始時刻。 |
| endDateTime | string | メンテナンス スケジュールの終了時刻。 |
| cancellationCutOffDateTime | string | メンテナンス スケジュール インスタンスの取り消しの締め切り時刻。 |
| resourceSubscriptionIds | string | このスケジュール インスタンスに含まれる VM のサブスクリプション ID。 |
| status | string | メンテナンス スケジュール インスタンスの完了状態。 |
次のステップ
- Azure Event Grid の概要については、Event Grid の紹介に関する記事を参照してください。
- Azure Event Grid サブスクリプションの作成の詳細については、Event Grid サブスクリプション スキーマに関する記事を参照してください。