az devcenter dev add-on

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

Manage add ons.

Commands

Name	Description	Type	Status
az devcenter dev add-on create	Create a dev box add on.	Extension	GA
az devcenter dev add-on delete	Delete a dev box add on.	Extension	GA
az devcenter dev add-on disable	Disable a dev box add on.	Extension	GA
az devcenter dev add-on enable	Enable a dev box add on.	Extension	GA
az devcenter dev add-on list	List add ons for a dev box.	Extension	GA
az devcenter dev add-on show	Get a dev box add on.	Extension	GA

az devcenter dev add-on create

Create a dev box add on.

az devcenter dev add-on create --add-on-name --name
                               --dev-box --dev-box-name
                               --project --project-name
                               [--dev-center --dev-center-name]
                               [--endpoint]
                               [--hosting-resource-name]
                               [--no-wait]
                               [--user-id]

Examples

Create using dev center

az devcenter dev add-on create --dev-box-name "myDevBox" --dev-center-name "ContosoDevCenter" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000" --add-on-name "devboxtunnel-sys-default"

Create using endpoint

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

Required Parameters

--add-on-name --name -n

The name of dev box add on.

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

The name of the dev box.

--project --project-name

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

Optional Parameters

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

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

--hosting-resource-name

The hosting resource name, either a DevBox or HyperV. Leaving it empty or Default if it's for DevBox.

Property	Value
Default value:	Default

--no-wait

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

Property	Value
Default value:	False

--user-id

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

Property	Value
Default value:	me

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 dev add-on delete

Delete a dev box add on.

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

Examples

Delete using dev center

az devcenter dev add-on delete --dev-box-name "myDevBox" --dev-center-name "ContosoDevCenter" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000" --add-on-name "devboxtunnel-sys-default"

Delete using endpoint

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

Required Parameters

--add-on-name --name -n

The name of dev box add on.

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

The name of the dev box.

--project --project-name

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

Optional Parameters

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

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

Property	Value
Default value:	False

--user-id

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

Property	Value
Default value:	me

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 dev add-on disable

Disable a dev box add on.

az devcenter dev add-on disable --add-on-name --name
                                --dev-box --dev-box-name
                                --project --project-name
                                [--dev-center --dev-center-name]
                                [--endpoint]
                                [--no-wait]
                                [--user-id]

Examples

Disable using dev center

az devcenter dev add-on disable --dev-box-name "myDevBox" --dev-center-name "ContosoDevCenter" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000" --add-on-name "devboxtunnel-sys-default"

Disable using endpoint

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

Required Parameters

--add-on-name --name -n

The name of dev box add on.

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

The name of the dev box.

--project --project-name

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

Optional Parameters

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

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

Property	Value
Default value:	False

--user-id

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

Property	Value
Default value:	me

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 dev add-on enable

Enable a dev box add on.

az devcenter dev add-on enable --add-on-name --name
                               --dev-box --dev-box-name
                               --project --project-name
                               [--dev-center --dev-center-name]
                               [--endpoint]
                               [--no-wait]
                               [--user-id]

Examples

Enable using dev center

az devcenter dev add-on enable --dev-box-name "myDevBox" --dev-center-name "ContosoDevCenter" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000" --add-on-name "devboxtunnel-sys-default"

Enable using endpoint

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

Required Parameters

--add-on-name --name -n

The name of dev box add on.

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

The name of the dev box.

--project --project-name

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

Optional Parameters

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

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

Property	Value
Default value:	False

--user-id

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

Property	Value
Default value:	me

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 dev add-on list

List add ons for a dev box.

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

Examples

List using dev center

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

List using endpoint

az devcenter dev add-on list --dev-box-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 --dev-box-name

The name of the dev box.

--project --project-name

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

Optional Parameters

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

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

Property	Value
Default value:	me

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 dev add-on show

Get a dev box add on.

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

Examples

Get using dev center

az devcenter dev add-on show --dev-box-name "myDevBox" --dev-center-name "ContosoDevCenter" --project-name "DevProject" --user-id "00000000-0000-0000-0000-000000000000" --add-on-name "devboxtunnel-sys-default"

Get using endpoint

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

Required Parameters

--add-on-name --name -n

The name of dev box add on.

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

The name of the dev box.

--project --project-name

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

Optional Parameters

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

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

Property	Value
Default value:	me

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

Share via

az devcenter dev add-on

Commands

az devcenter dev add-on create

Examples

Required Parameters

Optional Parameters

az devcenter dev add-on delete

Examples

Required Parameters

Optional Parameters

az devcenter dev add-on disable

Examples

Required Parameters

Optional Parameters

az devcenter dev add-on enable

Examples

Required Parameters

Optional Parameters

az devcenter dev add-on list

Examples

Required Parameters

Optional Parameters

az devcenter dev add-on show

Examples

Required Parameters

Optional Parameters

Feedback