az devcenter admin devbox-definition

Note

此參考是 Azure CLI 的 devcenter 延伸模組的一部分（2.67.0 版或更高版本）。擴充功能會在您第一次執行 az devcenter admin devbox-definition 命令時自動安裝。深入了解擴充功能。

管理開發方塊定義。

命令

名稱	Description	類型	狀態
az devcenter admin devbox-definition create	建立開發方塊定義。	Extension	GA
az devcenter admin devbox-definition delete	刪除開發方塊定義。	Extension	GA
az devcenter admin devbox-definition list	列出為開發人員中心或專案設定的開發方塊定義。	Extension	GA
az devcenter admin devbox-definition show	取得為開發人員中心或專案設定的開發方塊定義。	Extension	GA
az devcenter admin devbox-definition update	更新開發方塊定義。	Extension	GA
az devcenter admin devbox-definition wait	將 CLI 置於等候狀態，直到符合條件為止。	Extension	GA

az devcenter admin devbox-definition create

建立開發方塊定義。

az devcenter admin devbox-definition create --dev-center --dev-center-name
                                            --devbox-definition-name --name
                                            --image-reference
                                            --os-storage-type
                                            --resource-group
                                            --sku
                                            [--hibernate-support {Disabled, Enabled}]
                                            [--location]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--tags]

範例

Create

az devcenter admin devbox-definition create --location "eastus" --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" --os-storage-type "ssd_1024gb" --sku name="general_a_8c32gb_v1" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

必要參數

--dev-center --dev-center-name -d

開發人員中心的名稱。使用 az configure -d dev-center=<dev_center_name> 來設定預設值。

--devbox-definition-name --name -n

開發方塊定義的名稱。

--image-reference

影像參考資訊。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--os-storage-type

用於使用此定義建立之開發方塊之操作系統磁碟的記憶體類型。

屬性	值
參數群組:	Properties Arguments

--resource-group -g

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

--sku

使用此定義建立之開發方塊的 SKU。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

選擇性參數

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

--hibernate-support

指出使用此定義建立的開發方塊是否能夠休眠。並非所有映像都能夠支援休眠。若要深入瞭解，請參閱 https://aka.ms/devbox/hibernate。

屬性	值
參數群組:	Properties Arguments
接受的值:	Disabled, Enabled

--location -l

資源所在的地理位置。值的來源：az account list-locations。您可以使用 az configure --defaults location=<location>來設定預設位置。未指定時，將會使用資源群組的位置。

屬性	值
參數群組:	Body Arguments

--no-wait

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

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

--tags

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

屬性	值
參數群組:	Body 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 devcenter admin devbox-definition delete

刪除開發方塊定義。

az devcenter admin devbox-definition delete [--dev-center --dev-center-name]
                                            [--devbox-definition-name --name]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]
                                            [--yes]

範例

Delete

az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

選擇性參數

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

--dev-center --dev-center-name -d

開發人員中心的名稱。使用 az configure -d dev-center=<dev_center_name> 來設定預設值。

屬性	值
參數群組:	Resource Id Arguments

--devbox-definition-name --name -n

開發方塊定義的名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

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

屬性	值
參數群組:	Resource Id Arguments

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

--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 devcenter admin devbox-definition list

列出為開發人員中心或專案設定的開發方塊定義。

az devcenter admin devbox-definition list --resource-group
                                          [--dev-center --dev-center-name]
                                          [--max-items]
                                          [--next-token]
                                          [--project --project-name]

範例

依開發人員中心列出

az devcenter admin devbox-definition list --dev-center-name "Contoso" --resource-group "rg1"

依專案列出

az devcenter admin devbox-definition list --project-name "ContosoProject" --resource-group "rg1"

必要參數

--resource-group -g

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

選擇性參數

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

--dev-center --dev-center-name -d

開發人員中心的名稱。使用 az configure -d dev-center=<dev_center_name> 來設定預設值。

--max-items

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

屬性	值
參數群組:	Pagination Arguments

--next-token

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

屬性	值
參數群組:	Pagination Arguments

--project --project-name

項目的名稱。使用 az configure -d project=<project_name> 來設定預設值。

