Share via

az vm image

  • Reference

Information on available virtual machine images.

Commands

Name Description Type Status
az vm image accept-terms

Accept Azure Marketplace term so that the image can be used to create VMs.

 Core Deprecated
az vm image list

List the VM/VMSS images available in the Azure Marketplace.

 Core GA
az vm image list-offers

List the VM image offers available in the Azure Marketplace.

 Core GA
az vm image list-publishers

List the VM image publishers available in the Azure Marketplace.

 Core GA
az vm image list-skus

List the VM image SKUs available in the Azure Marketplace.

 Core GA
az vm image show

Get the details for a VM image available in the Azure Marketplace.

 Core GA
az vm image terms

Manage Azure Marketplace image terms.

 Core GA
az vm image terms accept

Accept Azure Marketplace image terms so that the image can be used to create VMs.

 Core GA
az vm image terms cancel

Cancel Azure Marketplace image terms.

 Core GA
az vm image terms show

Get the details of Azure Marketplace image terms.

 Core GA

az vm image accept-terms

Edit
Deprecated

This command has been deprecated and will be removed in version '3.0.0'. Use 'az vm image terms accept' instead.

Accept Azure Marketplace term so that the image can be used to create VMs.

az vm image accept-terms [--offer]
                         [--plan]
                         [--publisher]
                         [--urn]

Examples

Accept Azure Marketplace term so that the image can be used to create VMs. (autogenerated)

az vm image accept-terms --urn publisher:offer:sku:version

Optional Parameters

--offer -f

Image offer.

--plan

Image billing plan.

--publisher -p

Image publisher.

--urn

URN, in format of 'publisher:offer:sku:version' or 'publisher:offer:sku:edge_zone:version'. If specified, other argument values can be omitted.

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

Edit

List the VM/VMSS images available in the Azure Marketplace.

az vm image list [--all]
                 [--architecture {Arm64, x64}]
                 [--edge-zone]
                 [--location]
                 [--offer]
                 [--publisher]
                 [--sku]

Examples

List all available images.

az vm image list --all

List all offline cached CentOS images.

az vm image list -f CentOS

List all CentOS images.

az vm image list -f CentOS --all

Optional Parameters

--all

Retrieve image list from live Azure service rather using an offline image list.

Default value: False
--architecture

The name of architecture.

Accepted values: Arm64, x64
--edge-zone

The name of edge zone.

--location -l

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

--offer -f

Image offer name, partial name is accepted.

--publisher -p

Image publisher name, partial name is accepted.

--sku -s

Image sku name, partial name is accepted.

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

Edit

List the VM image offers available in the Azure Marketplace.

az vm image list-offers --location
                        --publisher
                        [--edge-zone]

Examples

List all offers from Microsoft in the West US region.

az vm image list-offers -l westus -p MicrosoftWindowsServer

List all offers from OpenLocic in the West US region.

az vm image list-offers -l westus -p OpenLogic

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.

Value from: az vm image list-publishers

Optional Parameters

--edge-zone

The name of edge zone.

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

Edit

List the VM image publishers available in the Azure Marketplace.

az vm image list-publishers --location
                            [--edge-zone]

Examples

List all publishers in the West US region.

az vm image list-publishers -l westus

List all publishers with names starting with "Open" in westus.

az vm image list-publishers -l westus --query "[?starts_with(name, 'Open')]"

Required Parameters

--location -l

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

Optional Parameters

--edge-zone

The name of edge zone.

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

Edit

List the VM image SKUs available in the Azure Marketplace.

az vm image list-skus --location
                      --offer
                      --publisher
                      [--edge-zone]

Examples

List all skus available for CentOS published by OpenLogic in the West US region.

az vm image list-skus -l westus -f CentOS -p OpenLogic

Required Parameters

--location -l

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

--offer -f

Image offer.

--publisher -p

Image publisher.

Value from: az vm image list-publishers

Optional Parameters

--edge-zone

The name of edge zone.

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

Edit

Get the details for a VM image available in the Azure Marketplace.

az vm image show [--edge-zone]
                 [--location]
                 [--offer]
                 [--publisher]
                 [--sku]
                 [--urn]
                 [--version]

Examples

Show information for the latest available CentOS image from OpenLogic.

latest=$(az vm image list -p OpenLogic -s 7.3 --all --query \
    "[?offer=='CentOS'].version" -o tsv | sort -u | tail -n 1)
az vm image show -l westus -f CentOS -p OpenLogic --sku 7.3 --version ${latest}

Get the details for a VM image available in the Azure Marketplace. (autogenerated)

az vm image show --location westus --urn publisher:offer:sku:version

Optional Parameters

--edge-zone

The name of edge zone.

--location -l

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

--offer -f

Image offer.

--publisher -p

Image publisher.

--sku -s

Image sku.

--urn

URN, in format of 'publisher:offer:sku:version' or 'publisher:offer:sku:edge_zone:version'. If specified, other argument values can be omitted.

--version

Image sku's 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.