New-AzVmssLifecycleHookConfig
仮想マシン スケール セット (VMSS) で使用するメモリ内ライフサイクル フック構成オブジェクトを作成します。
構文
Default (既定)
New-AzVmssLifecycleHookConfig
-Type <String>
[-WaitDuration <String>]
[-DefaultAction <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
New-AzVmssLifecycleHookConfig コマンドレットは、Set-AzVmssLifecycleHooksProfile または New-AzVmssConfig に渡すことができるライフサイクル フック構成オブジェクトを作成します。
ライフサイクル フックを使用すると、VMSS の自動 OS アップグレード フェーズの前に起動するフックを登録し、プラットフォームが進行する前に VM ごとにイベントに応答 (承認、拒否、または遅延) できます。
例
例 1: 自動 OS アップグレード スケジュールのライフサイクル フックを作成する
$hook = New-AzVmssLifecycleHookConfig -Type 'UpgradeAutoOSScheduling' -WaitDuration 'PT8H'
この例では、自動 OS アップグレードのスケジュール設定の前に 8 時間の待機時間で起動するライフサイクル フックを作成します。
-DefaultActionが指定されていないため、待機時間の有効期限が切れると、サービスによって独自の既定値が適用されます。
例 2: 明示的な既定のアクションを使用してライフサイクル フックを作成する
$hook = New-AzVmssLifecycleHookConfig -Type 'UpgradeAutoOSRollingBatchStarting' -WaitDuration 'PT30M' -DefaultAction 'Approve'
この例では、各ローリング バッチが開始される前に起動するライフサイクル フックを作成します。これには、30 分の待機時間と、明示的な既定のアクションとして [承認] が指定されています。
例 3: 新しい 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 を作成します。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultAction
待機時間が経過する前にプラットフォームが顧客からの応答を受け取らない場合に、ライフサイクル フック イベントのターゲット リソースに適用されるアクションを指定します。 受け入れ可能な値: 'Approve'、'Reject'。 省略した場合、サービスは独自の既定値を適用します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| 指定可能な値: | Approve, Reject |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 2 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-DefaultProfile
Azureとの通信に使用される資格情報、アカウント、テナント、サブスクリプション。
パラメーターのプロパティ
| 型: | IAzureContextContainer |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Type
ライフサイクルフックの種類を指定します。 指定できる値: 'UpgradeAutoOSScheduling'、'UpgradeAutoOSRollingBatchStarting'。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| 指定可能な値: | UpgradeAutoOSScheduling, UpgradeAutoOSRollingBatchStarting |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WaitDuration
ライフサイクル フック イベントが顧客の応答を待機してから既定のアクションを適用する時間を指定します。 "PT8H" (8 時間) や "PT30M" (30 分) など、ISO 8601 の期間形式にする必要があります。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | 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を参照してください。
