On the server that Active Directory Domain Services (AD DS) runs on, open Active Directory Users and Computers by typing dsa.msc in the Run dialog, and then click OK. Click Users under your domain, and then do the following: If there's only one affected user, right-click the user, and then click Properties. Resources for IT Professionals Sign in. United States (English). Creating a custom default profile is a good way to streamline a Windows 10 deployment. How do you achieve this? Note:-this article refers to the default profile creation process on Windows 10 version 1803, fully patched as of.

-->

If Azure Image Builder creates a Windows custom image successfully, and you create a VM from it, then find that the VM creation fails or does not complete successfully, you will need to review the Windows Server Sysprep documentation or raise a support request with the Windows Server Sysprep Customer Services Support team, who can troubleshoot.

Azure Image Builder uses a .json file to pass information into the Image Builder service. In this article we will go over the sections of the json file, so you can build your own. To see examples of full .json files, see the Azure Image Builder GitHub.

This is the basic template format:

Type and API version

The type is the resource type, which must be 'Microsoft.VirtualMachineImages/imageTemplates'. The apiVersion will change over time as the API changes, but should be '2020-02-14' for preview.

Location

The location is the region where the custom image will be created. For the Image Builder preview, the following regions are supported:

East US
East US 2
West Central US
West US
West US 2
South Central US
North Europe
West Europe
South East Asia
Australia Southeast
Australia East
UK South
UK West

Data Residency

The Azure VM Image Builder service doesn't store/process customer data outside regions that have strict single region data residency requirements when a customer requests a build in that region. In the event of a service outage for regions that have data residency requirements, you will need to create templates in a different region and geography.

Zone Redundancy

Distribution supports zone redundancy, VHDs are distributed to a Zone Redundant Storage account by default and the Shared Image Gallery version will support a ZRS storage type if specified.

vmProfile

buildVM

By default Image Builder will use a 'Standard_D1_v2' build VM, this is built from the image you specify in the source. You can override this and may wish to do this for these reasons:

Performing customizations that require increased memory, CPU and handling large files (GBs).
Running Windows builds, you should use 'Standard_D2_v2' or equivalent VM size.
Require VM isolation.
Customize an Image that require specific hardware, e.g. for a GPU VM, you need a GPU VM size.
Require end to end encryption at rest of the build VM, you need to specify the support build VM size that don't use local temporary disks.

This is optional.

Proxy VM Size

The proxy VM is used to send commands between the Azure Image Builder Service and the build VM, this is only deployed when specifying an existing VNET, for more details review the networking options documentation.

This is optional.

osDiskSizeGB

By default, Image Builder will not change the size of the image, it will use the size from the source image. You can only increase the size of the OS Disk (Win and Linux), this is optional, and a value of 0 means leave the same size as the source image. You cannot reduce the OS Disk size to smaller than the size from the source image.

vnetConfig

If you do not specify any VNET properties, then Image Builder will create its own VNET, Public IP, and NSG. The Public IP is used for the service to communicate with the build VM, however if you do not want a Public IP or want Image Builder to have access to your existing VNET resources, such as configuration servers (DSC, Chef, Puppet, Ansible), file shares etc., then you can specify a VNET. For more information, review the networking documentation, this is optional.

Depends on (optional)

This optional section can be used to ensure that dependencies are completed before proceeding.

For more information, see Define resource dependencies.

Identity

Required - For Image Builder to have permissions to read/write images, read in scripts from Azure Storage you must create an Azure User-Assigned Identity, that has permissions to the individual resources. For details on how Image Builder permissions work, and relevant steps, please review the documentation.

Image Builder support for a User-Assigned Identity:

Supports a single identity only
Does not support custom domain names

To learn more, see What is managed identities for Azure resources?.For more information on deploying this feature, see Configure managed identities for Azure resources on an Azure VM using Azure CLI.

Properties: source

The source section contains information about the source image that will be used by Image Builder. Image Builder currently only natively supports creating Hyper-V generation (Gen1) 1 images to the Azure Shared Image Gallery (SIG) or Managed Image. If you want to create Gen2 images, then you need to use a source Gen2 image, and distribute to VHD. After, you will then need to create a Managed Image from the VHD, and inject it into the SIG as a Gen2 image.

The API requires a 'SourceType' that defines the source for the image build, currently there are three types:

PlatformImage - indicated the source image is a Marketplace image.
ManagedImage - use this when starting from a regular managed image.
SharedImageVersion - this is used when you are using an image version in a Shared Image Gallery as the source.

Note

When using existing Windows custom images, you can run the Sysprep command up to 3 times on a single Windows 7 or Windows Server 2008 R2 image, or 1001 times on a single Windows image for later versions; for more information, see the sysprep documentation.

PlatformImage source

User Oobe Create Elevated Object Server Autopilot

Azure Image Builder supports Windows Server and client, and Linux Azure Marketplace images, see here for the full list.

The properties here are the same that are used to create VM's, using AZ CLI, run the below to get the properties:

You can use 'latest' in the version, the version is evaluated when the image build takes place, not when the template is submitted. If you use this functionality with the Shared Image Gallery destination, you can avoid resubmitting the template, and rerun the image build at intervals, so your images are recreated from the most recent images.

Support for Market Place Plan Information

You can also specify plan information, for example:

ManagedImage source

Sets the source image as an existing managed image of a generalized VHD or VM.

Note

The source managed image must be of a supported OS and the image must same region as your Azure Image Builder template.

The imageId should be the ResourceId of the managed image. Use az image list to list available images.

SharedImageVersion source

Sets the source image an existing image version in a Shared Image Gallery.

Note

The source managed image must be of a supported OS and the image must same region as your Azure Image Builder template, if not, please replicate the image version to the Image Builder Template region.

The imageVersionId should be the ResourceId of the image version. Use az sig image-version list to list im

Type and API version

Location

Data Residency

Zone Redundancy

vmProfile

buildVM

Proxy VM Size

osDiskSizeGB

vnetConfig

Tags

Depends on (optional)

Identity

Properties: source

PlatformImage source

User Oobe Create Elevated Object Server Autopilot

Support for Market Place Plan Information

ManagedImage source

SharedImageVersion source