az vmss lifecycle-hook

  • プレビュー

このコマンド グループはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

仮想マシン スケール セット (プレビュー) のライフサイクル フックを管理します。

コマンド

Name 説明 型 状態
az vmss lifecycle-hook add

VMSS にライフサイクル フックを追加します。

 Core Preview
az vmss lifecycle-hook list

VMSS 上のすべてのライフサイクル フックを一覧表示します。

 Core Preview
az vmss lifecycle-hook remove

VMSS から 1 つのライフサイクル フック (--type) またはすべてのライフサイクル フック (--all) を削除します。

 Core Preview
az vmss lifecycle-hook show

VMSS 上のライフサイクル フックの詳細を表示します。

 Core Preview
az vmss lifecycle-hook update

VMSS 上の既存のライフサイクル フックを更新します。

 Core Preview

az vmss lifecycle-hook add

編集
プレビュー

コマンド グループ 'vmss lifecycle-hook' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

VMSS にライフサイクル フックを追加します。

az vmss lifecycle-hook add --resource-group
                           --type {UpgradeAutoOSRollingBatchStarting, UpgradeAutoOSScheduling}
                           --vmss-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--default-action {Approve, Reject}]
                           [--no-wait]
                           [--wait-duration]

例

8 時間待機して UpgradeAutoOSScheduling フックを追加します。

az vmss lifecycle-hook add -g MyRg --vmss-name MyVmss --type UpgradeAutoOSScheduling --wait-duration PT8H

必須パラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--type

ライフサイクルフックの種類を指定します。

プロパティ 値
指定可能な値: UpgradeAutoOSRollingBatchStarting, UpgradeAutoOSScheduling
--vmss-name

VM スケール セットの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--default-action

プラットフォームが待機前にターゲットリソースに対して顧客からの応答を受け取らなかった場合、仮想マシンのスケールセットライフサイクルフックイベントで適用されるアクションを指定します。

プロパティ 値
指定可能な値: Approve, Reject
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
規定値: False
--wait-duration

仮想マシンのスケールセットが顧客に送るライフサイクルフックイベントが顧客からの応答を待つまでの期間を指定します。 ISO 8601形式であるべきです。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az vmss lifecycle-hook list

編集
プレビュー

コマンド グループ 'vmss lifecycle-hook' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

VMSS 上のすべてのライフサイクル フックを一覧表示します。

az vmss lifecycle-hook list --resource-group
                            --vmss-name

例

フックを一覧表示します。

az vmss lifecycle-hook list -g MyRg --vmss-name MyVmss

必須パラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--vmss-name

VM スケール セットの名前。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az vmss lifecycle-hook remove

編集
プレビュー

コマンド グループ 'vmss lifecycle-hook' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

VMSS から 1 つのライフサイクル フック (--type) またはすべてのライフサイクル フック (--all) を削除します。

az vmss lifecycle-hook remove --resource-group
                              --vmss-name
                              [--acquire-policy-token]
                              [--all]
                              [--change-reference]
                              [--no-wait]
                              [--type {UpgradeAutoOSRollingBatchStarting, UpgradeAutoOSScheduling}]

例

フックの種類を 1 つ削除します。

az vmss lifecycle-hook remove -g MyRg --vmss-name MyVmss --type UpgradeAutoOSScheduling

すべてのフックを削除します。

az vmss lifecycle-hook remove -g MyRg --vmss-name MyVmss --all

必須パラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--vmss-name

VM スケール セットの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--all

すべてのライフサイクル フックを削除します。 --type と相互に排他的です。

プロパティ 値
規定値: False
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
規定値: False
--type

ライフサイクルフックの種類を指定します。 --all と相互に排他的です。

プロパティ 値
指定可能な値: UpgradeAutoOSRollingBatchStarting, UpgradeAutoOSScheduling
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az vmss lifecycle-hook show

編集
プレビュー

コマンド グループ 'vmss lifecycle-hook' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

VMSS 上のライフサイクル フックの詳細を表示します。

az vmss lifecycle-hook show --resource-group
                            --type {UpgradeAutoOSRollingBatchStarting, UpgradeAutoOSScheduling}
                            --vmss-name

例

種類別にフックを表示します。

az vmss lifecycle-hook show -g MyRg --vmss-name MyVmss --type UpgradeAutoOSScheduling

必須パラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--type

ライフサイクルフックの種類を指定します。

プロパティ 値
指定可能な値: UpgradeAutoOSRollingBatchStarting, UpgradeAutoOSScheduling
--vmss-name

VM スケール セットの名前。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az vmss lifecycle-hook update

編集
プレビュー

コマンド グループ 'vmss lifecycle-hook' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

VMSS 上の既存のライフサイクル フックを更新します。

az vmss lifecycle-hook update --resource-group
                              --type {UpgradeAutoOSRollingBatchStarting, UpgradeAutoOSScheduling}
                              --vmss-name
                              [--acquire-policy-token]
                              [--change-reference]
                              [--default-action {Approve, Reject}]
                              [--no-wait]
                              [--wait-duration]

例

フックの待機時間を変更します。

az vmss lifecycle-hook update -g MyRg --vmss-name MyVmss --type UpgradeAutoOSScheduling --wait-duration PT2H

必須パラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--type

ライフサイクルフックの種類を指定します。

プロパティ 値
指定可能な値: UpgradeAutoOSRollingBatchStarting, UpgradeAutoOSScheduling
--vmss-name

VM スケール セットの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--default-action

プラットフォームが待機前にターゲットリソースに対して顧客からの応答を受け取らなかった場合、仮想マシンのスケールセットライフサイクルフックイベントで適用されるアクションを指定します。

プロパティ 値
指定可能な値: Approve, Reject
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
規定値: False
--wait-duration

仮想マシンのスケールセットが顧客に送るライフサイクルフックイベントが顧客からの応答を待つまでの期間を指定します。 ISO 8601形式であるべきです。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False