共用方式為

az devcenter admin pool

  • 參考

注意

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

管理集區。

命令

名稱 Description 類型 狀態
az devcenter admin pool create

建立集區。

 副檔名 GA
az devcenter admin pool delete

刪除集區。

 副檔名 GA
az devcenter admin pool list

列出專案的集區。

 副檔名 GA
az devcenter admin pool run-health-check

觸發集區狀態的重新整理。

 副檔名 GA
az devcenter admin pool show

取得集區。

 副檔名 GA
az devcenter admin pool update

更新集區。

 副檔名 GA
az devcenter admin pool wait

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

 副檔名 GA

az devcenter admin pool create

建立集區。

az devcenter admin pool create --local-administrator {Disabled, Enabled}
                               --name
                               --project
                               --resource-group
                               [--devbox-definition-image-reference]
                               [--devbox-definition-name]
                               [--devbox-definition-sku]
                               [--devbox-definition-type {Reference, Value}]
                               [--display-name]
                               [--location]
                               [--managed-virtual-network-regions]
                               [--network-connection-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--single-sign-on-status {Disabled, Enabled}]
                               [--stop-on-disconnect]
                               [--stop-on-no-connect]
                               [--tags]
                               [--virtual-network-type {Managed, Unmanaged}]

範例

使用非受控網路建立集區

az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Unmanaged" --single-sign-on-status "Enabled"

使用受控網路建立集區

az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Managed" --managed-virtual-network-region ["westus3"] --single-sign-on-status "Enabled"

建立已啟用中斷連線時停止的集區

az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Unmanaged" --single-sign-on-status "Enabled" --stop-on-disconnect status="Enabled" grace-period-minutes="60"

使用映像定義建立集區

az devcenter admin pool create --location "eastus" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Unmanaged" --single-sign-on-status "Enabled" --devbox-definition-type "Value" --devbox-definition-image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/images/~Catalog~image2~project-sample-2" --devbox-definition-sku name=""general_i_8c32gb256ssd_v2"

必要參數

--local-administrator

指出此集區中的開發方塊擁有者是否新增為開發方塊上的本機系統管理員。

接受的值: Disabled, Enabled
--name --pool-name -n

集區的名稱。

--project --project-name

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

--resource-group -g

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

選擇性參數

--devbox-definition-image-reference -i
預覽

從這個集區建立之電腦定義的映像參考資訊。 如果 devbox-definition-type 參數為 Reference 或未提供，則會忽略。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--devbox-definition-name -d

此集區父項目中開發方塊定義的名稱。 如果 devbox-definition-type 參數為 Value，則會忽略。

--devbox-definition-sku -s
預覽

從集區建立之開發方塊的 SKU。 如果 devbox-definition-type 參數為 Reference 或未提供，則會忽略。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--devbox-definition-type -t

指出集區是從現有的開發箱定義建立，還是直接提供集區。

接受的值: Reference, Value
--display-name

集區的顯示名稱。

--location -l

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

--managed-virtual-network-regions -m

受控虛擬網路的區域（ManagedNetworkType 為 Managed 時需要）。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--network-connection-name -c

此集區父專案中的網路連線名稱。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--single-sign-on-status

指出是否在此集區中建立已啟用單一登錄的開發人員方塊。 也需要在租用戶上啟用單一登錄。

接受的值: Disabled, Enabled
--stop-on-disconnect

停止在此集區中建立之開發方塊的中斷聯機組態設定。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--stop-on-no-connect
預覽

停止在此集區中建立之開發方塊的聯機組態設定。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--tags

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

--virtual-network-type

指出集區使用Microsoft或客戶提供的網路所管理的 虛擬網絡。

接受的值: Managed, Unmanaged
全域參數
--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 devcenter admin pool delete

刪除集區。

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

範例

刪除

az devcenter admin pool delete --name "DevPool" --project-name "DevProject" --resource-group "rg1"

選擇性參數

--ids

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

--name --pool-name -n

集區的名稱。

--no-wait

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

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

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

--resource-group -g

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

--subscription

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

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az devcenter admin pool list

