Share via

az devcenter admin image-definition

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

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage image definitions.

Commands

Name Description Type Status
az devcenter admin image-definition build-image

Builds an image for the specified Image Definition.

 Extension Preview
az devcenter admin image-definition list

List Image Definitions in the catalog.

 Extension Preview
az devcenter admin image-definition show

Get an Image Definition from the catalog.

 Extension Preview

az devcenter admin image-definition build-image

Preview

Command group 'az devcenter admin image-definition' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Builds an image for the specified Image Definition.

az devcenter admin image-definition build-image [--catalog-name]
                                                [--ids]
                                                [--image-definition-name]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--project]
                                                [--resource-group]
                                                [--subscription]

Examples

Build image

az devcenter admin image-definition build-image --catalog-name "CentralCatalog" --image-definition-name "DefaultDevImage" --project-name "rg1" --resource-group "rg1"

Optional Parameters

--catalog-name

The name of the Catalog.

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

--image-definition-name -i

The name of the Image Definition.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--project --project-name

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

--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 image-definition list

Preview

Command group 'az devcenter admin image-definition' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Image Definitions in the catalog.

az devcenter admin image-definition list --catalog-name
                                         --project
                                         --resource-group
                                         [--max-items]
                                         [--next-token]

Examples

List

az devcenter admin image-definition list --catalog-name "CentralCatalog" --project-name "rg1" --resource-group "rg1"

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.

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

Preview

Command group 'az devcenter admin image-definition' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get an Image Definition from the catalog.

az devcenter admin image-definition show [--catalog-name]
                                         [--ids]
                                         [--image-definition-name]
                                         [--project]
                                         [--resource-group]
                                         [--subscription]

Examples

Get

az devcenter admin image-definition show --catalog-name "CentralCatalog" --image-definition-name "DefaultDevImage" --project-name "rg1" --resource-group "rg1"

Optional Parameters

--catalog-name

The name of the Catalog.

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

--image-definition-name --name -n

The name of the Image Definition.

--project --project-name

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

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