Microsoft Azure Image Builder Client Library for Python

Warnings

• breaking The credential system was revamped in the 1.x.x series (e.g., 1.0.0b1). `azure.common.credentials` and `msrestazure.azure_active_directory` are no longer supported. Use classes from `azure-identity` (e.g., `DefaultAzureCredential`).
  Fix: Migrate authentication code to use `azure-identity` library classes like `DefaultAzureCredential`.
• breaking API version 2021-10-01 introduced a change to the error schema for Image Builder. Automations parsing error outputs from earlier API versions may break.
  Fix: Update automation logic to parse the new error schema. Avoid reverting to older API versions after switching.
• breaking After March 31, 2026, new virtual networks in Azure will default to private subnets. This affects AIB templates that specify `subnetId` or `containerInstanceSubnetId`, requiring explicit outbound access for build/validation VMs if needed.
  Fix: Ensure that any specified subnets in `subnetId` or `containerInstanceSubnetId` fields have outbound access enabled if the build or validation VMs require it.
• gotcha Azure VM Image Builder requires a user-assigned managed identity with specific permissions (e.g., 'Managed Identity Operator' role, read/write to images, read from storage for scripts) to function correctly. Lack of permissions is a common cause of failures.
  Fix: Ensure a user-assigned managed identity is created and assigned the necessary roles to the Image Builder resource, source image resource group, distribution targets, and any storage accounts holding customizer scripts.
• deprecated Support for Python 2.7 by Azure SDK Python packages officially ended on January 1, 2022.
  Fix: Ensure your environment uses Python 3.8 or later, as required by the package.
• gotcha The 'file' customizer in Azure Image Builder is only suitable for small file downloads (< 20MB). For larger files, it's recommended to use a script or inline command to download them (e.g., `wget`, `curl`, `Invoke-WebRequest`).
  Fix: For large file downloads, use customizer scripts with appropriate download tools instead of the direct file customizer.

Install

• pip install azure-mgmt-imagebuilder azure-identity Install package and authentication library

Imports

• ImageBuilderClient

  from azure.mgmt.imagebuilder import ImageBuilderClient

  The client class is directly under the top-level package for modern Azure SDKs.
• DefaultAzureCredential

  from azure.identity import DefaultAzureCredential

  Older Azure SDK versions used `azure.common.credentials` or `msrestazure.azure_active_directory`. Modern SDKs use `azure-identity` for unified authentication.

Quickstart

This quickstart demonstrates how to authenticate with Azure using `DefaultAzureCredential` and create an `ImageBuilderClient`. It then shows how to list virtual machine image templates within a specified resource group. Ensure `AZURE_SUBSCRIPTION_ID`, `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, and `AZURE_CLIENT_SECRET` environment variables are set for successful authentication.

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.imagebuilder import ImageBuilderClient

# Set environment variables for authentication and subscription
# AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
# AZURE_SUBSCRIPTION_ID

subscription_id = os.environ.get("AZURE_SUBSCRIPTION_ID", "YOUR_SUBSCRIPTION_ID")
resource_group_name = "myResourceGroup"

# Authenticate and create client
try:
    credential = DefaultAzureCredential()
    client = ImageBuilderClient(credential=credential, subscription_id=subscription_id)
    print(f"ImageBuilderClient created for subscription: {subscription_id}")

    # Example: List all image templates in a resource group
    print(f"\nListing image templates in resource group '{resource_group_name}':")
    templates = client.virtual_machine_image_templates.list_by_resource_group(resource_group_name=resource_group_name)
    for template in templates:
        print(f"  - {template.name} ({template.id})")

except Exception as e:
    print(f"An error occurred: {e}")
    print("Please ensure environment variables (AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET, AZURE_SUBSCRIPTION_ID) are set correctly and the resource group exists.")