az networkcloud virtualmachine console

注

このリファレンスは、Azure CLI (バージョン 2.67.0 以降) の networkcloud 拡張機能の一部です。 拡張機能は、 az networkcloud virtualmachine コンソール コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

仮想マシンのコンソールを管理します。

コマンド

名前	説明	型	状態
az networkcloud virtualmachine console create	新しい仮想マシン コンソールを作成するか、既存の仮想マシン コンソールのプロパティを更新します。	拡張	GA
az networkcloud virtualmachine console delete	指定された仮想マシン コンソールを削除します。	拡張	GA
az networkcloud virtualmachine console list	仮想マシンのコンソールを一覧表示します。	拡張	GA
az networkcloud virtualmachine console show	指定された仮想マシン コンソールのプロパティを取得します。	拡張	GA
az networkcloud virtualmachine console update	指定された仮想マシン コンソールのプロパティを更新するか、仮想マシン コンソールに関連付けられているタグを更新します。 プロパティとタグの更新を、個別に実行できます。	拡張	GA
az networkcloud virtualmachine console wait	条件が満たされるまで CLI を待機状態にします。	拡張	GA

az networkcloud virtualmachine console create

新しい仮想マシン コンソールを作成するか、既存の仮想マシン コンソールのプロパティを更新します。

各仮想マシンに対して 1 つのコンソールが許可され、常に "default" という名前が付けられます。

az networkcloud virtualmachine console create --enabled {False, True}
                                              --extended-location
                                              --resource-group
                                              --ssh-public-key
                                              --virtual-machine-name
                                              [--expiration]
                                              [--if-match]
                                              [--if-none-match]
                                              [--location]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--tags]

例

仮想マシン コンソールを作成または更新する

az networkcloud virtualmachine console create --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --location "location" --enabled "True" --expiration "2024-06-01T01:27:03.008Z" --ssh-public-key key-data="ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

SSH キー ファイルを使用して仮想マシン コンソールを作成または更新する

az networkcloud virtualmachine console create --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --location "location" --enabled "True" --expiration "2024-06-01T01:27:03.008Z" --ssh-public-key key-data=~/.ssh/id_rsa.pub --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

必須のパラメーター

--enabled

コンソール アクセスが有効になっているかどうかを示すインジケーター。

指定可能な値: False, True

--extended-location

この仮想マシンが作成されるクラスターに関連付けられているクラスター マネージャーの拡張場所。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--resource-group -g

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

--ssh-public-key

ユーザー アクセス用にプロビジョニングされる SSH 公開キー。 ユーザーには、ログイン用の対応する SSH 秘密キーが必要です。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--virtual-machine-name

仮想マシンの名前。

省略可能のパラメーター

--expiration

キーがアクセスを許可しない日付と時刻。

--if-match

変換の ETag。 現在のリソースを常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。

--if-none-match

新しいレコード セットの作成を許可するが、既存のリソースを更新できないようにするには、'*' に設定します。 その他の値はサポートされていないため、サーバーからエラーが発生します。

--location -l

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

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--tags

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

グローバル パラメーター

--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 networkcloud virtualmachine console delete

指定された仮想マシン コンソールを削除します。

az networkcloud virtualmachine console delete [--ids]
                                              [--if-match]
                                              [--if-none-match]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--resource-group]
                                              [--subscription]
                                              [--virtual-machine-name]
                                              [--yes]

例

仮想マシン コンソールを削除する

az networkcloud virtualmachine console delete --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

省略可能のパラメーター

--ids

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

--if-match

変換の ETag。 現在のリソースを常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。

--if-none-match

新しいレコード セットの作成を許可するが、既存のリソースを更新できないようにするには、'*' に設定します。 その他の値はサポートされていないため、サーバーからエラーが発生します。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--subscription

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

--virtual-machine-name

仮想マシンの名前。

--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 networkcloud virtualmachine console list

仮想マシンのコンソールを一覧表示します。

az networkcloud virtualmachine console list --resource-group
                                            --virtual-machine-name
                                            [--max-items]
                                            [--next-token]

例

仮想マシンのコンソールを一覧表示する

az networkcloud virtualmachine console list --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

必須のパラメーター

--resource-group -g

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

--virtual-machine-name

仮想マシンの名前。

省略可能のパラメーター

--max-items

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

--next-token

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

グローバル パラメーター

--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 networkcloud virtualmachine console show

指定された仮想マシン コンソールのプロパティを取得します。

az networkcloud virtualmachine console show [--ids]
                                            [--resource-group]
                                            [--subscription]
                                            [--virtual-machine-name]

例

仮想マシン コンソールを取得する

az networkcloud virtualmachine console show --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

省略可能のパラメーター

--ids

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

--resource-group -g

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

--subscription

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

--virtual-machine-name

仮想マシンの名前。

グローバル パラメーター

--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 networkcloud virtualmachine console update

指定された仮想マシン コンソールのプロパティを更新するか、仮想マシン コンソールに関連付けられているタグを更新します。 プロパティとタグの更新を、個別に実行できます。

az networkcloud virtualmachine console update [--enabled {False, True}]
                                              [--expiration]
                                              [--ids]
                                              [--if-match]
                                              [--if-none-match]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--resource-group]
                                              [--ssh-public-key]
                                              [--subscription]
                                              [--tags]
                                              [--virtual-machine-name]

例

仮想マシン コンソールにパッチを適用する

az networkcloud virtualmachine console update --enabled "True" --expiration "2022-06-01T01:27:03.008Z" --ssh-public-key key-data="ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

SSH キー ファイルを使用して仮想マシン コンソールにパッチを適用する

az networkcloud virtualmachine console update --enabled "True" --expiration "2022-06-01T01:27:03.008Z" --ssh-public-key key-data=~/.ssh/id_rsa.pub --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"

省略可能のパラメーター

--enabled

コンソール アクセスが有効になっているかどうかを示すインジケーター。

指定可能な値: False, True

--expiration

キーがアクセスを許可しない日付と時刻。

--ids

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

--if-match

変換の ETag。 現在のリソースを常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。

--if-none-match

新しいレコード セットの作成を許可するが、既存のリソースを更新できないようにするには、'*' に設定します。 その他の値はサポートされていないため、サーバーからエラーが発生します。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--ssh-public-key

ユーザー アクセス用にプロビジョニングされる SSH 公開キー。 ユーザーには、ログイン用の対応する SSH 秘密キーが必要です。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--subscription

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

--tags

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

--virtual-machine-name

仮想マシンの名前。

グローバル パラメーター

--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 networkcloud virtualmachine console wait

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

az networkcloud virtualmachine console wait [--console-name]
                                            [--created]
                                            [--custom]
                                            [--deleted]
                                            [--exists]
                                            [--ids]
                                            [--interval]
                                            [--resource-group]
                                            [--subscription]
                                            [--timeout]
                                            [--updated]
                                            [--virtual-machine-name]

省略可能のパラメーター

--console-name --name -n

仮想マシン コンソールの名前。

--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

--resource-group -g

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

--subscription

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

--timeout

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

規定値: 3600

--updated

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

規定値: False

--virtual-machine-name

仮想マシンの名前。

グローバル パラメーター

--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 を使用します。