Share via

az devcenter admin pool

  • Reference

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

--local-administrator

Indicates whether owners of dev boxes in this pool are added as local administrators on the dev box.

Accepted values: Disabled, Enabled
--name --pool-name -n

Name of the pool.

--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--devbox-definition-image-reference -i
Preview

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.

--devbox-definition-name -d

Name of a dev box definition in parent project of this pool. Will be ignored if the parameter devbox-definition-type is Value.

--devbox-definition-sku -s
Preview

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.

--devbox-definition-type -t

Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.

Accepted values: Reference, Value
--display-name

The display name of the pool.

--location -l

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.

--managed-virtual-network-regions -m

The regions of the managed virtual network (required when managedNetworkType is Managed). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--network-connection-name -c

Name of a network connection in parent project of this pool.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--single-sign-on-status

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.

Accepted values: Disabled, Enabled
--stop-on-disconnect

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
Preview

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.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--virtual-network-type

Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.

Accepted values: Managed, Unmanaged
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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

--ids

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 --pool-name -n

Name of the pool.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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

--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--max-items

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.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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

--ids

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 --pool-name -n

Name of the pool.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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

--ids

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 --pool-name -n

Name of the pool.

--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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

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

--devbox-definition-image-reference -i
Preview

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.

--devbox-definition-name -d

Name of a dev box definition in parent project of this pool. Will be ignored if the parameter devbox-definition-type is Value.

--devbox-definition-sku -s
Preview

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.

--devbox-definition-type -t

Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.

Accepted values: Reference, Value
--display-name

The display name of the pool.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

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.

--local-administrator

Indicates whether owners of dev boxes in this pool are added as local administrators on the dev box.

Accepted values: Disabled, Enabled
--managed-virtual-network-regions -m

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 --pool-name -n

Name of the pool.

--network-connection-name -c

Name of a network connection in parent project of this pool.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--single-sign-on-status

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.

Accepted values: Disabled, Enabled
--stop-on-disconnect

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
Preview

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.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--virtual-network-type

Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.

Accepted values: Managed, Unmanaged
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

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.

--interval

Polling interval in seconds.

Default value: 30
--name --pool-name -n

Name of the pool.

--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.