How to use the command 'az image' (with examples)

The az image command in Azure CLI (Azure Command-Line Interface) is a powerful tool designed for managing custom Virtual Machine (VM) images in Azure. This command allows users to perform a range of operations, such as listing, creating, updating, and deleting custom images. These capabilities are crucial for maintaining the efficiency and effectiveness of cloud operations, especially when deploying multiple VMs with the same configuration.

Use case 1: List the custom images under a resource group

Code:

az image list --resource-group resource_group

Motivation:

Listing custom images is an essential task for cloud administrators who need to manage their Azure environments efficiently. By being able to view all custom images within a specific resource group, administrators can quickly assess available resources, plan deployments, and maintain inventory. This capability ensures that they are using the right images for their virtual machines, avoiding unnecessary image creation or deletion.

Explanation:

• az image list: This part of the command specifies the action to list all images.
• --resource-group resource_group: This argument specifies the resource group where the images are located. In Azure, a resource group is a container that holds related resources for an Azure solution. The resource_group should be replaced with the actual name of your resource group.

Example Output:

Upon executing the command, you would receive a list of all custom images in the specified resource group. This list would include details such as image names, creation timestamps, OS types, and other metadata.

Use case 2: Create a custom image from managed disks or snapshots

Code:

az image create --resource-group resource_group --name custom_image_name --os-type linux --source os_disk_source

Motivation:

Creating custom images is crucial for replicating virtual machine configurations across an organization. It allows administrators to set up a virtual machine with a specific configuration and save it as an image, which can be used to deploy new virtual machines without repeating the setup process. This not only saves time but also ensures consistency in VM setups.

Explanation:

• az image create: This command prompts Azure to initiate the creation of a new custom image.
• --resource-group resource_group: Specifies the resource group within which the image will be created.
• --name custom_image_name: Defines the name of the new custom image.
• --os-type linux: Indicates the operating system type of the source disk; it can be linux or windows.
• --source os_disk_source: Specifies the managed disk or snapshot you are using as the base of your custom image.

Example Output:

The output will confirm the creation of a custom image, providing details such as the image’s resource ID, location, and other pertinent metadata.

Use case 3: Delete a custom image

Code:

az image delete --name custom_image_name --resource-group resource_group

Motivation:

Deleting unused or outdated images is important for managing and optimizing resources effectively. It helps eliminate clutter in the resource group and reduces unnecessary expenses by ensuring only required images are stored and maintained.

Explanation:

• az image delete: This part of the command indicates the deletion of a specific custom image.
• --name custom_image_name: Specifies the name of the image that needs to be deleted.
• --resource-group resource_group: Identifies the resource group containing the image.

Example Output:

Successful execution of the command will not produce direct output, but the custom image will be removed from the specified resource group.

Use case 4: Show details of a custom image

Code:

az image show --name custom_image_name --resource-group resource_group

Motivation:

Viewing the details of a custom image is essential for verifying configurations, understanding dependencies, and making informed decisions about deployments and updates. It provides comprehensive information about an image, ensuring that administrators have all the necessary details at their fingertips.

Explanation:

• az image show: This command is used to display detailed information about a specific image.
• --name custom_image_name: Specifies which image’s details are to be shown.
• --resource-group resource_group: Determines the resource group of the image.

Example Output:

The output will include a detailed JSON object containing information about the image, such as its size, location, properties, associated tags, and more.

Use case 5: Update custom images

Code:

az image update --name custom_image_name --resource-group resource_group --set property=value

Motivation:

Updating images allows administrators to modify details and configurations of existing images without needing to recreate them. This ability is vital for applying new settings, optimizing performance, or adjusting properties to meet changing organizational needs.

Explanation:

• az image update: This command signifies that a particular image’s properties will be updated.
• --name custom_image_name: Identifies which image is to be updated.
• --resource-group resource_group: Specifies the resource group that contains the image.
• --set property=value: Allows you to modify specific properties of the image, where property is a placeholder for the actual property name you want to change and value is the new value.

Example Output:

The output will reflect the success of the update operation and present the new configuration of the image in a JSON format, detailing the changes made.

Conclusion:

The az image command in Azure CLI is integral to the management of custom VM images, enabling efficient and effective operations in the Azure cloud environment. By utilizing the az image functionalities, administrators can streamline their processes, ensure consistency across VM deployments, and maintain optimal resource utilization. Each use case provided showcases the versatility of this command and the crucial tasks it can accomplish.