Share via

az devcenter dev customization-task

  • 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-task command. Learn more about extensions.

Manage customization tasks.

Commands

Name Description Type Status
az devcenter dev customization-task list

List customization task.

 Extension GA
az devcenter dev customization-task show

Get a customization task.

 Extension GA
az devcenter dev customization-task show-logs

Show logs of a customization task.

 Extension GA
az devcenter dev customization-task validate

Validate customization tasks.

 Extension GA

az devcenter dev customization-task list

List customization task.

az devcenter dev customization-task list --project
                                         [--dev-center]
                                         [--endpoint]

Examples

List using dev center

az devcenter dev customization-task list --dev-center-name "ContosoDevCenter" --project-name "DevProject"

List using endpoint

az devcenter dev customization-task list --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject"

Required Parameters

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

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

Get a customization task.

az devcenter dev customization-task show --catalog-name
                                         --project
                                         --task-name
                                         [--dev-center]
                                         [--endpoint]

Examples

Get using dev center

az devcenter dev customization-task show --dev-center-name "ContosoDevCenter" --project-name "DevProject" --task-name "choco" --catalog-name "myCatalog"

Get using endpoint

az devcenter dev customization-task show --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --task-name "choco" --catalog-name "myCatalog"

Required Parameters

--catalog-name

The name of the catalog.

--project --project-name

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

--task-name

The name of the task.

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.

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-task show-logs

Show logs of a customization task.

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

Examples

Get using dev center

az devcenter dev customization-task show-logs --dev-center-name "ContosoDevCenter" --project-name "DevProject" --dev-box-name "myDevBox" --customization-group-name "Provisioning" --customization-task-id "91835dc0-ef5a-4f58-9e3a-099aea8481f4" --user-id "00000000-0000-0000-0000-000000000000"

Get using endpoint

az devcenter dev customization-task show-logs --endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" --project-name "DevProject" --dev-box-name "myDevBox" --customization-group-name "Provisioning" --customization-task-id "91835dc0-ef5a-4f58-9e3a-099aea8481f4" --user-id "00000000-0000-0000-0000-000000000000"

Required Parameters

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

The name of customization group.

--customization-task-id --task-id-t

The name of the dev box.

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

az devcenter dev customization-task validate

Validate customization tasks.

az devcenter dev customization-task validate --project
                                             --tasks
                                             [--dev-center]
                                             [--endpoint]

Examples

Validate using dev center

az devcenter dev customization-task validate --dev-center-name "ContosoDevCenter" --project-name "DevProject" --tasks "[{\"name\": \"catalogName/choco\", \"displayName\": \"Install VS Code\", \"parameters\": {\"packageName\": \"vscode\", \"packageVersion\": \"1.0.0\"}}, {\"name\": \"catalogName/write-to-file\", \"runAs\": \"User\"}]"

Validate using endpoint

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

Required Parameters

--project --project-name

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

--tasks

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

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.

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.