Microsoft.VirtualMachineImages imageTemplates 2021-10-01

Bicep resource definition

The imageTemplates resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.VirtualMachineImages/imageTemplates resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2021-10-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    buildTimeoutInMinutes: int
    customize: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ]
    distribute: [
      {
        artifactTags: {}
        runOutputName: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ]
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
    vmProfile: {
      osDiskSizeGB: int
      userAssignedIdentities: [
        'string'
      ]
      vmSize: 'string'
      vnetConfig: {
        proxyVmSize: 'string'
        subnetId: 'string'
      }
    }
  }
}

ImageTemplateCustomizer objects

Set the type property to specify the type of object.

For File, use:

  type: 'File'
  destination: 'string'
  sha256Checksum: 'string'
  sourceUri: 'string'

For PowerShell, use:

  type: 'PowerShell'
  inline: [
    'string'
  ]
  runAsSystem: bool
  runElevated: bool
  scriptUri: 'string'
  sha256Checksum: 'string'
  validExitCodes: [
    int
  ]

For Shell, use:

  type: 'Shell'
  inline: [
    'string'
  ]
  scriptUri: 'string'
  sha256Checksum: 'string'

For WindowsRestart, use:

  type: 'WindowsRestart'
  restartCheckCommand: 'string'
  restartCommand: 'string'
  restartTimeout: 'string'

For WindowsUpdate, use:

  type: 'WindowsUpdate'
  filters: [
    'string'
  ]
  searchCriteria: 'string'
  updateLimit: int

ImageTemplateDistributor objects

Set the type property to specify the type of object.

For ManagedImage, use:

  type: 'ManagedImage'
  imageId: 'string'
  location: 'string'

For SharedImage, use:

  type: 'SharedImage'
  excludeFromLatest: bool
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  storageAccountType: 'string'

For VHD, use:

  type: 'VHD'

ImageTemplateSource objects

Set the type property to specify the type of object.

For ManagedImage, use:

  type: 'ManagedImage'
  imageId: 'string'

For PlatformImage, use:

  type: 'PlatformImage'
  offer: 'string'
  planInfo: {
    planName: 'string'
    planProduct: 'string'
    planPublisher: 'string'
  }
  publisher: 'string'
  sku: 'string'
  version: 'string'

For SharedImageVersion, use:

  type: 'SharedImageVersion'
  imageVersionId: 'string'

Property values

imageTemplates

Name Description Value
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
identity The identity of the image template, if configured. ImageTemplateIdentity (required)
properties The properties of the image template ImageTemplateProperties

ImageTemplateIdentity

Name Description Value
type The type of identity used for the image template. The type 'None' will remove any identities from the image template. 'None'
'UserAssigned'
userAssignedIdentities The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Name Description Value
{customized property} ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ImageTemplateProperties

Name Description Value
buildTimeoutInMinutes Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours). int

Constraints:
Min value = 0
Max value = 960
customize Specifies the properties used to describe the customization steps of the image, like Image source etc ImageTemplateCustomizer[]
distribute The distribution targets where the image output needs to go to. ImageTemplateDistributor[] (required)
source Specifies the properties used to describe the source image. ImageTemplateSource (required)
vmProfile Describes how virtual machine is set up to build images ImageTemplateVmProfile

ImageTemplateCustomizer

Name Description Value
name Friendly Name to provide context on what this customization step does string
type Set the object type File
PowerShell
Shell
WindowsRestart
WindowsUpdate (required)

ImageTemplateFileCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer 'File' (required)
destination The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM string
sha256Checksum SHA256 checksum of the file provided in the sourceUri field above string
sourceUri The URI of the file to be uploaded for customizing the VM. It can be a github link, SAS URI for Azure Storage, etc string

ImageTemplatePowerShellCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer 'PowerShell' (required)
inline Array of PowerShell commands to execute string[]
runAsSystem If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true. bool
runElevated If specified, the PowerShell script will be run with elevated privileges bool
scriptUri URI of the PowerShell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc string
sha256Checksum SHA256 checksum of the power shell script provided in the scriptUri field above string
validExitCodes Valid exit codes for the PowerShell script. [Default: 0] int[]

ImageTemplateShellCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer 'Shell' (required)
inline Array of shell commands to execute string[]
scriptUri URI of the shell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc string
sha256Checksum SHA256 checksum of the shell script provided in the scriptUri field string

ImageTemplateRestartCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer 'WindowsRestart' (required)
restartCheckCommand Command to check if restart succeeded [Default: ''] string
restartCommand Command to execute the restart [Default: 'shutdown /r /f /t 0 /c "packer restart"'] string
restartTimeout Restart timeout specified as a string of magnitude and unit, e.g. '5m' (5 minutes) or '2h' (2 hours) [Default: '5m'] string

ImageTemplateWindowsUpdateCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer 'WindowsUpdate' (required)
filters Array of filters to select updates to apply. Omit or specify empty array to use the default (no filter). Refer to above link for examples and detailed description of this field. string[]
searchCriteria Criteria to search updates. Omit or specify empty string to use the default (search all). Refer to above link for examples and detailed description of this field. string
updateLimit Maximum number of updates to apply at a time. Omit or specify 0 to use the default (1000) int

Constraints:
Min value = 0

ImageTemplateDistributor

Name Description Value
artifactTags Tags that will be applied to the artifact once it has been created/updated by the distributor. object
runOutputName The name to be used for the associated RunOutput. string (required)

Constraints:
Pattern = ^[A-Za-z0-9-_.]{1,64}$
type Set the object type ManagedImage
SharedImage
VHD (required)

ImageTemplateManagedImageDistributor

Name Description Value
type Type of distribution. 'ManagedImage' (required)
imageId Resource Id of the Managed Disk Image string (required)
location Azure location for the image, should match if image already exists string (required)

ImageTemplateSharedImageDistributor

Name Description Value
type Type of distribution. 'SharedImage' (required)
excludeFromLatest Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false). bool
galleryImageId Resource Id of the Shared Image Gallery image string (required)
replicationRegions A list of regions that the image will be replicated to string[] (required)
storageAccountType Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS). 'Standard_LRS'
'Standard_ZRS'

ImageTemplateVhdDistributor

Name Description Value
type Type of distribution. 'VHD' (required)

ImageTemplateSource

Name Description Value
type Set the object type ManagedImage
PlatformImage
SharedImageVersion (required)

ImageTemplateManagedImageSource

Name Description Value
type Specifies the type of source image you want to start with. 'ManagedImage' (required)
imageId ARM resource id of the managed image in customer subscription string (required)

ImageTemplatePlatformImageSource

Name Description Value
type Specifies the type of source image you want to start with. 'PlatformImage' (required)
offer Image offer from the Azure Gallery Images. string
planInfo Optional configuration of purchase plan for platform image. PlatformImagePurchasePlan
publisher Image Publisher in Azure Gallery Images. string
sku Image sku from the Azure Gallery Images. string
version Image version from the Azure Gallery Images. If 'latest' is specified here, the version is evaluated when the image build takes place, not when the template is submitted. string

PlatformImagePurchasePlan

Name Description Value
planName Name of the purchase plan. string (required)
planProduct Product of the purchase plan. string (required)
planPublisher Publisher of the purchase plan. string (required)

ImageTemplateSharedImageVersionSource

Name Description Value
type Specifies the type of source image you want to start with. 'SharedImageVersion' (required)
imageVersionId ARM resource id of the image version in the shared image gallery string (required)

ImageTemplateVmProfile

Name Description Value
osDiskSizeGB Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. int

Constraints:
Min value = 0
userAssignedIdentities Optional array of resource IDs of user assigned managed identities to be configured on the build VM. This may include the identity of the image template. string[]
vmSize Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D2ds_v4). string
vnetConfig Optional configuration of the virtual network to use to deploy the build virtual machine in. Omit if no specific virtual network needs to be used. VirtualNetworkConfig

VirtualNetworkConfig

Name Description Value
proxyVmSize Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). string
subnetId Resource id of a pre-existing subnet. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Image Builder with Azure Windows Baseline

Deploy to Azure
Creates an Azure Image Builder environment and builds a Windows Server image with the latest Windows Updates and Azure Windows Baseline applied.
Configure Dev Box service

