Set-AzVmssLifecycleHooksProfile
ライフサイクル フックを仮想マシン スケール セット (VMSS) 構成またはライブ VMSS オブジェクトにアタッチします。
構文
Default (既定)
Set-AzVmssLifecycleHooksProfile
-VirtualMachineScaleSet <PSVirtualMachineScaleSet>
-LifecycleHook <LifecycleHook[]>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Set-AzVmssLifecycleHooksProfile コマンドレットは、ライフサイクル フックを VMSS 構成オブジェクト (PSVirtualMachineScaleSet) にアタッチし、更新されたオブジェクトを返します。 これは、標準の Az.Compute ビルダー規則 (Set-AzVmssOsProfile と同じ Set-AzVmssStorageProfile): VMSS 構成オブジェクトを変更して返します。
変更をAzureに保持するには、更新されたオブジェクトを New-AzVmss (新しいスケール セットの場合) または Update-AzVmss (既存のスケール セットの場合) に渡す必要があります。
例
例 1: 新しい VMSS 構成にライフサイクル フックをアタッチする
$hook = New-AzVmssLifecycleHookConfig -Type 'UpgradeAutoOSScheduling' -WaitDuration 'PT8H'
$config = New-AzVmssConfig -Location 'eastus' -SkuCapacity 2
$config = Set-AzVmssLifecycleHooksProfile -VirtualMachineScaleSet $config -LifecycleHook $hook
New-AzVmss -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss' -VirtualMachineScaleSet $config
この例では、ライフサイクル フックがアタッチされた新しい VMSS を作成します。
例 2: 既存の VMSS にライフサイクル フックを追加する
$vmss = Get-AzVmss -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss'
$existing = if ($vmss.LifecycleHooksProfile) { $vmss.LifecycleHooksProfile.LifecycleHooks } else { @() }
$batch = New-AzVmssLifecycleHookConfig -Type 'UpgradeAutoOSRollingBatchStarting' -WaitDuration 'PT30M'
$vmss = Set-AzVmssLifecycleHooksProfile -VirtualMachineScaleSet $vmss -LifecycleHook ($existing + $batch)
Update-AzVmss -ResourceGroupName 'myRg' -VMScaleSetName 'myVmss' -VirtualMachineScaleSet $vmss
この例では、既存の VMSS に 2 つ目のライフサイクル フックを追加し、既存のフックを保持します。
例 3: パイプラインを使用してフックをアタッチする
$hook = New-AzVmssLifecycleHookConfig -Type 'UpgradeAutoOSScheduling' -WaitDuration 'PT8H'
New-AzVmssConfig -Location 'eastus' -SkuCapacity 2 | Set-AzVmssLifecycleHooksProfile -LifecycleHook $hook
この例では、パイプラインを使用して、VMSS 構成にライフサイクル フックをアタッチします。
パラメーター
-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 |
-LifecycleHook
VMSS にアタッチする 1 つ以上のライフサイクル フック オブジェクト。 フック オブジェクトを作成するには、'New-AzVmssLifecycleHookConfig' を使用します。 VMSS 構成オブジェクトの既存のライフサイクル フックを置き換えます。
パラメーターのプロパティ
| 型: | |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-VirtualMachineScaleSet
更新する VMSS 構成オブジェクト (PSVirtualMachineScaleSet)。 'New-AzVmssConfig' のメモリ内構成、または 'Get-AzVmss' のライブ VMSS オブジェクトを指定できます。
パラメーターのプロパティ
| 型: | PSVirtualMachineScaleSet |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | 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を参照してください。
