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

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.

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

List the names of available extensions.

az vm extension image list-names --location
                                 --publisher

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.

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.

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

List the versions for available extensions.

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

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. Default value is None.

--orderby

The $orderby odata query option.

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

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

Display information for an extension.

az vm extension image show --location
                           --name
                           --publisher
                           --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.

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.

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.

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