Deploy to Azure
This template would create all Dev Box admin resources as per Dev Box quick start guide (https://learn.microsoft.com/azure/dev-box/quickstart-create-dev-box). You can view all resources created, or directly go to DevPortal.microsoft.com to create your first Dev Box.

ARM template resource definition

The imageTemplates resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.VirtualMachineImages/imageTemplates resource, add the following JSON to your template.

{
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "apiVersion": "2021-10-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "buildTimeoutInMinutes": "int",
    "customize": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ],
    "distribute": [
      {
        "artifactTags": {},
        "runOutputName": "string",
        "type": "string"
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ],
    "source": {
      "type": "string"
      // For remaining properties, see ImageTemplateSource objects
    },
    "vmProfile": {
      "osDiskSizeGB": "int",
      "userAssignedIdentities": [ "string" ],
      "vmSize": "string",
      "vnetConfig": {
        "proxyVmSize": "string",
        "subnetId": "string"
      }
    }
  }
}

ImageTemplateCustomizer objects

Set the type property to specify the type of object.

For File, use:

  "type": "File",
  "destination": "string",
  "sha256Checksum": "string",
  "sourceUri": "string"

For PowerShell, use:

  "type": "PowerShell",
  "inline": [ "string" ],
  "runAsSystem": "bool",
  "runElevated": "bool",
  "scriptUri": "string",
  "sha256Checksum": "string",
  "validExitCodes": [ "int" ]

For Shell, use:

  "type": "Shell",
  "inline": [ "string" ],
  "scriptUri": "string",
  "sha256Checksum": "string"

For WindowsRestart, use:

  "type": "WindowsRestart",
  "restartCheckCommand": "string",
  "restartCommand": "string",
  "restartTimeout": "string"

For WindowsUpdate, use:

  "type": "WindowsUpdate",
  "filters": [ "string" ],
  "searchCriteria": "string",
  "updateLimit": "int"

ImageTemplateDistributor objects

Set the type property to specify the type of object.

For ManagedImage, use:

  "type": "ManagedImage",
  "imageId": "string",
  "location": "string"

For SharedImage, use:

  "type": "SharedImage",
  "excludeFromLatest": "bool",
  "galleryImageId": "string",
  "replicationRegions": [ "string" ],
  "storageAccountType": "string"

For VHD, use:

  "type": "VHD"

ImageTemplateSource objects

Set the type property to specify the type of object.

For ManagedImage, use:

  "type": "ManagedImage",
  "imageId": "string"

For PlatformImage, use:

  "type": "PlatformImage",
  "offer": "string",
  "planInfo": {
    "planName": "string",
    "planProduct": "string",
    "planPublisher": "string"
  },
  "publisher": "string",
  "sku": "string",
  "version": "string"

For SharedImageVersion, use:

  "type": "SharedImageVersion",
  "imageVersionId": "string"

Property values

imageTemplates

Name Description Value
type The resource type 'Microsoft.VirtualMachineImages/imageTemplates'
apiVersion The resource api version '2021-10-01'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
identity The identity of the image template, if configured. ImageTemplateIdentity (required)
properties The properties of the image template ImageTemplateProperties

ImageTemplateIdentity

Name Description Value
type The type of identity used for the image template. The type 'None' will remove any identities from the image template. 'None'
'UserAssigned'
userAssignedIdentities The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Name Description Value
{customized property} ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ImageTemplateProperties

Name Description Value
buildTimeoutInMinutes Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours). int

Constraints:
Min value = 0
Max value = 960
customize Specifies the properties used to describe the customization steps of the image, like Image source etc ImageTemplateCustomizer[]
distribute The distribution targets where the image output needs to go to. ImageTemplateDistributor[] (required)
source Specifies the properties used to describe the source image. ImageTemplateSource (required)
vmProfile Describes how virtual machine is set up to build images ImageTemplateVmProfile

ImageTemplateCustomizer

Name Description Value
name Friendly Name to provide context on what this customization step does string
type Set the object type File
PowerShell
Shell
WindowsRestart
WindowsUpdate (required)

ImageTemplateFileCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer 'File' (required)
destination The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM string
sha256Checksum SHA256 checksum of the file provided in the sourceUri field above string
sourceUri The URI of the file to be uploaded for customizing the VM. It can be a github link, SAS URI for Azure Storage, etc string

ImageTemplatePowerShellCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer 'PowerShell' (required)
inline Array of PowerShell commands to execute string[]
runAsSystem If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true. bool
runElevated If specified, the PowerShell script will be run with elevated privileges bool
scriptUri URI of the PowerShell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc string
sha256Checksum SHA256 checksum of the power shell script provided in the scriptUri field above string
validExitCodes Valid exit codes for the PowerShell script. [Default: 0] int[]

ImageTemplateShellCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer 'Shell' (required)
inline Array of shell commands to execute string[]
scriptUri URI of the shell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc string
sha256Checksum SHA256 checksum of the shell script provided in the scriptUri field string

ImageTemplateRestartCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer 'WindowsRestart' (required)
restartCheckCommand Command to check if restart succeeded [Default: ''] string
restartCommand Command to execute the restart [Default: 'shutdown /r /f /t 0 /c "packer restart"'] string
restartTimeout Restart timeout specified as a string of magnitude and unit, e.g. '5m' (5 minutes) or '2h' (2 hours) [Default: '5m'] string

ImageTemplateWindowsUpdateCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer 'WindowsUpdate' (required)
filters Array of filters to select updates to apply. Omit or specify empty array to use the default (no filter). Refer to above link for examples and detailed description of this field. string[]
searchCriteria Criteria to search updates. Omit or specify empty string to use the default (search all). Refer to above link for examples and detailed description of this field. string
updateLimit Maximum number of updates to apply at a time. Omit or specify 0 to use the default (1000) int

Constraints:
Min value = 0

ImageTemplateDistributor

Name Description Value
artifactTags Tags that will be applied to the artifact once it has been created/updated by the distributor. object
runOutputName The name to be used for the associated RunOutput. string (required)

Constraints:
Pattern = ^[A-Za-z0-9-_.]{1,64}$
type Set the object type ManagedImage
SharedImage
VHD (required)

ImageTemplateManagedImageDistributor

Name Description Value
type Type of distribution. 'ManagedImage' (required)
imageId Resource Id of the Managed Disk Image string (required)
location Azure location for the image, should match if image already exists string (required)

ImageTemplateSharedImageDistributor

Name Description Value
type Type of distribution. 'SharedImage' (required)
excludeFromLatest Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false). bool
galleryImageId Resource Id of the Shared Image Gallery image string (required)
replicationRegions A list of regions that the image will be replicated to string[] (required)
storageAccountType Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS). 'Standard_LRS'
'Standard_ZRS'

ImageTemplateVhdDistributor

Name Description Value
type Type of distribution. 'VHD' (required)

ImageTemplateSource

Name Description Value
type Set the object type ManagedImage
PlatformImage
SharedImageVersion (required)

ImageTemplateManagedImageSource

Name Description Value
type Specifies the type of source image you want to start with. 'ManagedImage' (required)
imageId ARM resource id of the managed image in customer subscription string (required)

ImageTemplatePlatformImageSource

Name Description Value
type Specifies the type of source image you want to start with. 'PlatformImage' (required)
offer Image offer from the Azure Gallery Images. string
planInfo Optional configuration of purchase plan for platform image. PlatformImagePurchasePlan
publisher Image Publisher in Azure Gallery Images. string
sku Image sku from the Azure Gallery Images. string
version Image version from the Azure Gallery Images. If 'latest' is specified here, the version is evaluated when the image build takes place, not when the template is submitted. string

PlatformImagePurchasePlan

Name Description Value
planName Name of the purchase plan. string (required)
planProduct Product of the purchase plan. string (required)
planPublisher Publisher of the purchase plan. string (required)

ImageTemplateSharedImageVersionSource

Name Description Value
type Specifies the type of source image you want to start with. 'SharedImageVersion' (required)
imageVersionId ARM resource id of the image version in the shared image gallery string (required)

ImageTemplateVmProfile

Name Description Value
osDiskSizeGB Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. int

Constraints:
Min value = 0
userAssignedIdentities Optional array of resource IDs of user assigned managed identities to be configured on the build VM. This may include the identity of the image template. string[]
vmSize Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D2ds_v4). string
vnetConfig Optional configuration of the virtual network to use to deploy the build virtual machine in. Omit if no specific virtual network needs to be used. VirtualNetworkConfig

VirtualNetworkConfig

Name Description Value
proxyVmSize Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). string
subnetId Resource id of a pre-existing subnet. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Image Builder with Azure Windows Baseline

Deploy to Azure
Creates an Azure Image Builder environment and builds a Windows Server image with the latest Windows Updates and Azure Windows Baseline applied.
Configure Dev Box service

