devtest-lab-create-custom-image-from-vhd-using-powershell.md

title	description	ms.topic	ms.author	author	ms.date	ms.custom
Create a custom image from VHD file by using Azure PowerShell	Automate creation of a custom image in Azure DevTest Labs from a VHD file by using PowerShell.	how-to	rosemalcolm	RoseHJM	10/24/2021	devx-track-azurepowershell

Create a custom image from a VHD file with PowerShell

[!INCLUDE devtest-lab-create-custom-image-from-vhd-selector]

[!INCLUDE devtest-lab-custom-image-definition]

[!INCLUDE devtest-lab-upload-vhd-options]

[!INCLUDE updated-for-az]

PowerShell steps

The following steps walk you through creating a custom image from a VHD file by using Azure PowerShell:

1. At a PowerShell command prompt, sign in to your Azure account with the Connect-AzAccount cmdlet:

   Connect-AzAccount

2. Select your Azure subscription with the Select-AzSubscription cmdlet. Replace <subscription ID> with your subscription ID GUID.

   $subscriptionId = '<subscription ID>'
   Select-AzSubscription -SubscriptionId $subscriptionId

3. Get the lab object by calling the Get-AzResource cmdlet. Replace the <lab resource group name> and <lab name> placeholders with your own resource group and lab names.

   $labRg = '<lab resource group name>'
   $labName = '<lab name>'
   $lab = Get-AzResource -ResourceId ('/subscriptions/' + $subscriptionId + '/resourceGroups/' + $labRg + '/providers/Microsoft.DevTestLab/labs/' + $labName)

4. Replace the placeholder for the $vhdUri variable with the URI of your uploaded VHD file. You can get the VHD file's URI from its blob page in the lab's storage account in the Azure portal. An example VHD URI is: https://acontosolab1234.blob.core.windows.net/uploads/myvhd.vhd.

   $vhdUri = '<VHD URI>'

5. Create the custom image by using the New-AzResourceGroupDeployment cmdlet. Replace the <custom image name> and <custom image description> placeholders with the name and description you want.

   $customImageName = '<custom image name>'
   $customImageDescription = '<custom image description>'
   
   $parameters = @{existingLabName="$($lab.Name)"; existingVhdUri=$vhdUri; imageOsType='windows'; isVhdSysPrepped=$false; imageName=$customImageName; imageDescription=$customImageDescription}
   
   New-AzResourceGroupDeployment -ResourceGroupName $lab.ResourceGroupName -Name CreateCustomImage -TemplateUri 'https://raw.githubusercontent.com/Azure/azure-devtestlab/master/samples/DevTestLabs/QuickStartTemplates/201-dtl-create-customimage-from-vhd/azuredeploy.json' -TemplateParameterObject $parameters

Complete PowerShell script

Combining the preceding steps produces the following PowerShell script that creates a custom image from a VHD file. To use the script, replace the following placeholders with your own values:

• <subscription ID>
• <lab resource group name>
• <lab name>
• <VHD URI>
• <custom image name>
• <custom image description>

# Log in to your Azure account.
Connect-AzAccount

# Select the desired Azure subscription.
$subscriptionId = '<subscription ID>'
Select-AzSubscription -SubscriptionId $subscriptionId

# Get the lab object.
$labRg = '<lab resource group name>'
$labName = '<lab name>'
$lab = Get-AzResource -ResourceId ('/subscriptions/' + $subscriptionId + '/resourceGroups/' + $labRg + '/providers/Microsoft.DevTestLab/labs/' + $labName)

# Set the URI of the VHD file.
$vhdUri = '<VHD URI>'

# Set the custom image name and description values.
$customImageName = '<custom image name>'
$customImageDescription = '<custom image description>'

# Set up the parameters object.
$parameters = @{existingLabName="$($lab.Name)"; existingVhdUri=$vhdUri; imageOsType='windows'; isVhdSysPrepped=$false; imageName=$customImageName; imageDescription=$customImageDescription}

# Create the custom image.
New-AzResourceGroupDeployment -ResourceGroupName $lab.ResourceGroupName -Name CreateCustomImage -TemplateUri 'https://raw.githubusercontent.com/Azure/azure-devtestlab/master/samples/DevTestLabs/QuickStartTemplates/201-dtl-create-customimage-from-vhd/azuredeploy.json' -TemplateParameterObject $parameters

Next steps

• Compare custom images and formulas in DevTest Labs
• Copying Custom Images between Azure DevTest Labs