Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az vm extension image

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--latest

Show the latest version only.

Property Value
Default value: False
--location -l

Image location.

--name -n

Image name.

--publisher -p

Image publisher name.

--version

Extension version.

az vm extension image list-names

List the names of available extensions.

az vm extension image list-names [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--location]
 [--publisher --publisher-name]
 [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--location -l

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

Property Value
Parameter group: Resource Id Arguments
--publisher --publisher-name -p

Image publisher name.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments

az vm extension image list-versions

List the versions for available extensions.

az vm extension image list-versions [--acquire-policy-token]
 [--change-reference]
 [--filter]
 [--ids]
 [--location]
 [--name --type]
 [--orderby]
 [--publisher --publisher-name]
 [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--location -l

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

Property Value
Parameter group: Resource Id Arguments
--name --type -n

Name of the extension.

Property Value
Parameter group: Resource Id Arguments
--orderby

The $orderby odata query option.

--publisher --publisher-name -p

Image publisher name.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--top

The $top odata query option.

az vm extension image show

Display information for an extension.

az vm extension image show [--ids]
 [--location]
 [--name --type]
 [--publisher --publisher-name]
 [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--location -l

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

Property Value
Parameter group: Resource Id Arguments
--name --type -n

Name of the extension.

Property Value
Parameter group: Resource Id Arguments
--publisher --publisher-name -p

Image publisher name.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--version

Extension version.

Property Value
Parameter group: Resource Id Arguments

Feedback

Was this page helpful?