azure-image-builder

This repository was renamed. Live version: hashicorp/agent-skills/azure-image-builder

Install

npx skills add hashicorp/terraform-agent-kit --skill azure-image-builder

Overview

Build Azure managed images and Azure Compute Gallery images with Packer. Use when creating custom images for Azure VMs.

Also available at

The same skill content is published under more than one repo. The install counts are split across them; any of these commands works.

Other names for this repo

hashicorp/agent-skillsLive1.7k installs

Documentation

Azure Image Builder

Build Azure managed images and Azure Compute Gallery images using Packer's azure-arm builder.

Reference: Azure ARM Builder

Note: Building Azure images incurs costs (compute, storage, data transfer). Builds typically take 15-45 minutes depending on provisioning and OS.

Basic Managed Image

packer {
  required_plugins {
    azure = {
      source  = "github.com/hashicorp/azure"
      version = "~> 2.0"

Azure Compute Gallery

Authentication

Service Principal

Managed Identity

Build Commands

Common Issues

Authentication Failed

Verify service principal credentials
Ensure Contributor role on resource group
Check subscription and tenant IDs

Compute Gallery Version Exists

Image versions are immutable
Use unique version numbers with date/build number
Cannot overwrite existing versions

Timeout During Provisioning

Check network connectivity from build VM
Verify NSG rules allow required traffic
Increase timeout if needed

References

Install

npx skills add hashicorp/terraform-agent-kit --skill azure-image-builder

Overview

Documentation

azure-image-builder | SkillBundle

source "azure-arm" "ubuntu" {
  client_id       = var.client_id
  client_secret   = var.client_secret
  subscription_id = var.subscription_id
  tenant_id       = var.tenant_id
 
  os_type         = "Linux"
  image_publisher = "Canonical"
  image_offer     = "0001-com-ubuntu-server-jammy"
  image_sku       = "22_04-lts-gen2"
 
  location = "East US"
  vm_size  = "Standard_B2s"
 
  shared_image_gallery_destination {
    resource_group       = "gallery-rg"
    gallery_name         = "myImageGallery"
    image_name           = "ubuntu-webapp"
    image_version        = "1.0.${formatdate("YYYYMMDD", timestamp())}"
    replication_regions  = ["East US", "West US 2"]
    storage_account_type = "Standard_LRS"
  }
}

# Create service principal
az ad sp create-for-rbac \
  --name "packer-sp" \
  --role Contributor \
  --scopes /subscriptions/<subscription-id>
 
# Set environment variables
export ARM_CLIENT_ID="<client-id>"
export ARM_CLIENT_SECRET="<client-secret>"
export ARM_SUBSCRIPTION_ID="<subscription-id>"
export ARM_TENANT_ID="<tenant-id>"

source "azure-arm" "ubuntu" {
  use_azure_cli_auth = true
  subscription_id    = var.subscription_id
  # ... rest of configuration
}

# Set authentication
export ARM_CLIENT_ID="your-client-id"
export ARM_CLIENT_SECRET="your-client-secret"
export ARM_SUBSCRIPTION_ID="your-subscription-id"
export ARM_TENANT_ID="your-tenant-id"
 
# Initialize plugins
packer init .
 
# Validate template
packer validate .
 
# Build image
packer build .