az devcenter admin pool

Note

This reference is part of the devcenter extension for the Azure CLI (version 2.67.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 --pool-name
                               --project --project-name
                               --resource-group
                               [--active-hours-configuration]
                               [--dev-box-tunnel-enable-status {Disabled, Enabled}]
                               [--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" --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"

Create pool with active hours configuration

az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Managed" --managed-virtual-network-region ["westus3"] --active-hours-configuration auto-start-enable-status="Enabled" default-end-time-hour="17" default-start-time-hour="9" default-time-zone="America/Los_Angeles" keep-awake-enable-status="Enabled"

Required Parameters

--local-administrator

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

Property	Value
Parameter group:	Properties Arguments
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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--active-hours-configuration -a

Active hours configuration settings for Dev Boxes created in this pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--dev-box-tunnel-enable-status -u

Indicates whether Dev Box Tunnel is enabled for a the pool.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--devbox-definition-image-reference -i

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.

Property	Value
Parameter group:	DevBoxDefinition Arguments

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

Property	Value
Parameter group:	Properties Arguments

--devbox-definition-sku -s

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.

Property	Value
Parameter group:	DevBoxDefinition Arguments

--devbox-definition-type -t

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Reference, Value

--display-name

The display name of the pool.

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Body Arguments

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

Property	Value
Parameter group:	Properties Arguments

--network-connection-name -c

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

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

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

Property	Value
Parameter group:	Properties Arguments
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.

Property	Value
Parameter group:	Properties Arguments

--stop-on-no-connect

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.

Property	Value
Parameter group:	Properties Arguments

--tags

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

Property	Value
Parameter group:	Body Arguments

--virtual-network-type

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Managed, Unmanaged

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az devcenter admin pool delete

Delete a pool.

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

Examples

Delete

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name --pool-name -n

Name of the pool.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az devcenter admin pool list

List pools for a project.

az devcenter admin pool list --project --project-name
                             --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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az devcenter admin pool run-health-check

Triggers a refresh of the pool status.

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

Examples

Run health check

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name --pool-name -n

Name of the pool.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az devcenter admin pool show

Get a pool.

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

Examples

Get

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name --pool-name -n

Name of the pool.

Property	Value
Parameter group:	Resource Id Arguments

--project --project-name

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az devcenter admin pool update

Update a pool.

az devcenter admin pool update [--active-hours-configuration]
                               [--add]
                               [--dev-box-tunnel-enable-status {Disabled, Enabled}]
                               [--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 --pool-name]
                               [--network-connection-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--project --project-name]
                               [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--active-hours-configuration -a

Active hours configuration settings for Dev Boxes created in this pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Generic Update Arguments

--dev-box-tunnel-enable-status -u

Indicates whether Dev Box Tunnel is enabled for a the pool.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--devbox-definition-image-reference -i

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.

Property	Value
Parameter group:	DevBoxDefinition Arguments

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

Property	Value
Parameter group:	Properties Arguments

--devbox-definition-sku -s

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.

Property	Value
Parameter group:	DevBoxDefinition Arguments

--devbox-definition-type -t

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Reference, Value

--display-name

The display name of the pool.

Property	Value
Parameter group:	Properties Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--local-administrator

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

Property	Value
Parameter group:	Properties Arguments
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.

Property	Value
Parameter group:	Properties Arguments

--name --pool-name -n

Name of the pool.

Property	Value
Parameter group:	Resource Id Arguments

--network-connection-name -c

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

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

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

Property	Value
Parameter group:	Properties Arguments
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.

Property	Value
Parameter group:	Properties Arguments

--stop-on-no-connect

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.

Property	Value
Parameter group:	Properties Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--tags

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

Property	Value
Parameter group:	Body Arguments

--virtual-network-type

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Managed, Unmanaged

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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 --pool-name]
                             [--project --project-name]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --pool-name -n

Name of the pool.

Property	Value
Parameter group:	Resource Id Arguments

--project --project-name

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False