Share via


az devcenter dev dev-box

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 dev dev-box command. Learn more about extensions.

Manage dev boxes.

Commands

Name Description Type Status
az devcenter dev dev-box create

Create a dev box.

Extension GA
az devcenter dev dev-box delay-action

Delay an action.

Extension GA
az devcenter dev dev-box delay-all-actions

Delay all actions.

Extension GA
az devcenter dev dev-box delete

Delete a dev box.

Extension GA
az devcenter dev dev-box list

List dev boxes for a user, list dev boxes in the dev center for a project and user, or list dev boxes that the caller has access to in the dev center.

Extension GA
az devcenter dev dev-box list-action

List actions on a dev box.

Extension GA
az devcenter dev dev-box list-operation

Lists operations on the dev box which have occurred within the past 90 days.

Extension GA
az devcenter dev dev-box repair

Attempts automated repair steps to resolve common problems on a Dev Box. The dev box may restart during this operation.

Extension GA
az devcenter dev dev-box restart

Restart a dev box.

Extension GA
az devcenter dev dev-box show

Get a dev box.

Extension GA
az devcenter dev dev-box show-action

Get an action.

Extension GA
az devcenter dev dev-box show-operation

Get an operation on a dev box.

Extension GA
az devcenter dev dev-box show-remote-connection

Get remote connection info.

Extension GA
az devcenter dev dev-box skip-action

Skip an action.

Extension GA
az devcenter dev dev-box start

Start a dev box.

Extension GA
az devcenter dev dev-box stop

Stop a dev box.

Extension GA

az devcenter dev dev-box create

Create a dev box.

az devcenter dev dev-box create --dev-box-name
                                --pool
                                --project
                                [--dev-center]
                                [--endpoint]
                                [--no-wait]
                                [--user-id]

Examples

Create using dev center

az devcenter dev dev-box create --pool-name "LargeDevWorkStationPool" --name "MyDevBox" --dev-center-name "ContosoDevCenter" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Create using endpoint

az devcenter dev dev-box create --pool-name "LargeDevWorkStationPool" --name "MyDevBox" --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--dev-box-name --name -n

The name of a dev box.

--pool --pool-name

The name of the dev box pool this machine belongs to.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--no-wait

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

Default value: False
--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box delay-action

Delay an action.

az devcenter dev dev-box delay-action --action-name
                                      --delay-time
                                      --dev-box-name
                                      --project
                                      [--dev-center]
                                      [--endpoint]
                                      [--user-id]

Examples

Delay action using dev center

az devcenter dev dev-box delay-action --dev-center-name "ContosoDevCenter" --project-name "DevProject" --delay-time "04:30" --name "myDevBox" --action-name "schedule-default" --user-id "00000000-0000-0000-0000-000000000000"

Delay action using endpoint

az devcenter dev dev-box delay-action --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --delay-time "04:30" --name "myDevBox" --action-name "schedule-default" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--action-name

The name of an action that will take place on a dev box.

--delay-time

The delayed timespan from the scheduled action time. Format HH:MM.

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box delay-all-actions

Delay all actions.

az devcenter dev dev-box delay-all-actions --delay-time
                                           --dev-box-name
                                           --project
                                           [--dev-center]
                                           [--endpoint]
                                           [--user-id]

Examples

Delay all actions using dev center

az devcenter dev dev-box delay-all-actions --dev-center-name "ContosoDevCenter" --project-name "DevProject" --delay-time "04:30" --name "myDevBox" --user-id "00000000-0000-0000-0000-000000000000"

Delay all actions using endpoint

az devcenter dev dev-box delay-all-actions --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --delay-time "04:30" --name "myDevBox" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--delay-time

The delayed timespan from the earliest scheduled time of all actions. Format HH:MM.

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box delete

Delete a dev box.

az devcenter dev dev-box delete --dev-box-name
                                --project
                                [--dev-center]
                                [--endpoint]
                                [--no-wait]
                                [--user-id]
                                [--yes]

Examples

Delete using dev center

az devcenter dev dev-box delete --name "MyDevBox" --dev-center-name "ContosoDevCenter"                --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Delete using endpoint

az devcenter dev dev-box delete --name "MyDevBox" --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--no-wait

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

Default value: False
--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
--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 dev dev-box list

List dev boxes for a user, list dev boxes in the dev center for a project and user, or list dev boxes that the caller has access to in the dev center.

az devcenter dev dev-box list [--dev-center]
                              [--endpoint]
                              [--project]
                              [--user-id]

Examples

List all dev boxes in the dev center

az devcenter dev dev-box list --dev-center-name "ContosoDevCenter"

List all dev boxes in the dev center using endpoint

az devcenter dev dev-box list --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/"

List by user using dev center

az devcenter dev dev-box list --dev-center-name "ContosoDevCenter" --user-id "00000000-0000-0000-0000-000000000000"

List by user using endpoint

az devcenter dev dev-box list --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --user-id "00000000-0000-0000-0000-000000000000"

List by user and project using dev center

az devcenter dev dev-box list --dev-center-name "ContosoDevCenter" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

List by user and project using endpoint

az devcenter dev dev-box list --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--project --project-name

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

--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

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 dev dev-box list-action

List actions on a dev box.

az devcenter dev dev-box list-action --dev-box-name
                                     --project
                                     [--dev-center]
                                     [--endpoint]
                                     [--user-id]

Examples

List actions using dev center

az devcenter dev dev-box list-action --dev-center-name "ContosoDevCenter" --project-name "DevProject" --name "myDevBox" --user-id "00000000-0000-0000-0000-000000000000"

List actions using endpoint

az devcenter dev dev-box list-action --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --name "myDevBox" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box list-operation

