az lab vm

預覽
參考

命令群組『lab』處於預覽狀態，且正在開發中。參考和支持層級：https://aka.ms/CLI_refstatus

在 Azure devtest 實驗室中管理 VM。

命令

名稱	Description	類型	狀態
az lab vm apply-artifacts	將成品套用至虛擬機。此作業可能需要一段時間才能完成。	核心	預覽
az lab vm claim	在 Azure DevTest Lab 中宣告 VM 的命令。	核心	預覽
az lab vm create	在實驗室中建立 VM。	核心	預覽
az lab vm delete	刪除虛擬機。此作業可能需要一段時間才能完成。	核心	預覽
az lab vm hibernate	休眠虛擬機此作業可能需要一段時間才能完成。	核心	預覽
az lab vm list	列出指定實驗室中的虛擬機。	核心	預覽
az lab vm show	顯示虛擬機。	核心	預覽
az lab vm start	啟動虛擬機。此作業可能需要一段時間才能完成。	核心	預覽
az lab vm stop	停止虛擬機此作業可能需要一段時間才能完成。	核心	預覽
az lab vm wait	將 CLI 置於等候狀態，直到符合條件為止。	核心	預覽

az lab vm apply-artifacts

編輯

預覽

命令群組『lab』處於預覽狀態，且正在開發中。參考和支持層級：https://aka.ms/CLI_refstatus

將成品套用至虛擬機。此作業可能需要一段時間才能完成。

az lab vm apply-artifacts --lab-name
                          --name
                          --resource-group
                          [--artifacts]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

範例

將成品套用至 Azure DevTest Lab 中的虛擬機。

az lab vm apply-artifacts --artifacts artifacts.json --lab-name MyLab --name MyVirtualMachine --resource-group MyResourceGroup

必要參數

--lab-name

實驗室的名稱。

--name -n

虛擬機的名稱。

--resource-group -g

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

選擇性參數

--artifacts

要套用之成品 JSON 編碼數位數組的路徑。 JSON 編碼的參數清單。

--no-wait

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

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

全域參數

--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。針對完整偵錯記錄使用 --debug。

az lab vm claim

編輯

預覽

命令群組『lab』處於預覽狀態，且正在開發中。參考和支持層級：https://aka.ms/CLI_refstatus

在 Azure DevTest Lab 中宣告 VM 的命令。

az lab vm claim [--ids]
                [--lab-name]
                [--name]
                [--resource-group]
                [--subscription]

選擇性參數

--ids

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

--lab-name

實驗室的名稱。

--name -n

要宣告的虛擬機名稱。

--resource-group -g

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

--subscription

訂用帳戶的名稱或標識碼。您可以使用 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

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

--verbose

增加記錄詳細資訊。針對完整偵錯記錄使用 --debug。

az lab vm create

編輯

預覽

命令群組『lab』處於預覽狀態，且正在開發中。參考和支持層級：https://aka.ms/CLI_refstatus

在實驗室中建立 VM。

