az networkcloud virtualmachine console

Note

此參考是 Azure CLI （2.75.0 版或更新版本）的 networkcloud 延伸模組的一部分。擴充功能會在您第一次執行 az networkcloud virtualmachine 控制台命令時自動安裝。深入了解擴充功能。

管理虛擬機的控制台。

命令

名稱	Description	類型	狀態
az networkcloud virtualmachine console create	建立新的虛擬機主控台，或更新現有虛擬機主控台的屬性。	Extension	Preview
az networkcloud virtualmachine console delete	刪除提供的虛擬機控制台。	Extension	Preview
az networkcloud virtualmachine console list	列出虛擬機的控制台。	Extension	Preview
az networkcloud virtualmachine console show	取得所提供虛擬機控制台的屬性。	Extension	Preview
az networkcloud virtualmachine console update	更新所提供虛擬機控制台的屬性，或更新與虛擬機控制台相關聯的標記。屬性和標籤更新可以獨立完成。	Extension	Preview
az networkcloud virtualmachine console wait	將 CLI 置於等候狀態，直到符合條件為止。	Extension	GA

az networkcloud virtualmachine console create

預覽

此命令處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

建立新的虛擬機主控台，或更新現有虛擬機主控台的屬性。

每個虛擬機都允許單一控制台，且一律命名為『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

是否啟用主控台存取的指標。

屬性	值
參數群組:	Properties Arguments
接受的值:	False, True

--extended-location

建立此虛擬機所建立之叢集相關聯的叢集管理員擴充位置。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	ConsoleParameters Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

--ssh-public-key

將針對使用者存取布建的 SSH 公鑰。用戶預期會有對應的 SSH 私鑰來登入。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--virtual-machine-name

虛擬機器的名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--expiration

不允許存取金鑰的日期和時間。

屬性	值
參數群組:	Properties Arguments

--if-match

轉換的ETag。請省略此值以一律覆寫目前的資源。指定最後看到的 ETag 值，以防止意外覆寫並行變更。

--if-none-match

設定為『*』以允許建立新的記錄集，但為了避免更新現有的資源。其他值會導致伺服器發生錯誤，因為它們不受支援。

--location -l

未指定資源所在的地理位置，將會使用資源群組的位置。

屬性	值
參數群組:	ConsoleParameters Arguments

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--tags

資源標籤。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	ConsoleParameters Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az networkcloud virtualmachine console delete

預覽

此命令處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

刪除提供的虛擬機控制台。

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

一或多個資源識別碼（以空格分隔）。它應該是包含「資源標識碼」自變數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--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>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--virtual-machine-name

虛擬機器的名稱。

屬性	值
參數群組:	Resource Id Arguments

--yes -y

請勿提示確認。

屬性	值
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az networkcloud virtualmachine console list

預覽

此命令處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

列出虛擬機的控制台。

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

範例

列出虛擬機的控制台

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 自變數中提供令牌值。

屬性	值
參數群組:	Pagination Arguments

--next-token

標記，指定要開始分頁的位置。這是先前截斷回應中的令牌值。

屬性	值
參數群組:	Pagination Arguments

--skip-token

伺服器傳回的不透明記號，以指出要從何處繼續列出資源。這用於分頁大型結果集。

--top

從作業傳回的資源數目上限。範例：「$top=10」。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az networkcloud virtualmachine console show

預覽

此命令處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

取得所提供虛擬機控制台的屬性。

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

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--virtual-machine-name

虛擬機器的名稱。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az networkcloud virtualmachine console update

預覽

此命令處於預覽狀態，且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

更新所提供虛擬機控制台的屬性，或更新與虛擬機控制台相關聯的標記。屬性和標籤更新可以獨立完成。

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

是否啟用主控台存取的指標。

屬性	值
參數群組:	Properties Arguments
接受的值:	False, True

--expiration

不允許存取金鑰的日期和時間。

屬性	值
參數群組:	Properties Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--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>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--ssh-public-key

將針對使用者存取布建的 SSH 公鑰。用戶預期會有對應的 SSH 私鑰來登入。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--tags

將取代現有資源的 Azure 資源標籤。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	ConsoleUpdateParameters Arguments

--virtual-machine-name

虛擬機器的名稱。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az networkcloud virtualmachine console wait

將 CLI 置於等候狀態，直到符合條件為止。

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

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--console-name --name -n

虛擬機主控台名稱。

屬性	值
參數群組:	Resource Id Arguments

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--custom

等到條件符合自定義 JMESPath 查詢為止。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

屬性	值
參數群組:	Wait Condition Arguments

--deleted

等到刪除為止。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--exists

等候資源存在。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--ids

屬性	值
參數群組:	Resource Id Arguments

--interval

輪詢間隔以秒為單位。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	30

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--timeout

以秒為單位的等候上限。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	3600

--updated

等到 provisioningState 更新為 'Succeeded'。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--virtual-machine-name

虛擬機器的名稱。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

意見反應

此頁面對您有幫助嗎？

共用方式為

az networkcloud virtualmachine console

命令

az networkcloud virtualmachine console create

範例

必要參數

選擇性參數

az networkcloud virtualmachine console delete

範例

選擇性參數

az networkcloud virtualmachine console list

範例

必要參數

選擇性參數

az networkcloud virtualmachine console show

範例

選擇性參數

az networkcloud virtualmachine console update

範例

選擇性參數

az networkcloud virtualmachine console wait

選擇性參數

意見反應