Share via

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

Manage environment definitions in the catalog.

Commands

Name Description Type Status
az devcenter admin environment-definition get-error-detail

Gets environment definition error details.

 Extension GA
az devcenter admin environment-definition list

List environment definitions in the catalog.

 Extension GA
az devcenter admin environment-definition show

Get an environment definition from the catalog.

 Extension GA

az devcenter admin environment-definition get-error-detail

Gets environment definition error details.

az devcenter admin environment-definition get-error-detail [--catalog-name]
                                                           [--dev-center]
                                                           [--environment-definition-name]
                                                           [--ids]
                                                           [--resource-group]
                                                           [--subscription]

Examples

Get error detail

az devcenter admin environment-definition get-error-detail --catalog-name "myCatalog" --dev-center "Contoso" --environment-definition-name "myEnvironmentDefinition" --resource-group "rg1"

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.

--environment-definition-name --name -n

The name of the environment definition.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 admin environment-definition list

List environment definitions in the catalog.

az devcenter admin environment-definition list --catalog-name
                                               --dev-center
                                               --resource-group
                                               [--max-items]
                                               [--next-token]

Examples

List

az devcenter admin environment-definition list --catalog-name "myCatalog" --dev-center "Contoso" --resource-group "rg1"

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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

Get an environment definition from the catalog.

az devcenter admin environment-definition show [--catalog-name]
                                               [--dev-center]
                                               [--environment-definition-name]
                                               [--ids]
                                               [--resource-group]
                                               [--subscription]

Examples

Get

az devcenter admin environment-definition show --catalog-name "myCatalog" --dev-center "Contoso" --environment-definition-name "myEnvironmentDefinition" --resource-group "rg1"

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.

--environment-definition-name --name -n

The name of the environment definition.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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.