Lists operations on the dev box which have occurred within the past 90 days.

az devcenter dev dev-box list-operation --dev-box-name
                                        --project
                                        [--dev-center]
                                        [--endpoint]
                                        [--user-id]

Examples

List operations using dev center

az devcenter dev dev-box list-operation --dev-center-name "ContosoDevCenter" --project-name "DevProject" --name "myDevBox" --user-id "00000000-0000-0000-0000-000000000000"

List operations using endpoint

az devcenter dev dev-box list-operation --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --name "myDevBox" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box repair

Attempts automated repair steps to resolve common problems on a Dev Box. The dev box may restart during this operation.

az devcenter dev dev-box repair --dev-box-name
                                --project
                                [--dev-center]
                                [--endpoint]
                                [--no-wait]
                                [--user-id]

Examples

Repair using dev center

az devcenter dev dev-box repair --name "MyDevBox" --dev-center-name "ContosoDevCenter"                --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Repair using endpoint

az devcenter dev dev-box repair --name "MyDevBox" --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--no-wait

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

Default value: False
--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box restart

Restart a dev box.

az devcenter dev dev-box restart --dev-box-name
                                 --project
                                 [--dev-center]
                                 [--endpoint]
                                 [--no-wait]
                                 [--user-id]

Examples

Restart using dev center

az devcenter dev dev-box restart --name "MyDevBox" --dev-center-name "ContosoDevCenter"                --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Restart using endpoint

az devcenter dev dev-box restart --name "MyDevBox" --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--no-wait

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

Default value: False
--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box show

Get a dev box.

az devcenter dev dev-box show --dev-box-name
                              --project
                              [--dev-center]
                              [--endpoint]
                              [--user-id]

Examples

Get using dev center

az devcenter dev dev-box show --name "MyDevBox" --dev-center-name "ContosoDevCenter"                --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Get using endpoint

az devcenter dev dev-box show --name "MyDevBox" --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box show-action

Get an action.

az devcenter dev dev-box show-action --action-name
                                     --dev-box-name
                                     --project
                                     [--dev-center]
                                     [--endpoint]
                                     [--user-id]

Examples

Get action using dev center

az devcenter dev dev-box show-action --dev-center-name "ContosoDevCenter" --project-name "DevProject" --name "myDevBox" --action-name "schedule-default" --user-id "00000000-0000-0000-0000-000000000000"

Get action using endpoint

az devcenter dev dev-box show-action --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --name "myDevBox" --action-name "schedule-default" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--action-name

The name of an action that will take place on a dev box.

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box show-operation

Get an operation on a dev box.

az devcenter dev dev-box show-operation --dev-box-name
                                        --operation-id
                                        --project
                                        [--dev-center]
                                        [--endpoint]
                                        [--user-id]

Examples

Get operation using dev center

az devcenter dev dev-box show-operation --dev-center-name "ContosoDevCenter" --project-name "DevProject" --name "myDevBox" --operation-id "f5dbdfab-fa0e-4831-8d13-25359aa5e680" --user-id "00000000-0000-0000-0000-000000000000"

Get operation using endpoint

az devcenter dev dev-box show-operation --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --name "myDevBox" --operation-id "f5dbdfab-fa0e-4831-8d13-25359aa5e680" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--dev-box-name --name -n

The name of a dev box.

--operation-id

The id of the operation on a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box show-remote-connection

Get remote connection info.

az devcenter dev dev-box show-remote-connection --dev-box-name
                                                --project
                                                [--dev-center]
                                                [--endpoint]
                                                [--user-id]

Examples

Get remote connection using dev center

az devcenter dev dev-box show-remote-connection --name "MyDevBox" --dev-center-name "ContosoDevCenter" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Get remote connection using dev center

az devcenter dev dev-box show-remote-connection --name "MyDevBox" --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box skip-action

Skip an action.

az devcenter dev dev-box skip-action --action-name
                                     --dev-box-name
                                     --project
                                     [--dev-center]
                                     [--endpoint]
                                     [--user-id]

Examples

Skip action using dev center

az devcenter dev dev-box skip-action --dev-center-name "ContosoDevCenter" --project-name "DevProject" --name "myDevBox" --action-name "schedule-default" --user-id "00000000-0000-0000-0000-000000000000"

Skip action using endpoint

az devcenter dev dev-box skip-action --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --name "myDevBox" --action-name "schedule-default" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--action-name

The name of an action that will take place on a dev box.

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box start

Start a dev box.

az devcenter dev dev-box start --dev-box-name
                               --project
                               [--dev-center]
                               [--endpoint]
                               [--no-wait]
                               [--user-id]

Examples

Start using dev center

az devcenter dev dev-box start --name "MyDevBox" --dev-center-name "ContosoDevCenter"                --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Start using endpoint

az devcenter dev dev-box start --name "MyDevBox" --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--no-wait

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

Default value: False
--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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 dev dev-box stop

Stop a dev box.

az devcenter dev dev-box stop --dev-box-name
                              --project
                              [--dev-center]
                              [--endpoint]
                              [--hibernate {false, true}]
                              [--no-wait]
                              [--user-id]

Examples

Stop using dev center

az devcenter dev dev-box stop --name "MyDevBox" --dev-center-name "ContosoDevCenter"                --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Stop using endpoint

az devcenter dev dev-box stop --name "MyDevBox" --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--dev-box-name --name -n

The name of a dev box.

--project --project-name

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

Optional Parameters

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

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--endpoint

The API endpoint for the developer resources. Use az configure -d endpoint=<endpoint_uri> to configure a default.

--hibernate
Preview

Optional parameter to hibernate the dev box.

Accepted values: false, true
--no-wait

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

Default value: False
--user-id

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Default value: me
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.