Azure 仮想マシンスケールセットインスタンスの通知を終了する

[アーティクル]
11/23/2023

スケールセットインスタンスでは、インスタンスの終了通知を受信し、定義済みの遅延タイムアウトを終了操作に設定することをオプトインできます。終了通知は、Azure Metadata Service の Scheduled Events を介して送信されます。これにより、再起動や再デプロイなどの影響がある操作の通知と遅延が行われます。このソリューションでは、別のイベント (Terminate) が Scheduled Events の一覧に追加されます。terminate イベントの関連する遅延は、スケールセットモデルの構成のユーザーによって指定された遅延の制限によって変わります。

適切な Metadata Service エンドポイントを呼び出して Scheduled Events に登録すると、スケールセットインスタンスでは、インスタンスの削除前に指定されたタイムアウトの有効期限が切れるのを待機する必要がなくなります。終了通知を受け取った後、インスタンスでは、終了のタイムアウトが期限切れになる前にいつでも削除することを選択できます。スポットインスタンスで終了通知を有効にすることはできません。スポットインスタンスの詳細については、「仮想マシンスケールセット用の Azure Spot Virtual Machines」を参照してください

終了通知を有効にする

スケールセットのインスタンスで終了通知を有効にするには、次の例で説明するように複数の方法があります。

Azure portal

次の手順では、新しいスケールセットを作成するときに終了通知を有効にします。

[仮想マシンスケールセット] に移動します。
[+ 追加] を選択して、新しいスケールセットを作成します。
[管理] タブに移動します。
[インスタンスの終了] セクションを見つけます。
[インスタンスの終了通知] で、 [オン] を選択します。
[終了の遅延 (分)] で、必要な既定のタイムアウトを設定します。
新しいスケールセットの作成が完了したら、[確認と作成] ボタンを選択します。

既存のスケールセットに対する終了通知を有効にすることもできます。

目的のスケールセットに移動します。
[構成] タブに移動します。
[インスタンスの終了通知を有効にする] で、[オン] を選択します。
[終了の遅延 (分)] で、必要な既定のタイムアウトを設定します。
[保存] ボタンを選択します。

REST API

次の例では、スケールセットモデルで終了通知を有効にします。

PUT on `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}?api-version=2019-03-01`

{
  "properties": {
    "virtualMachineProfile": {
            "scheduledEventsProfile": {
                "terminateNotificationProfile": {
                    "notBeforeTimeout":"PT5M",
                    "enable":true
                }
            }
        }
    }        
}

上のブロックでは、スケールセット内のすべてのインスタンスに対する任意の終了操作について、(PT5M で示されているように) タイムアウトの遅延が 5 分間に指定されています。フィールド notBeforeTimeout は、ISO 8601 形式の 5 から 15 分の範囲の任意の値を受け取ることができます。前述の terminateNotificationProfile の notBeforeTimeout プロパティを変更することで、終了操作の既定のタイムアウトを変更できます。

スケールセットモデルで scheduledEventsProfile を有効にし、notBeforeTimeout を設定してから、変更を反映するように個々のインスタンスを最新のモデルに更新します。

Note

スケールセットインスタンスの終了通知は、API バージョン 2019-03-01 以降でのみ有効にすることができます

Azure PowerShell

新しいスケールセットを作成するときに、New-AzVmssConfig コマンドレットを使用して、スケールセットの終了通知を有効にすることができます。

このサンプルスクリプトでは、構成ファイルを使用したスケールセットと関連リソースの作成について説明します (完全な仮想マシンスケールセットを作成する)。スケールセットを作成するための構成オブジェクトに TerminateScheduledEvents および TerminateScheduledEventNotBeforeTimeoutInMinutes パラメーターを追加することにより、"構成終了" の通知を行うことができます。次の例では、10 分の遅延タイムアウトでこの機能を有効にします。

重要

2023 年 11 月以降、PowerShell と Azure CLI を使用して作成された VM スケールセットは、オーケストレーションモードが指定されていない場合、既定でフレキシブルオーケストレーションモードになります。この変更の詳細と実行する必要があるアクションについては、「VMSS PowerShell/CLI のお客様向けの重大な変更 - Microsoft コミュニティハブ」を参照してください

New-AzVmssConfig `
  -Location "VMSSLocation" `
  -SkuCapacity 2 `
  -OrchestrationMode "Flexible" `
  -SkuName "Standard_DS2" `
  -TerminateScheduledEvents $true `
  -TerminateScheduledEventNotBeforeTimeoutInMinutes 10

Update-AzVmss コマンドレットを使用して、既存のスケールセットに対する終了通知を有効にします。

Update-AzVmss `
  -ResourceGroupName "myResourceGroup" `
  -VMScaleSetName "myScaleSet" `
  -TerminateScheduledEvents $true `
  -TerminateScheduledEventNotBeforeTimeoutInMinutes 15

上の例では、既存のスケールセットに対して終了通知を有効にし、terminate イベントに 15 分のタイムアウトを設定します。

スケールセットモデルでスケジュール化されたイベントを有効にし、タイムアウトを設定した後、変更内容を反映するように個々のインスタンスを最新のモデルに更新します。

Azure CLI 2.0

次の例は、新しいスケールセットの作成中に終了通知を有効にするためのものです。

az group create --name <myResourceGroup> --location <VMSSLocation>
az vmss create \
  --resource-group <myResourceGroup> \
  --name <myVMScaleSet> \
  --image Ubuntu2204 \
  --admin-username <azureuser> \
  --generate-ssh-keys \
  --terminate-notification-time 10

