az devcenter dev environment-definition

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

Manage environment definitions.

Commands

Name Description Type Status
az devcenter dev environment-definition list

List all environment definitions available within a catalog or list all environment definitions available for a project.

 Extension GA
az devcenter dev environment-definition show

Get an environment definition from a catalog.

 Extension GA

az devcenter dev environment-definition list

List all environment definitions available within a catalog or list all environment definitions available for a project.

az devcenter dev environment-definition list --project
                                             [--catalog-name]
                                             [--dev-center]
                                             [--endpoint]

Examples

List using dev center

az devcenter dev environment-definition list --dev-center-name "ContosoDevCenter" --project-name "DevProject"

List using endpoint

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

List by catalog using dev center

az devcenter dev environment-definition list --dev-center-name "ContosoDevCenter" --project-name "DevProject" --catalog-name "myCatalog"

List by catalog using endpoint

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

Required Parameters

--project --project-name

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

Optional Parameters

--catalog-name

The name of the catalog.

--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 environment-definition show

Get an environment definition from a catalog.

az devcenter dev environment-definition show --catalog-name
                                             --definition-name
                                             --project
                                             [--dev-center]
                                             [--endpoint]

Examples

Get using dev center

az devcenter dev environment-definition show --dev-center-name "ContosoDevCenter" --project-name "DevProject" --catalog-name "myCatalog" --definition-name "foo"

Get using endpoint

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

Required Parameters

--catalog-name

The name of the catalog.

--definition-name --name -n

The name of the environment definition.

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