az vm extension image

Find the available VM extensions for a subscription and region.

Commands

az vm extension image list

List the information on available extensions.
az vm extension image list-names

List the names of available extensions.
az vm extension image list-versions

List the versions for available extensions.
az vm extension image show

Display information for an extension.

az vm extension image list

Edit

List the information on available extensions.

az vm extension image list [--latest]
                           [--location]
                           [--name]
                           [--publisher]
                           [--query-examples]
                           [--subscription]
                           [--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.

--location -l

Image location.

--name -n

Image name.

--publisher -p

Image publisher name.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

--version

Extension version.

az vm extension image list-names

Edit

List the names of available extensions.

az vm extension image list-names --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')]"

Required Parameters

--location -l

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

--publisher -p

Image publisher name.

Optional Parameters

--subscription

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

az vm extension image list-versions

Edit

List the versions for available extensions.

az vm extension image list-versions --location
                                    --name
                                    --publisher
                                    [--filter]
                                    [--orderby]
                                    [--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 -otable

Required Parameters

--location -l

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

--name -n

Name of the extension.

--publisher -p

Image publisher name.

Optional Parameters

--filter

The filter to apply on the operation.

--orderby

The $orderby odata query option.

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

az vm extension image show

Edit

Display information for an extension.

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

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.

publisher=Microsoft.Azure.Extensions
extension=DockerExtension
location=westus

latest=$(az vm extension image list-versions \
  --publisher {publisher} -l {location} -n {extension} \
  --query "[].name" -o tsv | sort | tail -n 1)

az vm extension image show -l {location} \
  --publisher {publisher} -n {extension} --version {latest}

Required Parameters

--location -l

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

--name -n

Name of the extension.

--publisher -p

Image publisher name.

--version

Extension version.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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