az lab vm create --lab-name
                 --name
                 --resource-group
                 [--admin-password]
                 [--admin-username]
                 [--allow-claim {0, 1, f, false, n, no, t, true, y, yes}]
                 [--artifacts]
                 [--authentication-type {password, ssh}]
                 [--disk-type {Premium, Standard, StandardSSD}]
                 [--expiration-date]
                 [--formula]
                 [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                 [--image]
                 [--image-type {custom, gallery}]
                 [--ip-configuration {private, public, shared}]
                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                 [--notes]
                 [--saved-secret]
                 [--size]
                 [--ssh-key]
                 [--subnet]
                 [--tags]
                 [--vnet-name]

必要參數

--lab-name

實驗室的名稱。

--name -n

虛擬機或環境的名稱。

--resource-group -g

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

選擇性參數

--admin-password

VM 系統管理員的密碼。

--admin-username

VM 系統管理員的用戶名稱。

預設值: your_system_user_login_name

--allow-claim

指出 VM 是否應建立為可宣告的旗標。

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

預設值: False

--artifacts

要套用之成品 JSON 編碼數位數組的路徑。 JSON 編碼的參數清單。

--authentication-type

VM 允許的驗證類型。

接受的值: password, ssh

預設值: password

--disk-type

要用於虛擬機的記憶體類型。

接受的值: Premium, Standard, StandardSSD

--expiration-date

VM 的到期日。

--formula

公式的名稱。針對可用的公式使用 az lab formula list。使用 az lab formula 搭配 --export-artifacts 旗標來導出和更新成品，然後透過 --artifacts 自變數傳遞結果。

--generate-ssh-keys

如果遺失，請產生 SSH 公開和私鑰檔案。

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

--image

作系統映像的名稱（資源庫映像名稱或自定義映像名稱/標識元）。針對可用的資源庫映像使用 az lab gallery-image list，或針對可用的自定義映射使用 az lab custom-image list。

--image-type

影像的類型。

接受的值: custom, gallery

--ip-configuration

要用於 VM 的 IP 組態類型。

接受的值: private, public, shared

--no-wait

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

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

--notes

虛擬機的附注。

--saved-secret

要用於驗證的已儲存密碼名稱。提供此值時，會用來取代其他驗證方法。

--size

要建立的 VM 大小。如需大小資訊，請參閱 https://azure.microsoft.com/pricing/details/virtual-machines/。

--ssh-key

SSH 公鑰或公鑰檔案路徑。使用 --generate-ssh-keys 來產生 SSH 金鑰。

--subnet

要新增 VM 的子網名稱。

--tags

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

--vnet-name

要新增 VM 的虛擬網路名稱。

全域參數

--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。針對完整偵錯記錄使用 --debug。

az lab vm delete

編輯

預覽

命令群組『lab』處於預覽狀態，且正在開發中。參考和支持層級：https://aka.ms/CLI_refstatus

刪除虛擬機。此作業可能需要一段時間才能完成。

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

必要參數

--lab-name

實驗室的名稱。

--name

虛擬機的名稱。

--resource-group -g

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

選擇性參數

--no-wait

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

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

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

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

--verbose

增加記錄詳細資訊。針對完整偵錯記錄使用 --debug。

az lab vm hibernate

編輯

預覽

命令群組『lab』處於預覽狀態，且正在開發中。參考和支持層級：https://aka.ms/CLI_refstatus

休眠虛擬機此作業可能需要一段時間才能完成。

az lab vm hibernate --lab-name
                    --name
                    --resource-group
                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

範例

休眠虛擬機。

az lab vm hibernate --resource-group MyResourceGroup --lab-name MyLab --name MyVM

必要參數

--lab-name

實驗室的名稱。

--name

虛擬機的名稱。

--resource-group -g

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

選擇性參數

--no-wait

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

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

全域參數

--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。針對完整偵錯記錄使用 --debug。

az lab vm list

編輯

預覽

命令群組『lab』處於預覽狀態，且正在開發中。參考和支持層級：https://aka.ms/CLI_refstatus

列出指定實驗室中的虛擬機。

az lab vm list --lab-name
               --resource-group
               [--all {0, 1, f, false, n, no, t, true, y, yes}]
               [--claimable {0, 1, f, false, n, no, t, true, y, yes}]
               [--environment]
               [--expand]
               [--filters]
               [--max-items]
               [--next-token]
               [--object-id]
               [--order-by]
               [--top]

範例

列出 Azure DevTest 實驗室中的 VM。

az lab vm list --lab-name MyLab --resource-group MyResourceGroup

必要參數

--lab-name

實驗室的名稱。

--resource-group -g

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

選擇性參數

--all

列出實驗室中的所有虛擬機。無法與 --filters搭配使用。

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

--claimable

僅列出實驗室中可宣告的虛擬機。無法與 --filters搭配使用。

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

--environment

要列出虛擬機的環境名稱或標識碼。無法與 --filters搭配使用。

--expand

指定$expand查詢。範例：'properties（$expand=artifacts，computeVm，networkInterface，applicableSchedule）'。

--filters

要套用至作業的篩選。範例：『$filter=contains（name，』myName'）。

--max-items

命令輸出中要傳回的項目總數。如果可用的專案總數超過指定的值，則會在命令的輸出中提供令牌。若要繼續分頁，請在後續命令的 --next-token 自變數中提供令牌值。

--next-token

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

--object-id

要列出 VM 之擁有者的物件標識碼。

--order-by

結果的排序表示式，使用 OData 表示法。範例：『$orderby=name desc』。

--top

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

全域參數

--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。針對完整偵錯記錄使用 --debug。

az lab vm show

編輯

預覽

命令群組『lab』處於預覽狀態，且正在開發中。參考和支持層級：https://aka.ms/CLI_refstatus

顯示虛擬機。

az lab vm show --lab-name
               --name
               --resource-group
               [--expand]

必要參數

--lab-name

實驗室的名稱。

--name

虛擬機的名稱。

--resource-group -g

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

選擇性參數

--expand

指定$expand查詢。範例：'properties（$expand=artifacts，computeVm，networkInterface，applicableSchedule）'。

全域參數

--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。針對完整偵錯記錄使用 --debug。

az lab vm start

編輯

預覽

命令群組『lab』處於預覽狀態，且正在開發中。參考和支持層級：https://aka.ms/CLI_refstatus

啟動虛擬機。此作業可能需要一段時間才能完成。

az lab vm start --lab-name
                --name
                --resource-group
                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

必要參數

--lab-name

實驗室的名稱。

--name

虛擬機的名稱。

--resource-group -g

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

選擇性參數

--no-wait

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

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

全域參數

--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。針對完整偵錯記錄使用 --debug。

az lab vm stop

編輯

預覽

命令群組『lab』處於預覽狀態，且正在開發中。參考和支持層級：https://aka.ms/CLI_refstatus

停止虛擬機此作業可能需要一段時間才能完成。

az lab vm stop --lab-name
               --name
               --resource-group
               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

必要參數

--lab-name

實驗室的名稱。

--name

虛擬機的名稱。

--resource-group -g

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

選擇性參數

--no-wait

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

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

全域參數

--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。針對完整偵錯記錄使用 --debug。

az lab vm wait

編輯

預覽

命令群組『lab』處於預覽狀態，且正在開發中。參考和支持層級：https://aka.ms/CLI_refstatus

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

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

選擇性參數

--created

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

預設值: False

--custom

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

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--expand

指定$expand查詢。範例：'properties（$expand=artifacts，computeVm，networkInterface，applicableSchedule）'。

--ids

--interval

輪詢間隔以秒為單位。

預設值: 30

--lab-name

實驗室的名稱。

--name

虛擬機的名稱。

--resource-group -g

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

--subscription

訂用帳戶的名稱或標識碼。您可以使用 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

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

--verbose

增加記錄詳細資訊。針對完整偵錯記錄使用 --debug。

共用方式為

az lab vm

命令

az lab vm apply-artifacts

範例

必要參數

選擇性參數

az lab vm claim

選擇性參數

az lab vm create

必要參數

選擇性參數

az lab vm delete

必要參數

選擇性參數

az lab vm hibernate

範例

必要參數

選擇性參數

az lab vm list

範例

必要參數

選擇性參數

az lab vm show

必要參數

選擇性參數

az lab vm start

必要參數

選擇性參數

az lab vm stop

必要參數

選擇性參數

az lab vm wait

選擇性參數

其他資源