az image

Manage custom virtual machine images.

Commands

az image create Create a custom Virtual Machine Image from managed disks or snapshots.
az image delete Deletes an Image.
az image list List custom VM images.
az image show Gets an image.
az image template Manage and build image builder templates.
az image template create Create an image builder template.
az image template customizer Manage image builder template customizers.
az image template customizer add Add an image builder customizer to an image builder template.
az image template customizer clear Remove all image builder customizers from an image builder template.
az image template customizer remove Remove an image builder customizer from an image builder template.
az image template delete Delete image builder template.
az image template list List image builder templates.
az image template output Manage image builder template output distributors.
az image template output add Add an image builder output distributor to an image builder template.
az image template output clear Remove all image builder output distributors from an image builder template.
az image template output remove Remove an image builder output distributor from an image builder template.
az image template run Build an image builder template.
az image template show Show an image builder template.
az image template show-runs Show an image builder template's run outputs.
az image template update Update an image builder template.
az image template wait Place the CLI in a waiting state until a condition of the template is met.
az image update Update custom VM images.

az image create

Create a custom Virtual Machine Image from managed disks or snapshots.

az image create --name
--resource-group
--source
[--data-disk-sources]
[--hyper-v-generation {V1, V2}]
[--location]
[--os-disk-caching {None, ReadOnly, ReadWrite}]
[--os-type {Linux, Windows}]
[--storage-sku {Premium_LRS, StandardSSD_LRS, Standard_LRS, UltraSSD_LRS}]
[--subscription]
[--tags]
[--zone-resilient {false, true}]

Examples

Create an image from an existing disk.

az image create -g MyResourceGroup -n image1 --os-type Linux \
    --source /subscriptions/db5eb68e-73e2-4fa8-b18a-0123456789999/resourceGroups/rg1/providers/Microsoft.Compute/snapshots/s1

Create an image by capturing an existing generalized virtual machine in the same resource group.

az image create -g MyResourceGroup -n image1 --source MyVm1

Required Parameters

--name -n

New image name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--source

OS disk source from the same region, including a virtual machine ID or name, OS disk blob URI, managed OS disk ID or name, or OS snapshot ID or name.

Optional Parameters

--data-disk-sources

Space-separated list of data disk sources, including unmanaged blob URI, managed disk ID or name, or snapshot ID or name.

--hyper-v-generation

The hypervisor generation of the Virtual Machine created from the image.

accepted values: V1, V2
default value: V1
--location -l

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

--os-disk-caching

Storage caching type for the image's OS disk.

accepted values: None, ReadOnly, ReadWrite
--os-type
accepted values: Linux, Windows
--storage-sku

The SKU of the storage account with which to create the VM image. Unused if source VM is specified.

accepted values: Premium_LRS, StandardSSD_LRS, Standard_LRS, UltraSSD_LRS
--subscription

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

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

--zone-resilient

Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage.

accepted values: false, true

az image delete

Deletes an Image.

az image delete [--ids]
[--name]
[--resource-group]
[--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The name of the image.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

az image list

List custom VM images.

az image list [--resource-group]
[--subscription]

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

az image show

Gets an image.

az image show [--expand]
[--ids]
[--name]
[--resource-group]
[--subscription]

Optional Parameters

--expand

The expand expression to apply on the operation.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The name of the image.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

az image update

Update custom VM images.

az image update [--add]
[--force-string]
[--ids]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]

Examples

Add or update tags.

az image update -n ImageName -g ResourceGroup --tags tag1=val1 tag2=val2

Remove all tags.

az image update -n ImageName -g resourceGroup --tags

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The name of the image.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--subscription

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

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.