上の例では、最初にリソースグループを作成し、次に 10 分の既定のタイムアウトで終了通知を有効にして新しいスケールセットを作成します。

次の例は、既存のスケールセットで終了通知を有効にするためのものです。

az vmss update \  
  --resource-group <myResourceGroup> \
  --name <myVMScaleSet> \
  --enable-terminate-notification true \
  --terminate-notification-time 10

終了通知を取得する

終了通知は、Azure Metadata Service である Scheduled Events を介して配信されます。 Azure Metadata Service では、VM 内部からアクセスできる REST エンドポイントを使用した Virtual Machine の実行に関する情報が公開されます。情報は、VM の外部に公開されないように、ルーティング不可能な IP 経由で提供されます。

Scheduled Events は、ユーザーが初めてイベントを要求したときに、スケールセットに対して有効になります。最初の呼び出しでは、最大 2 分の応答遅延が発生すると予想できます。定期的にエンドポイントにクエリを実行し、今後のメンテナンスイベントと進行中のメンテナンスアクティビティの状態を検出します。

スケールセットインスタンスで要求が 24 時間行われない場合、スケールセットの Scheduled Events は無効になります。

エンドポイントの検出

VNET が有効な VM の場合は、静的でルーティング不可能な IP アドレス 169.254.169.254 から Metadata Service を利用できます。

スケジュールされたイベントの最新バージョンのフルエンドポイントは次のとおりです。

'http://169.254.169.254/metadata/scheduledevents?api-version=2019-01-01'

クエリ応答

応答には、スケジュールされたイベントの配列が含まれています。空の配列は、現在スケジュールされているイベントがないことを意味します。

スケジュールされたイベントがある場合は、応答にイベントの配列が含まれます。 "Terminate" イベントの場合、応答は次のようになります。

{
    "DocumentIncarnation": {IncarnationID},
    "Events": [
        {
            "EventId": {eventID},
            "EventType": "Terminate",
            "ResourceType": "VirtualMachine",
            "Resources": [{resourceName}],
            "EventStatus": "Scheduled",
            "NotBefore": {timeInUTC},
        }
    ]
}

DocumentIncarnation は ETag であり、前回のクエリ以降にイベントのペイロードが変化したかどうかを簡単に検査する方法を提供します。

上の各フィールドの詳細については、Windows および Linux の Scheduled Events ドキュメントを参照してください。

イベントに応答する

今後予定されているイベントを確認し、グレースフルシャットダウンのロジックを完了すると、EventId のメタデータサービスに POST 呼び出しを行うことにより、未処理のイベントを承認できます。 POST 呼び出しでは、VM の削除を続行できることが Azure に示されます。

POST 要求の本文には、次のような json が含まれます。要求には、StartRequests の一覧が含まれています。各 StartRequest には、高速化するイベントの EventId が含まれています。

{
	"StartRequests" : [
		{
			"EventId": {EventId}
		}
	]
}

スケールセット内のすべての VM が、その VM に関連する EventID のみを承認していることを確認します。 VM は、インスタンスメタデータを介して自身の VM 名を取得できます。この名前の形式は "{scale-set-name}_{instance-id}" であり、上記のクエリ応答の "Resources" セクションに表示されます。

Python を使用してイベントに対してクエリを実行し応答するサンプルスクリプトを参照することもできます。

ヒントとベストプラクティス

"削除" 操作に対して通知を終了する - スケールセットで scheduledEventsProfile が有効な場合は、すべての削除操作 (手動の削除または自動スケーリングによって開始されたスケールイン) で Terminate イベントが生成されます。再起動、再イメージ化、再デプロイ、終了/割り当て解除などの他の操作では、Terminate イベントは生成されません。
タイムアウトを待機する必要なし - イベントが受信された後、イベントの NotBefore 時間が期限切れになる前であればいつでも終了操作を開始できます。
タイムアウト時の削除は必須 - イベントの生成後にタイムアウト値を延長する機能は提供されません。タイムアウトが期限切れになると、保留中の terminate イベントが処理され、VM が削除されます。
変更可能なタイムアウト値 - スケールセットモデルの notBeforeTimeout プロパティを変更し、VM インスタンスを最新のモデルに更新することで、インスタンスが削除される前にいつでもタイムアウト値を変更できます。
保留中のすべての削除を承認する - 承認されていない VM_1 に保留中の削除があり、VM_2 で別の terminate イベントを承認した場合は、VM_1 の terminate イベントが承認されるか、タイムアウトが経過するまで、VM_2 は削除されません。 VM_1 の terminate イベントを承認すると、VM_1 と VM_2 の両方が削除されます。
すべての同時削除を承認する - 上記の例を拡張します。VM_1 と VM_2 の NotBefore 時間が同じである場合、両方の terminate イベントを承認するか、タイムアウトの期限が切れる前にどちらの VM も削除する必要があります。

トラブルシューティング

ScheduledEventsProfile を有効にできない

"タイプ 'VirtualMachineProfile' のオブジェクトにメンバー 'scheduledEventsProfile' が見つかりませんでした" というエラーメッセージの "BadRequest" エラーが発生する場合は、スケールセットの操作に使用されている API バージョンを確認してください。コンピューティング API バージョン 2019-03-01 以降が必要です。

Terminate イベントを取得できない

Scheduled Events を介して Terminate イベントを取得していない場合は、イベントの取得に使用された API バージョンを確認します。 Terminate イベントには Metadata Service API バージョン 2019-01-01 以降が必要です。