Share via

az vm extension image

  • Reference

Find the available VM extensions for a subscription and region.

Commands

Name Description Type Status
az vm extension image list

List the information on available extensions.

 Core GA
az vm extension image list-names

List the names of available extensions.

 Core GA
az vm extension image list-versions

List the versions for available extensions.

 Core GA
az vm extension image show

Display information for an extension.

 Core GA

az vm extension image list

Edit

List the information on available extensions.

az vm extension image list [--latest]
                           [--location]
                           [--name]
                           [--publisher]
                           [--version]

Examples

List the unique publishers for extensions.

az vm extension image list --query "[].publisher" -o tsv | sort -u

Find extensions with "Docker" in the name.

az vm extension image list --query "[].name" -o tsv | sort -u | grep Docker

List extension names where the publisher name starts with "Microsoft.Azure.App".

az vm extension image list --query \
    "[?starts_with(publisher, 'Microsoft.Azure.App')].publisher" \
    -o tsv | sort -u | xargs -I{} az vm extension image list-names --publisher {} -l westus

Optional Parameters

--latest

Show the latest version only.

Default value: False
--location -l

Image location.

--name -n

Image name.

--publisher -p

Image publisher name.

--version

Extension version.

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 vm extension image list-names

Edit

List the names of available extensions.

az vm extension image list-names [--ids]
                                 [--location]
                                 [--publisher]
                                 [--subscription]

Examples

Find Docker extensions by publisher and location.

az vm extension image list-names --publisher Microsoft.Azure.Extensions -l westus --query "[?starts_with(name, 'Docker')]"

Find CustomScript extensions by publisher and location.

az vm extension image list-names --publisher Microsoft.Azure.Extensions -l westus --query "[?starts_with(name, 'Custom')]"

Optional Parameters

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--publisher --publisher-name -p

Image publisher 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 vm extension image list-versions

Edit

List the versions for available extensions.

az vm extension image list-versions [--filter]
                                    [--ids]
                                    [--location]
                                    [--name]
                                    [--orderby]
                                    [--publisher]
                                    [--subscription]
                                    [--top]

Examples

Find the available versions for the Docker extension.

az vm extension image list-versions --publisher Microsoft.Azure.Extensions -l westus -n DockerExtension -o table

Optional Parameters

--filter

The filter to apply on the operation. Default value is None.

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name --type -n

Name of the extension.

--orderby

The $orderby odata query option.

--publisher --publisher-name -p

Image publisher name.

--subscription

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

--top

The $top odata query option.

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 vm extension image show

Edit

Display information for an extension.

az vm extension image show [--ids]
                           [--location]
                           [--name]
                           [--publisher]
                           [--subscription]
                           [--version]

Examples

Show the CustomScript extension version 2.0.2.

az vm extension image show -l westus -n CustomScript --publisher Microsoft.Azure.Extensions --version 2.0.2

Show the latest version of the Docker extension.

az vm extension image list-versions --publisher Microsoft.Azure.Extensions -l westus -n DockerExtension --query "[].name" -o tsv | sort | tail -n 1
az vm extension image show -l westus --publisher Microsoft.Azure.Extensions -n DockerExtension --version LatestVersion

Optional Parameters

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name --type -n

Name of the extension.

--publisher --publisher-name -p

Image publisher name.

--subscription

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

--version

Extension version.

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.