az devcenter admin pool
Note
This reference is part of the devcenter extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az devcenter admin pool command. Learn more about extensions.
Manage pools.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az devcenter admin pool create |
Create a pool. |
Extension | GA |
| az devcenter admin pool delete |
Delete a pool. |
Extension | GA |
| az devcenter admin pool list |
List pools for a project. |
Extension | GA |
| az devcenter admin pool run-health-check |
Triggers a refresh of the pool status. |
Extension | GA |
| az devcenter admin pool show |
Get a pool. |
Extension | GA |
| az devcenter admin pool update |
Update a pool. |
Extension | GA |
| az devcenter admin pool wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az devcenter admin pool create
Create a pool.
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}]Examples
Create pool using unmanaged network
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"Create pool using managed network
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"Create a pool with stop on disconnect 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"Create pool using image definition
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"Required Parameters
Indicates whether owners of dev boxes in this pool are added as local administrators on the dev box.
Name of the pool.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Image reference information for a definition of the machines that are created from this pool. Will be ignored if the parameter devbox-definition-type is Reference or not provided. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of a dev box definition in parent project of this pool. Will be ignored if the parameter devbox-definition-type is Value.
The SKU for Dev Boxes created from the Pool. Will be ignored if the parameter devbox-definition-type is Reference or not provided. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.
The display name of the pool.
The geo-location where the resource lives. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>. When not specified, the location of the resource group will be used.
The regions of the managed virtual network (required when managedNetworkType is Managed). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of a network connection in parent project of this pool.
Do not wait for the long-running operation to finish.
Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.
Stop on disconnect configuration settings for dev boxes created in this pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Stop on no connect configuration settings for Dev Boxes created in this pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin pool delete
Delete a pool.
az devcenter admin pool delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--project]
[--resource-group]
[--subscription]
[--yes]Examples
Delete
az devcenter admin pool delete --name "DevPool" --project-name "DevProject" --resource-group "rg1"Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the pool.
Do not wait for the long-running operation to finish.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin pool list
List pools for a project.
az devcenter admin pool list --project
--resource-group
[--max-items]
[--next-token]Examples
List
az devcenter admin pool list --project-name "DevProject" --resource-group "rg1"Required Parameters
The name of the project. Use az configure -d project=<project_name> to configure a default.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin pool run-health-check
Triggers a refresh of the pool status.
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]Examples
Run health check
az devcenter admin pool run-health-check --name "DevPool" --project-name "DevProject" --resource-group "rg1"Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the pool.
Do not wait for the long-running operation to finish.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin pool show
Get a pool.
az devcenter admin pool show [--ids]
[--name]
[--project]
[--resource-group]
[--subscription]Examples
Get
az admin pool show --name "DevPool" --project-name "DevProject" --resource-group "rg1"Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the pool.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin pool update
Update a pool.
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}]Examples
Update
az devcenter admin pool update --devbox-definition-name "WebDevBox2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --stop-on-disconnect status="Disabled"Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
Image reference information for a definition of the machines that are created from this pool. Will be ignored if the parameter devbox-definition-type is Reference or not provided. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of a dev box definition in parent project of this pool. Will be ignored if the parameter devbox-definition-type is Value.
The SKU for Dev Boxes created from the Pool. Will be ignored if the parameter devbox-definition-type is Reference or not provided. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.
The display name of the pool.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Indicates whether owners of dev boxes in this pool are added as local administrators on the dev box.
The regions of the managed virtual network (required when managedNetworkType is Managed). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of the pool.
Name of a network connection in parent project of this pool.
Do not wait for the long-running operation to finish.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.
Stop on disconnect configuration settings for dev boxes created in this pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Stop on no connect configuration settings for Dev Boxes created in this pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devcenter admin pool wait
Place the CLI in a waiting state until a condition is met.
az devcenter admin pool wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--project]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
Name of the pool.
The name of the project. Use az configure -d project=<project_name> to configure a default.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
