az image
Manage custom virtual machine images.
Commands
az image builder |
Manage and build image builder templates. |
az image builder cancel |
Cancel the long running image build based on the image template. |
az image builder create |
Create an image builder template. |
az image builder customizer |
Manage image builder template customizers. |
az image builder customizer add |
Add an image builder customizer to an image builder template. |
az image builder customizer clear |
Remove all image builder customizers from an image builder template. |
az image builder customizer remove |
Remove an image builder customizer from an image builder template. |
az image builder delete |
Delete image builder template. |
az image builder list |
List image builder templates. |
az image builder output |
Manage image builder template output distributors. |
az image builder output add |
Add an image builder output distributor to an image builder template. |
az image builder output clear |
Remove all image builder output distributors from an image builder template. |
az image builder output remove |
Remove an image builder output distributor from an image builder template. |
az image builder run |
Build an image builder template. |
az image builder show |
Show an image builder template. |
az image builder show-runs |
Show an image builder template's run outputs. |
az image builder update |
Update an image builder template. |
az image builder validator |
Manage image builder template validate. |
az image builder validator add |
Add validate to an existing image builder template. |
az image builder validator remove |
Remove validate from an existing image builder template. |
az image builder validator show |
Show validate of an existing image builder template. |
az image builder wait |
Place the CLI in a waiting state until a condition of the template is met. |
az image copy |
Copy a managed image (or vm) to other regions. It requires the source disk to be available. |
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 update |
Update custom VM images. |
az image copy
Copy a managed image (or vm) to other regions. It requires the source disk to be available.
az image copy --source-object-name
--source-resource-group
--target-location
--target-resource-group
[--cleanup]
[--export-as-snapshot]
[--parallel-degree]
[--source-type {image, vm}]
[--tags]
[--target-name]
[--target-subscription]
[--temporary-resource-group-name]
[--timeout]
Examples
Copy an image to several regions and cleanup at the end.
az image copy --source-resource-group mySources-rg --source-object-name myImage \
--target-location uksouth northeurope --target-resource-group "images-repo-rg" --cleanup
Use an already generalized vm to create images in other regions.
az image copy --source-resource-group mySources-rg --source-object-name myVm \
--source-type vm --target-location uksouth northeurope --target-resource-group "images-repo-rg"
Required Parameters
The name of the image or vm resource.
Name of the resource group of the source resource.
Space separated location list to create the image in (e.g. westeurope etc.).
Name of the resource group to create images in.
Optional Parameters
Include this switch to delete temporary resources upon completion.
Include this switch to export the copies as snapshots instead of images.
Number of parallel copy operations.
Image or vm.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Name of the final image that will be created.
Name or ID of the subscription where the final image should be created.
Resource Group name where temporary storage account will be created. --temporary_resource_group_name will be deprecated in 0.2.7.
Time in seconds for the copy operation to finish. Increase this time if you are going to copy large images (disks) like 512GB or more.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az image create
Create a custom Virtual Machine Image from managed disks or snapshots.
az image create --name
--resource-group
--source
[--data-disk-caching {None, ReadOnly, ReadWrite}]
[--data-disk-sources]
[--edge-zone]
[--hyper-v-generation {V1, V2}]
[--location]
[--os-disk-caching {None, ReadOnly, ReadWrite}]
[--os-type {Linux, Windows}]
[--storage-sku {PremiumV2_LRS, Premium_LRS, Premium_ZRS, StandardSSD_LRS, StandardSSD_ZRS, Standard_LRS, UltraSSD_LRS}]
[--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
New image name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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
Storage caching type for the image's data disk.
Space-separated list of data disk sources, including unmanaged blob URI, managed disk ID or name, or snapshot ID or name.
The name of edge zone.
The hypervisor generation of the Virtual Machine created from the image.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Storage caching type for the image's OS disk.
The SKU of the storage account with which to create the VM image. Unused if source VM is specified.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az image delete
Deletes an Image.
az image delete [--ids]
[--name]
[--resource-group]
[--subscription]
Optional Parameters
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.
The name of the image. Required.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az image list
List custom VM images.
az image list [--resource-group]
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az image show
Gets an image.
az image show [--expand]
[--ids]
[--name]
[--resource-group]
[--subscription]
Optional Parameters
The expand expression to apply on the operation. Default value is None.
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.
The name of the image. Required.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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 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>.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
The name of the image. Required.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Submit and view feedback for