全域參數

--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 devcenter admin devbox-definition show

取得為開發人員中心或專案設定的開發方塊定義。

az devcenter admin devbox-definition show [--dev-center --dev-center-name]
                                          [--devbox-definition-name --name]
                                          [--ids]
                                          [--project --project-name]
                                          [--resource-group]
                                          [--subscription]

範例

取得開發人員中心開發人員方塊定義

az devcenter admin devbox-definition show --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

取得項目開發方塊定義

az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1"

選擇性參數

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

--dev-center --dev-center-name -d

開發人員中心的名稱。使用 az configure -d dev-center=<dev_center_name> 來設定預設值。

屬性	值
參數群組:	Resource Id Arguments

--devbox-definition-name --name -n

開發方塊定義的名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--project --project-name

項目的名稱。使用 az configure -d project=<project_name> 來設定預設值。

屬性	值
參數群組:	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

全域參數

--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 devcenter admin devbox-definition update

更新開發方塊定義。

az devcenter admin devbox-definition update [--add]
                                            [--dev-center --dev-center-name]
                                            [--devbox-definition-name --name]
                                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--hibernate-support {Disabled, Enabled}]
                                            [--ids]
                                            [--image-reference]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--os-storage-type]
                                            [--remove]
                                            [--resource-group]
                                            [--set]
                                            [--sku]
                                            [--subscription]
                                            [--tags]

範例

Update

az devcenter admin devbox-definition update --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

選擇性參數

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

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。範例： --add property.listProperty <key=value, string or JSON string>.

屬性	值
參數群組:	Generic Update Arguments

--dev-center --dev-center-name -d

開發人員中心的名稱。使用 az configure -d dev-center=<dev_center_name> 來設定預設值。

屬性	值
參數群組:	Resource Id Arguments

--devbox-definition-name --name -n

開發方塊定義的名稱。

屬性	值
參數群組:	Resource Id Arguments

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

屬性	值
參數群組:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--hibernate-support

指出使用此定義建立的開發方塊是否能夠休眠。並非所有映像都能夠支援休眠。若要深入瞭解，請參閱 https://aka.ms/devbox/hibernate。

屬性	值
參數群組:	Properties Arguments
接受的值:	Disabled, Enabled

--ids

屬性	值
參數群組:	Resource Id Arguments

--image-reference

影像參考資訊。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--no-wait

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

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

--os-storage-type

用於使用此定義建立之開發方塊之操作系統磁碟的記憶體類型。

屬性	值
參數群組:	Properties Arguments

--remove

從清單中移除屬性或專案。範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性	值
參數群組:	Generic Update Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--set

指定要設定的屬性路徑和值，以更新物件。範例： --set property1.property2=<value>.

屬性	值
參數群組:	Generic Update Arguments

--sku

使用此定義建立之開發方塊的 SKU。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--tags

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

屬性	值
參數群組:	Body 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 devcenter admin devbox-definition wait

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

az devcenter admin devbox-definition wait [--created]
                                          [--custom]
                                          [--deleted]
                                          [--dev-center --dev-center-name]
                                          [--devbox-definition-name --name]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--resource-group]
                                          [--subscription]
                                          [--timeout]
                                          [--updated]

選擇性參數

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

--created

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

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

--custom

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

屬性	值
參數群組:	Wait Condition Arguments

--deleted

等到刪除為止。

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

--dev-center --dev-center-name -d

開發人員中心的名稱。使用 az configure -d dev-center=<dev_center_name> 來設定預設值。

屬性	值
參數群組:	Resource Id Arguments

--devbox-definition-name --name -n

開發方塊定義的名稱。

屬性	值
參數群組:	Resource Id Arguments

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

全域參數

--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 devcenter admin devbox-definition

命令

az devcenter admin devbox-definition create

範例

必要參數

選擇性參數

az devcenter admin devbox-definition delete

範例

選擇性參數

az devcenter admin devbox-definition list

範例

必要參數

選擇性參數

az devcenter admin devbox-definition show

範例

選擇性參數

az devcenter admin devbox-definition update

範例

選擇性參數

az devcenter admin devbox-definition wait

選擇性參數

意見反應