Update-AzVmssLifecycleHookEvent
承認、拒否、または遅延によって、仮想マシン スケール セット (VMSS) ライフサイクル フック イベントに応答します。
構文
ByNameParameterSet (既定)
Update-AzVmssLifecycleHookEvent
-ResourceGroupName <String>
-VMScaleSetName <String>
-Name <String>
[-ActionState <String>]
[-InstanceId <String[]>]
[-WaitUntil <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByObjectParameterSet
Update-AzVmssLifecycleHookEvent
-InputObject <VMScaleSetLifecycleHookEvent>
[-ActionState <String>]
[-InstanceId <String[]>]
[-WaitUntil <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Update-AzVmssLifecycleHookEvent コマンドレットは、VMSS ライフサイクル フック イベントに応答します。 次のようにすることができます。
- イベントを承認または拒否する (
-ActionState) - VM インスタンスのサブセットを承認または拒否する (
-InstanceIdで-ActionState) - イベントの期限を遅らせる (
-WaitUntil)
コマンドレットは 、Get-AzVmssLifecycleHookEvent からのパイプライン入力を受け入れます。
例
例 1: イベント内のすべてのターゲットを承認する
Update-AzVmssLifecycleHookEvent -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss' -Name $eventGuid -ActionState Approved
この例では、ライフサイクル フック イベント内のすべてのターゲット リソースを承認します。
例 2: すべてのターゲットを拒否する
Update-AzVmssLifecycleHookEvent -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss' -Name $eventGuid -ActionState Rejected
この例では、すべてのターゲット リソースを拒否します。
例 3: Uniform VMSS 内の VM のサブセットを承認する
Update-AzVmssLifecycleHookEvent -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss' -Name $eventGuid -InstanceId '0','1','2' -ActionState Approved
この例では、Uniform VMSS 内のインスタンス ID 0、1、および 2 を持つ VM を承認します。
例 4: Flex VMSS 内の VM のサブセットを承認する
Update-AzVmssLifecycleHookEvent -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss' -Name $eventGuid -InstanceId 'myvmss_3ec87a','myvmss_a1b2c3' -ActionState Approved
この例では、Flex VMSS 内の特定の VM 名を承認します。
例 5: イベントの期限を遅らせる
Update-AzVmssLifecycleHookEvent -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss' -Name $eventGuid -WaitUntil '2026-05-08T11:00:00Z'
次の使用例は、イベントの期限を指定した UTC タイムスタンプに遅延します。
例 6: 承認される内容をプレビューする
Update-AzVmssLifecycleHookEvent -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss' -Name $eventGuid -ActionState Approved -WhatIf
この例では、変更を加えずにコマンドレットが実行する内容を示します。
例 7: パイプライン経由ですべてのアクティブなイベントを承認する
Get-AzVmssLifecycleHookEvent -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss' |
Where-Object { $_.Properties.State -eq 'Active' } |
Update-AzVmssLifecycleHookEvent -ActionState Approved
この例では、すべてのアクティブなライフサイクル フック イベントを取得し、パイプラインを通じて各イベントを承認します。
パラメーター
-ActionState
ライフサイクル フック イベント ターゲットに適用するアクションの状態。 受け入れ可能な値: 'Approved'、'Rejected'。
-InstanceIdが指定されていない場合、アクションはイベント内のすべてのターゲット リソースに適用されます。
-InstanceIdを指定すると、一致するターゲットのみが更新されます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| 指定可能な値: | Approved, Rejected |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azureとの通信に使用される資格情報、アカウント、テナント、サブスクリプション。
パラメーターのプロパティ
| 型: | IAzureContextContainer |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InputObject
'Get-AzVmssLifecycleHookEvent' のライフサイクル フック イベント オブジェクト。 このパラメーター セットを使用すると、リソース グループ名、VMSS 名、およびイベント名がオブジェクトから抽出されます。
パラメーターのプロパティ
| 型: | VMScaleSetLifecycleHookEvent |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByObjectParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InstanceId
ターゲット VM インスタンス ID (Uniform VMSS の場合は 10 進 ID) または VM 名 (Flex VMSS の場合) のサブセットに更新をフィルター処理します。 省略すると、イベント内のすべてのターゲット リソースにアクションの状態が適用されます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Name
更新するライフサイクル フック イベントの名前 (GUID)。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByNameParameterSet
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループの名前。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByNameParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-VMScaleSetName
VM スケール セットの名前。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByNameParameterSet
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WaitUntil
イベントの期限を、指定された UTC タイムスタンプに ISO 8601 形式で遅延します (例: '2026-05-08T11:00:00Z')。 タイムスタンプは、イベントの MaxWaitUntil 値を超えてはなりません。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | wi |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。
