az devcenter dev customization-group

  • 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 dev customization-group command. Learn more about extensions.

Manage customization groups.

Commands

Name Description Type Status
az devcenter dev customization-group create

Create a customization group.

 Extension GA
az devcenter dev customization-group list

List customization groups on the dev box.

 Extension GA
az devcenter dev customization-group show

Get a customization group.

 Extension GA

az devcenter dev customization-group create

Create a customization group.

az devcenter dev customization-group create --customization-group-name
                                            --dev-box
                                            --project
                                            [--dev-center]
                                            [--endpoint]
                                            [--tasks]
                                            [--user-id]

Examples

Create using dev center

az devcenter dev customization-group create --dev-center-name "ContosoDevCenter" --project-name "DevProject" --dev-box-name "myDevBox" --tasks "[{\"name\": \"catalogName/choco\", \"displayName\": \"Install VS Code\", \"parameters\": {\"packageName\": \"vscode\", \"packageVersion\": \"1.0.0\"}}, {\"name\": \"catalogName/write-to-file\", \"runAs\": \"User\"}]" --name "Provisioning" --user-id "00000000-0000-0000-0000-000000000000"

Create using endpoint

az devcenter dev customization-group create --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --dev-box-name "myDevBox" --tasks "[{\"name\": \"catalogName/choco\", \"displayName\": \"Install VS Code\", \"parameters\": {\"packageName\": \"vscode\", \"packageVersion\": \"1.0.0\"}}, {\"name\": \"catalogName/write-to-file\", \"runAs\": \"User\"}]" --name "Provisioning" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

--customization-group-name --name -n

The name of customization group.

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

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

--tasks

Parameters object for the tasks. Expected value: json-string/json-file/@json-file.

--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 customization-group list

List customization groups on the dev box.

az devcenter dev customization-group list --dev-box
                                          --project
                                          [--dev-center]
                                          [--endpoint]
                                          [--include-tasks {false, true}]
                                          [--user-id]

Examples

List using dev center

az devcenter dev customization-group list --dev-center-name "ContosoDevCenter" --project-name "DevProject" --dev-box-name "myDevBox" --user-id "00000000-0000-0000-0000-000000000000" --include-tasks

List using endpoint

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

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

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

--include-tasks
Preview

Optional parameter to include task information in the response.

Accepted values: false, true
--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 customization-group show

Get a customization group.

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

Examples

Get using dev center

az devcenter dev customization-group show --dev-center-name "ContosoDevCenter" --project-name "DevProject" --dev-box-name "myDevBox" --name "Provisioning" --user-id "00000000-0000-0000-0000-000000000000"

Get using endpoint

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

Required Parameters

--customization-group-name --name -n

The name of customization group.

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

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