Find Azure Marketplace image information using the Azure CLI
Applies to: ✔️ Linux VMs ✔️ Flexible scale sets
This topic describes how to use the Azure CLI to find VM images in the Azure Marketplace. Use this information to specify a Marketplace image when you create a VM programmatically with the CLI, Resource Manager templates, or other tools.
You can also browse available images and offers using the Azure Marketplace or Azure PowerShell.
Terminology
A Marketplace image in Azure has the following attributes:
- Publisher: The organization that created the image. Examples: Canonical, MicrosoftWindowsServer
- Offer: The name of a group of related images created by a publisher. Examples: UbuntuServer, WindowsServer
- SKU: An instance of an offer, such as a major release of a distribution. Examples: 18.04-LTS, 2019-Datacenter
- Version: The version number of an image SKU.
These values can be passed individually or as an image URN, combining the values separated by the colon (:). For example: Publisher:Offer:Sku:Version. You can replace the version number in the URN with latest to use the latest version of the image.
If the image publisher provides additional license and purchase terms, then you must accept those before you can use the image. For more information, see Check the purchase plan information.
List popular images
Run the az vm image list command, without the --all option, to see a list of popular VM images in the Azure Marketplace. For example, run the following command to display a cached list of popular images in table format:
az vm image list --output table
The output includes the image URN. You can also use the UrnAlias which is a shortened version created for popular images like UbuntuLTS.
Offer Publisher Sku Urn UrnAlias Version
------------- ---------------------- ------------------ -------------------------------------------------------------- ------------------- ---------
CentOS OpenLogic 7.5 OpenLogic:CentOS:7.5:latest CentOS latest
CoreOS CoreOS Stable CoreOS:CoreOS:Stable:latest CoreOS latest
debian-10 Debian 10 Debian:debian-10:10:latest Debian latest
openSUSE-Leap SUSE 42.3 SUSE:openSUSE-Leap:42.3:latest openSUSE-Leap latest
RHEL RedHat 7-LVM RedHat:RHEL:7-LVM:latest RHEL latest
SLES SUSE 15 SUSE:SLES:15:latest SLES latest
UbuntuServer Canonical 18.04-LTS Canonical:UbuntuServer:18.04-LTS:latest UbuntuLTS latest
WindowsServer MicrosoftWindowsServer 2019-Datacenter MicrosoftWindowsServer:WindowsServer:2019-Datacenter:latest Win2019Datacenter latest
WindowsServer MicrosoftWindowsServer 2016-Datacenter MicrosoftWindowsServer:WindowsServer:2016-Datacenter:latest Win2016Datacenter latest
WindowsServer MicrosoftWindowsServer 2012-R2-Datacenter MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter:latest Win2012R2Datacenter latest
WindowsServer MicrosoftWindowsServer 2012-Datacenter MicrosoftWindowsServer:WindowsServer:2012-Datacenter:latest Win2012Datacenter latest
WindowsServer MicrosoftWindowsServer 2008-R2-SP1 MicrosoftWindowsServer:WindowsServer:2008-R2-SP1:latest Win2008R2SP1 latest
Find specific images
To find a specific VM image in the Marketplace, use the az vm image list command with the --all option. This version of the command takes some time to complete and can return lengthy output, so you usually filter the list by --publisher or another parameter.
For example, the following command displays all Debian offers (remember that without the --all switch, it only searches the local cache of common images):
az vm image list --offer Debian --all --output table
Partial output:
Offer Publisher Sku Urn Version
--------------------------------------- -------------------------------- --------------------------------------- ---------------------------------------------------------------------------------------------------- --------------
apache-solr-on-debian apps-4-rent apache-solr-on-debian apps-4-rent:apache-solr-on-debian:apache-solr-on-debian:1.0.0 1.0.0
atomized-h-debian10-v1 atomizedinc1587939464368 hdebian10plan atomizedinc1587939464368:atomized-h-debian10-v1:hdebian10plan:1.0.0 1.0.0
atomized-h-debian9-v1 atomizedinc1587939464368 hdebian9plan atomizedinc1587939464368:atomized-h-debian9-v1:hdebian9plan:1.0.0 1.0.0
atomized-r-debian10-v1 atomizedinc1587939464368 rdebian10plan atomizedinc1587939464368:atomized-r-debian10-v1:rdebian10plan:1.0.0 1.0.0
atomized-r-debian9-v1 atomizedinc1587939464368 rdebian9plan atomizedinc1587939464368:atomized-r-debian9-v1:rdebian9plan:1.0.0 1.0.0
cis-debian-linux-10-l1 center-for-internet-security-inc cis-debian10-l1 center-for-internet-security-inc:cis-debian-linux-10-l1:cis-debian10-l1:1.0.7 1.0.7
cis-debian-linux-10-l1 center-for-internet-security-inc cis-debian10-l1 center-for-internet-security-inc:cis-debian-linux-10-l1:cis-debian10-l1:1.0.8 1.0.8
cis-debian-linux-10-l1 center-for-internet-security-inc cis-debian10-l1 center-for-internet-security-inc:cis-debian-linux-10-l1:cis-debian10-l1:1.0.9 1.0.9
cis-debian-linux-9-l1 center-for-internet-security-inc cis-debian9-l1 center-for-internet-security-inc:cis-debian-linux-9-l1:cis-debian9-l1:1.0.18 1.0.18
cis-debian-linux-9-l1 center-for-internet-security-inc cis-debian9-l1 center-for-internet-security-inc:cis-debian-linux-9-l1:cis-debian9-l1:1.0.19 1.0.19
cis-debian-linux-9-l1 center-for-internet-security-inc cis-debian9-l1 center-for-internet-security-inc:cis-debian-linux-9-l1:cis-debian9-l1:1.0.20 1.0.20
apache-web-server-with-debian-10 cognosys apache-web-server-with-debian-10 cognosys:apache-web-server-with-debian-10:apache-web-server-with-debian-10:1.2019.1008 1.2019.1008
docker-ce-with-debian-10 cognosys docker-ce-with-debian-10 cognosys:docker-ce-with-debian-10:docker-ce-with-debian-10:1.2019.0710 1.2019.0710
Debian credativ 8 credativ:Debian:8:8.0.201602010 8.0.201602010
Debian credativ 8 credativ:Debian:8:8.0.201603020 8.0.201603020
Debian credativ 8 credativ:Debian:8:8.0.201604050 8.0.201604050
...
Look at all available images
Another way to find an image in a location is to run the az vm image list-publishers, az vm image list-offers, and az vm image list-skus commands in sequence. With these commands, you determine these values:
List the image publishers for a location. In this example, we are looking at the West US region.
az vm image list-publishers --location westus --output tableFor a given publisher, list their offers. In this example, we add Canonical as the publisher.
az vm image list-offers --location westus --publisher Canonical --output tableFor a given offer, list their SKUs. In this example, we add UbuntuServer as the offer.
az vm image list-skus --location westus --publisher Canonical --offer UbuntuServer --output tableFor a given publisher, offer, and SKU, show all of the versions of the image. In this example, we add 18.04-LTS as the SKU.
az vm image list \ --location westus \ --publisher Canonical \ --offer UbuntuServer \ --sku 18.04-LTS \ --all --output table
Pass this value of the URN column with the --image parameter when you create a VM with the az vm create command. You can also replace the version number in the URN with "latest", to simply use the latest version of the image.
If you deploy a VM with a Resource Manager template, you set the image parameters individually in the imageReference properties. See the template reference.
Check the purchase plan information
Some VM images in the Azure Marketplace have additional license and purchase terms that you must accept before you can deploy them programmatically.
To deploy a VM from such an image, you'll need to accept the image's terms the first time you use it, once per subscription. You'll also need to specify purchase plan parameters to deploy a VM from that image
To view an image's purchase plan information, run the az vm image show command with the URN of the image. If the plan property in the output is not null, the image has terms you need to accept before programmatic deployment.
For example, the Canonical Ubuntu Server 18.04 LTS image doesn't have additional terms, because the plan information is null:
az vm image show --location westus --urn Canonical:UbuntuServer:18.04-LTS:latest
Output:
{
"dataDiskImages": [],
"id": "/Subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.Compute/Locations/westus/Publishers/Canonical/ArtifactTypes/VMImage/Offers/UbuntuServer/Skus/18.04-LTS/Versions/18.04.201901220",
"location": "westus",
"name": "18.04.201901220",
"osDiskImage": {
"operatingSystem": "Linux"
},
"plan": null,
"tags": null
}
Running a similar command for the RabbitMQ Certified by Bitnami image shows the following plan properties: name, product, and publisher. (Some images also have a promotion code property.)
az vm image show --location westus --urn bitnami:rabbitmq:rabbitmq:latest
Output:
{
"dataDiskImages": [],
"id": "/Subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.Compute/Locations/westus/Publishers/bitnami/ArtifactTypes/VMImage/Offers/rabbitmq/Skus/rabbitmq/Versions/3.7.1901151016",
"location": "westus",
"name": "3.7.1901151016",
"osDiskImage": {
"operatingSystem": "Linux"
},
"plan": {
"name": "rabbitmq",
"product": "rabbitmq",
"publisher": "bitnami"
},
"tags": null
}
To deploy this image, you need to accept the terms and provide the purchase plan parameters when you deploy a VM using that image.
Accept the terms
To view and accept the license terms, use the az vm image terms command. When you accept the terms, you enable programmatic deployment in your subscription. You only need to accept terms once per subscription for the image. For example:
az vm image terms show --urn bitnami:rabbitmq:rabbitmq:latest
The output includes a licenseTextLink to the license terms, and indicates that the value of accepted is true:
{
"accepted": true,
"additionalProperties": {},
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.MarketplaceOrdering/offertypes/bitnami/offers/rabbitmq/plans/rabbitmq",
"licenseTextLink": "https://storelegalterms.blob.core.windows.net/legalterms/3E5ED_legalterms_BITNAMI%253a24RABBITMQ%253a24RABBITMQ%253a24IGRT7HHPIFOBV3IQYJHEN2O2FGUVXXZ3WUYIMEIVF3KCUNJ7GTVXNNM23I567GBMNDWRFOY4WXJPN5PUYXNKB2QLAKCHP4IE5GO3B2I.txt",
"name": "rabbitmq",
"plan": "rabbitmq",
"privacyPolicyLink": "https://bitnami.com/privacy",
"product": "rabbitmq",
"publisher": "bitnami",
"retrieveDatetime": "2019-01-25T20:37:49.937096Z",
"signature": "XXXXXXLAZIK7ZL2YRV5JYQXONPV76NQJW3FKMKDZYCRGXZYVDGX6BVY45JO3BXVMNA2COBOEYG2NO76ONORU7ITTRHGZDYNJNXXXXXX",
"type": "Microsoft.MarketplaceOrdering/offertypes"
}
To accept the terms, type:
az vm image terms accept --urn bitnami:rabbitmq:rabbitmq:latest
Deploy a new VM using the image parameters
With information about the image, you can deploy it using the az vm create command.
To deploy an image that does not have plan information, like the latest Ubuntu Server 18.04 image from Canonical, pass the URN for --image:
az group create --name myURNVM --location westus
az vm create \
--resource-group myURNVM \
--name myVM \
--admin-username azureuser \
--generate-ssh-keys \
--image Canonical:UbuntuServer:18.04-LTS:latest
For an image with purchase plan parameters, like the RabbitMQ Certified by Bitnami image, you pass the URN for --image and also provide the purchase plan parameters:
az group create --name myPurchasePlanRG --location westus
az vm create \
--resource-group myPurchasePlanRG \
--name myVM \
--admin-username azureuser \
--generate-ssh-keys \
--image bitnami:rabbitmq:rabbitmq:latest \
--plan-name rabbitmq \
--plan-product rabbitmq \
--plan-publisher bitnami
If you get a message about accepting the terms of the image, review section Accept the terms. Make sure the output of az vm image accept-terms returns the value "accepted": true, showing that you have accepted the terms of the image.
Using an existing VHD with purchase plan information
If you have an existing VHD from a VM that was created using a paid Azure Marketplace image, you might need to supply the purchase plan information when you create a new VM from that VHD.
If you still have the original VM, or another VM created using the same marketplace image, you can get the plan name, publisher, and product information from it using az vm get-instance-view. This example gets a VM named myVM in the myResourceGroup resource group and then displays the purchase plan information.
az vm get-instance-view -g myResourceGroup -n myVM --query plan
If you didn't get the plan information before the original VM was deleted, you can file a support request. They will need the VM name, subscription ID and the time stamp of the delete operation.
Once you have the plan information, you can create the new VM using the --attach-os-disk parameter to specify the VHD.
az vm create \
--resource-group myResourceGroup \
--name myNewVM \
--nics myNic \
--size Standard_DS1_v2 --os-type Linux \
--attach-os-disk myVHD \
--plan-name planName \
--plan-publisher planPublisher \
--plan-product planProduct
Next steps
To create a virtual machine quickly by using the image information, see Create and Manage Linux VMs with the Azure CLI.
Feedback
Submit and view feedback for