Deploy to Azure
This template would create all Dev Box admin resources as per Dev Box quick start guide (https://learn.microsoft.com/azure/dev-box/quickstart-create-dev-box). You can view all resources created, or directly go to DevPortal.microsoft.com to create your first Dev Box.

Terraform (AzAPI provider) resource definition

The imageTemplates resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.VirtualMachineImages/imageTemplates resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.VirtualMachineImages/imageTemplates@2021-10-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "UserAssigned"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      buildTimeoutInMinutes = int
      customize = [
        {
          name = "string"
          type = "string"
          // For remaining properties, see ImageTemplateCustomizer objects
        }
      ]
      distribute = [
        {
          artifactTags = {}
          runOutputName = "string"
          type = "string"
          // For remaining properties, see ImageTemplateDistributor objects
        }
      ]
      source = {
        type = "string"
        // For remaining properties, see ImageTemplateSource objects
      }
      vmProfile = {
        osDiskSizeGB = int
        userAssignedIdentities = [
          "string"
        ]
        vmSize = "string"
        vnetConfig = {
          proxyVmSize = "string"
          subnetId = "string"
        }
      }
    }
  })
}

ImageTemplateCustomizer objects

Set the type property to specify the type of object.

For File, use:

  type = "File"
  destination = "string"
  sha256Checksum = "string"
  sourceUri = "string"

For PowerShell, use:

  type = "PowerShell"
  inline = [
    "string"
  ]
  runAsSystem = bool
  runElevated = bool
  scriptUri = "string"
  sha256Checksum = "string"
  validExitCodes = [
    int
  ]

For Shell, use:

  type = "Shell"
  inline = [
    "string"
  ]
  scriptUri = "string"
  sha256Checksum = "string"

For WindowsRestart, use:

  type = "WindowsRestart"
  restartCheckCommand = "string"
  restartCommand = "string"
  restartTimeout = "string"

For WindowsUpdate, use:

  type = "WindowsUpdate"
  filters = [
    "string"
  ]
  searchCriteria = "string"
  updateLimit = int

ImageTemplateDistributor objects

Set the type property to specify the type of object.

For ManagedImage, use:

  type = "ManagedImage"
  imageId = "string"
  location = "string"

For SharedImage, use:

  type = "SharedImage"
  excludeFromLatest = bool
  galleryImageId = "string"
  replicationRegions = [
    "string"
  ]
  storageAccountType = "string"

For VHD, use:

  type = "VHD"

ImageTemplateSource objects

Set the type property to specify the type of object.

For ManagedImage, use:

  type = "ManagedImage"
  imageId = "string"

For PlatformImage, use:

  type = "PlatformImage"
  offer = "string"
  planInfo = {
    planName = "string"
    planProduct = "string"
    planPublisher = "string"
  }
  publisher = "string"
  sku = "string"
  version = "string"

For SharedImageVersion, use:

  type = "SharedImageVersion"
  imageVersionId = "string"

Property values

imageTemplates

Name Description Value
type The resource type "Microsoft.VirtualMachineImages/imageTemplates@2021-10-01"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
identity The identity of the image template, if configured. ImageTemplateIdentity (required)
properties The properties of the image template ImageTemplateProperties

ImageTemplateIdentity

Name Description Value
type The type of identity used for the image template. The type 'None' will remove any identities from the image template. "UserAssigned"
identity_ids The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Array of user identity IDs.

ImageTemplateIdentityUserAssignedIdentities

Name Description Value
{customized property} ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ImageTemplateProperties

Name Description Value
buildTimeoutInMinutes Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours). int

Constraints:
Min value = 0
Max value = 960
customize Specifies the properties used to describe the customization steps of the image, like Image source etc ImageTemplateCustomizer[]
distribute The distribution targets where the image output needs to go to. ImageTemplateDistributor[] (required)
source Specifies the properties used to describe the source image. ImageTemplateSource (required)
vmProfile Describes how virtual machine is set up to build images ImageTemplateVmProfile

ImageTemplateCustomizer

Name Description Value
name Friendly Name to provide context on what this customization step does string
type Set the object type File
PowerShell
Shell
WindowsRestart
WindowsUpdate (required)

ImageTemplateFileCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer "File" (required)
destination The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM string
sha256Checksum SHA256 checksum of the file provided in the sourceUri field above string
sourceUri The URI of the file to be uploaded for customizing the VM. It can be a github link, SAS URI for Azure Storage, etc string

ImageTemplatePowerShellCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer "PowerShell" (required)
inline Array of PowerShell commands to execute string[]
runAsSystem If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true. bool
runElevated If specified, the PowerShell script will be run with elevated privileges bool
scriptUri URI of the PowerShell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc string
sha256Checksum SHA256 checksum of the power shell script provided in the scriptUri field above string
validExitCodes Valid exit codes for the PowerShell script. [Default: 0] int[]

ImageTemplateShellCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer "Shell" (required)
inline Array of shell commands to execute string[]
scriptUri URI of the shell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc string
sha256Checksum SHA256 checksum of the shell script provided in the scriptUri field string

ImageTemplateRestartCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer "WindowsRestart" (required)
restartCheckCommand Command to check if restart succeeded [Default: ''] string
restartCommand Command to execute the restart [Default: 'shutdown /r /f /t 0 /c "packer restart"'] string
restartTimeout Restart timeout specified as a string of magnitude and unit, e.g. '5m' (5 minutes) or '2h' (2 hours) [Default: '5m'] string

ImageTemplateWindowsUpdateCustomizer

Name Description Value
type The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer "WindowsUpdate" (required)
filters Array of filters to select updates to apply. Omit or specify empty array to use the default (no filter). Refer to above link for examples and detailed description of this field. string[]
searchCriteria Criteria to search updates. Omit or specify empty string to use the default (search all). Refer to above link for examples and detailed description of this field. string
updateLimit Maximum number of updates to apply at a time. Omit or specify 0 to use the default (1000) int

Constraints:
Min value = 0

ImageTemplateDistributor

Name Description Value
artifactTags Tags that will be applied to the artifact once it has been created/updated by the distributor. object
runOutputName The name to be used for the associated RunOutput. string (required)

Constraints:
Pattern = ^[A-Za-z0-9-_.]{1,64}$
type Set the object type ManagedImage
SharedImage
VHD (required)

ImageTemplateManagedImageDistributor

Name Description Value
type Type of distribution. "ManagedImage" (required)
imageId Resource Id of the Managed Disk Image string (required)
location Azure location for the image, should match if image already exists string (required)

ImageTemplateSharedImageDistributor

Name Description Value
type Type of distribution. "SharedImage" (required)
excludeFromLatest Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false). bool
galleryImageId Resource Id of the Shared Image Gallery image string (required)
replicationRegions A list of regions that the image will be replicated to string[] (required)
storageAccountType Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS). "Standard_LRS"
"Standard_ZRS"

ImageTemplateVhdDistributor

Name Description Value
type Type of distribution. "VHD" (required)

ImageTemplateSource

Name Description Value
type Set the object type ManagedImage
PlatformImage
SharedImageVersion (required)

ImageTemplateManagedImageSource

Name Description Value
type Specifies the type of source image you want to start with. "ManagedImage" (required)
imageId ARM resource id of the managed image in customer subscription string (required)

ImageTemplatePlatformImageSource

Name Description Value
type Specifies the type of source image you want to start with. "PlatformImage" (required)
offer Image offer from the Azure Gallery Images. string
planInfo Optional configuration of purchase plan for platform image. PlatformImagePurchasePlan
publisher Image Publisher in Azure Gallery Images. string
sku Image sku from the Azure Gallery Images. string
version Image version from the Azure Gallery Images. If 'latest' is specified here, the version is evaluated when the image build takes place, not when the template is submitted. string

PlatformImagePurchasePlan

Name Description Value
planName Name of the purchase plan. string (required)
planProduct Product of the purchase plan. string (required)
planPublisher Publisher of the purchase plan. string (required)

ImageTemplateSharedImageVersionSource

Name Description Value
type Specifies the type of source image you want to start with. "SharedImageVersion" (required)
imageVersionId ARM resource id of the image version in the shared image gallery string (required)

ImageTemplateVmProfile

Name Description Value
osDiskSizeGB Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. int

Constraints:
Min value = 0
userAssignedIdentities Optional array of resource IDs of user assigned managed identities to be configured on the build VM. This may include the identity of the image template. string[]
vmSize Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D2ds_v4). string
vnetConfig Optional configuration of the virtual network to use to deploy the build virtual machine in. Omit if no specific virtual network needs to be used. VirtualNetworkConfig

VirtualNetworkConfig

Name Description Value
proxyVmSize Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). string
subnetId Resource id of a pre-existing subnet. string