az standby-vm-pool

  • リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.57.0 以降) のスタンバイプール拡張機能の一部です。 拡張機能は、az standby-vm-pool コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

スタンバイ仮想マシン プールの操作。

コマンド

名前 説明 型 Status
az standby-vm-pool create

スタンバイ仮想マシン プールを作成します。

 拡張子 GA
az standby-vm-pool delete

スタンバイ仮想マシン プールを削除します。

 拡張子 GA
az standby-vm-pool list

サブスクリプションまたはリソース グループ別にスタンバイ仮想マシン プールを一覧表示します。

 拡張子 GA
az standby-vm-pool show

スタンバイ仮想マシン プールを取得します。

 拡張子 GA
az standby-vm-pool update

スタンバイ仮想マシン プールを更新します。

 拡張子 GA
az standby-vm-pool vm

スタンバイ仮想マシン プール内の仮想マシン。

 拡張子 GA
az standby-vm-pool vm list

スタンバイ仮想マシン プール内の仮想マシンを一覧表示します。

 拡張子 GA
az standby-vm-pool wait

条件が満たされるまで CLI を待機状態にします。

 拡張子 GA

az standby-vm-pool create

スタンバイ仮想マシン プールを作成します。

az standby-vm-pool create --name
                          --resource-group
                          [--location]
                          [--max-ready-capacity]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--tags]
                          [--vm-state {Deallocated, Running}]
                          [--vmss-id]

例

スタンバイ仮想マシン プールを作成する

az standby-vm-pool create --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg --name mypool --max-ready-capacity 20 --vm-state Running --vmss-id /subscriptions/461fa159-654a-415f-853a-40b801021944/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachineScaleSets/myvmss

コンテキストを使用してサブスクリプションとリソース グループセットを使用して作成する

az standby-vm-pool create --name mypool --max-ready-capacity 20 --vm-state Running --vmss-id /subscriptions/461fa159-654a-415f-853a-40b801021944/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachineScaleSets/myvmss

必須のパラメーター

--name -n

スタンバイ仮想マシン プールの名前。

--resource-group -g

リソース グループの名前。

省略可能のパラメーター

--location -l

リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。

--max-ready-capacity

スタンバイ仮想マシン プール内の仮想マシンの最大数を指定します。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--vm-state

プール内の仮想マシンの望ましい状態を指定します。

承認された値: Deallocated, Running
--vmss-id

プールがアタッチされている仮想マシン スケール セットの完全修飾リソース ID を指定します。

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

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az standby-vm-pool delete

スタンバイ仮想マシン プールを削除します。

az standby-vm-pool delete [--ids]
                          [--name]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--resource-group]
                          [--subscription]
                          [--yes]

例

スタンバイ仮想マシン プールの削除

az standby-vm-pool delete --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg --name mypool

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

スタンバイ仮想マシン プールの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

リソース グループの名前。

--subscription

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

--yes -y

確認のダイアログを表示しません。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az standby-vm-pool list

サブスクリプションまたはリソース グループ別にスタンバイ仮想マシン プールを一覧表示します。

az standby-vm-pool list [--max-items]
                        [--next-token]
                        [--resource-group]

例

サブスクリプション ID で一覧表示する

az standby-vm-pool list -- subscription 461fa159-654a-415f-853a-40b801021944

リソース グループ別に一覧表示する

az standby-vm-pool list --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

--resource-group -g

リソース グループの名前。

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

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az standby-vm-pool show

スタンバイ仮想マシン プールを取得します。

az standby-vm-pool show [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

例

スタンバイ仮想マシン プールを取得する

az standby-vm-pool show --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg --name mypool

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

スタンバイ仮想マシン プールの名前。

--resource-group -g

リソース グループの名前。

--subscription

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

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

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az standby-vm-pool update

スタンバイ仮想マシン プールを更新します。

az standby-vm-pool update [--ids]
                          [--max-ready-capacity]
                          [--name]
                          [--resource-group]
                          [--subscription]
                          [--tags]
                          [--vm-state {Deallocated, Running}]
                          [--vmss-id]

例

最大準備容量を更新する

az standby-vm-pool update --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg --name mypool --max-ready-capacity 3

仮想マシンの状態の更新

az standby-vm-pool update --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg --name mypool --vm-state Deallocate

アタッチされた仮想マシン スケール セットを更新する

az standby-vm-pool update --subscription 461fa159-654a-415f-853a-40b801021944 --resource-group myrg --name mypool --vmss-id /subscriptions/461fa159-654a-415f-853a-40b801021944/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachineScaleSets/testvmss

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--max-ready-capacity

スタンバイ仮想マシン プール内の仮想マシンの最大数を指定します。

--name -n

スタンバイ仮想マシン プールの名前。

--resource-group -g

リソース グループの名前。

--subscription

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

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--vm-state

プール内の仮想マシンの望ましい状態を指定します。

承認された値: Deallocated, Running
--vmss-id

プールがアタッチされている仮想マシン スケール セットの完全修飾リソース ID を指定します。

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

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az standby-vm-pool wait

条件が満たされるまで CLI を待機状態にします。

az standby-vm-pool wait [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--ids]
                        [--interval]
                        [--name]
                        [--resource-group]
                        [--subscription]
                        [--timeout]
                        [--updated]

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False
--exists

リソースが存在するまで待ちます。

既定値: False
--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

ポーリング間隔 (秒単位)。

既定値: 30
--name -n

スタンバイ仮想マシン プールの名前。

--resource-group -g

リソース グループの名前。

--subscription

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

--timeout

最大待機時間 (秒単位)。

既定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。