列出專案的集區。

az devcenter admin pool list --project
                             --resource-group
                             [--max-items]
                             [--next-token]

範例

清單​​

az devcenter admin pool list --project-name "DevProject" --resource-group "rg1"

必要參數

--project --project-name

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

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<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

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az devcenter admin pool run-health-check

觸發集區狀態的重新整理。

az devcenter admin pool run-health-check [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--project]
                                         [--resource-group]
                                         [--subscription]

範例

執行健康情況檢查

az devcenter admin pool run-health-check --name "DevPool" --project-name "DevProject" --resource-group "rg1"

選擇性參數

--ids

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

--name --pool-name -n

集區的名稱。

--no-wait

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

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

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

--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 devcenter admin pool show

取得集區。

az devcenter admin pool show [--ids]
                             [--name]
                             [--project]
                             [--resource-group]
                             [--subscription]

範例

取得 Yammer

az admin pool show --name "DevPool" --project-name "DevProject" --resource-group "rg1"

選擇性參數

--ids

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

--name --pool-name -n

集區的名稱。

--project --project-name

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

--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 devcenter admin pool update

更新集區。

az devcenter admin pool update [--add]
                               [--devbox-definition-image-reference]
                               [--devbox-definition-name]
                               [--devbox-definition-sku]
                               [--devbox-definition-type {Reference, Value}]
                               [--display-name]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--local-administrator {Disabled, Enabled}]
                               [--managed-virtual-network-regions]
                               [--name]
                               [--network-connection-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--project]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--single-sign-on-status {Disabled, Enabled}]
                               [--stop-on-disconnect]
                               [--stop-on-no-connect]
                               [--subscription]
                               [--tags]
                               [--virtual-network-type {Managed, Unmanaged}]

範例

更新

az devcenter admin pool update --devbox-definition-name "WebDevBox2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --stop-on-disconnect status="Disabled"

選擇性參數

--add

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

--devbox-definition-image-reference -i
預覽

從這個集區建立之電腦定義的映像參考資訊。 如果 devbox-definition-type 參數為 Reference 或未提供，則會忽略。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--devbox-definition-name -d

此集區父項目中開發方塊定義的名稱。 如果 devbox-definition-type 參數為 Value，則會忽略。

--devbox-definition-sku -s
預覽

從集區建立之開發方塊的 SKU。 如果 devbox-definition-type 參數為 Reference 或未提供，則會忽略。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--devbox-definition-type -t

指出集區是從現有的開發箱定義建立，還是直接提供集區。

接受的值: Reference, Value
--display-name

集區的顯示名稱。

--force-string

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

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

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

--local-administrator

指出此集區中的開發方塊擁有者是否新增為開發方塊上的本機系統管理員。

接受的值: Disabled, Enabled
--managed-virtual-network-regions -m

受控虛擬網路的區域（ManagedNetworkType 為 Managed 時需要）。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--name --pool-name -n

集區的名稱。

--network-connection-name -c

此集區父專案中的網路連線名稱。

--no-wait

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

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

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

--remove

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

--resource-group -g

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

--set

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

--single-sign-on-status

指出是否在此集區中建立已啟用單一登錄的開發人員方塊。 也需要在租用戶上啟用單一登錄。

接受的值: Disabled, Enabled
--stop-on-disconnect

停止在此集區中建立之開發方塊的中斷聯機組態設定。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--stop-on-no-connect
預覽

停止在此集區中建立之開發方塊的聯機組態設定。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--subscription

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

--tags

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

--virtual-network-type

指出集區使用Microsoft或客戶提供的網路所管理的 虛擬網絡。

接受的值: Managed, Unmanaged
全域參數
--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 devcenter admin pool wait

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

az devcenter admin pool wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name]
                             [--project]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

選擇性參數

--created

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

預設值: False
--custom

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

--deleted

等到刪除為止。

預設值: False
--exists

等候資源存在。

預設值: False
--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30
--name --pool-name -n

集區的名稱。

--project --project-name

專案的名稱。 使用 az configure -d project=<project_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 來取得完整偵錯記錄。