You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/virtual-desktop/create-custom-image-templates.md
+12-15Lines changed: 12 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,13 @@
1
1
---
2
-
title: Use Custom image templates to create custom images (preview) - Azure Virtual Desktop
3
-
description: Learn how to use Custom image templates to create custom images when deploying session hosts in Azure Virtual Desktop.
2
+
title: Use custom image templates to create custom images - Azure Virtual Desktop
3
+
description: Learn how to use custom image templates to create custom images when deploying session hosts in Azure Virtual Desktop.
4
4
ms.topic: how-to
5
5
author: dknappettmsft
6
6
ms.author: daknappe
7
-
ms.date: 04/05/2023
7
+
ms.date: 09/08/2023
8
8
---
9
9
10
-
# Use Custom image templates to create custom images in Azure Virtual Desktop (preview)
11
-
12
-
> [!IMPORTANT]
13
-
> Custom image templates in Azure Virtual Desktop is currently in PREVIEW.
14
-
> See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
10
+
# Use custom image templates to create custom images in Azure Virtual Desktop
15
11
16
12
Custom image templates in Azure Virtual Desktop enable you to easily create a custom image that you can use when deploying session host virtual machines (VMs). Using custom images helps you to standardize the configuration of your session host VMs for your organization. Custom image templates are built on [Azure Image Builder](../virtual-machines/image-builder-overview.md) and tailored for Azure Virtual Desktop.
17
13
@@ -32,7 +28,7 @@ Before you can create a custom image template, you need to meet the following pr
32
28
33
29
- A resource group to store custom image templates, and images. If you specify your own resource group for Azure Image Builder to use, then it needs to be empty before the image build starts.
34
30
35
-
- A [user-assigned Managed Identity](../active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities.md). We recommend you create one specifically to use with custom image templates.
31
+
- A [user-assigned managed identity](../active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities.md). We recommend you create one specifically to use with custom image templates.
36
32
37
33
-[Create a custom role](../role-based-access-control/custom-roles.md) in Azure role-based access control (RBAC) with the following permissions as *actions*:
38
34
@@ -46,7 +42,7 @@ Before you can create a custom image template, you need to meet the following pr
46
42
"Microsoft.Compute/images/delete"
47
43
```
48
44
49
-
-[Assign the custom role to the Managed Identity](../role-based-access-control/role-assignments-portal-managed-identity.md#user-assigned-managed-identity). This should be scoped appropriately for your deployment, ideally to the resource group you use store custom image templates.
45
+
-[Assign the custom role to the managed identity](../role-based-access-control/role-assignments-portal-managed-identity.md#user-assigned-managed-identity). This should be scoped appropriately for your deployment, ideally to the resource group you use store custom image templates.
50
46
51
47
-*Optional*: If you want to distribute your image to Azure Compute Gallery, [create an Azure Compute Gallery](../virtual-machines/create-gallery.md), then [create a VM image definition](../virtual-machines/image-version.md). When you create a VM image definition in the gallery you need to specify the *generation* of the image you intend to create, either *generation 1* or *generation 2*. The generation of the image you want to use as the source image needs to match the generation specified in the VM image definition. Don't create a *VM image version* at this stage. This will be done by Azure Virtual Desktop.
52
48
@@ -77,7 +73,7 @@ To create a custom image using the Azure portal:
77
73
| Subscription | Select the subscription you want to use from the list. |
78
74
| Resource group | Select an existing resource group. |
79
75
| Location | Select a region from the list where the custom image template will be created. |
80
-
| Managed Identity| Select the Managed Identity to use for creating the custom image template. |
76
+
| Managed identity| Select the managed identity to use for creating the custom image template. |
81
77
82
78
Once you've completed this tab, select **Next**.
83
79
@@ -111,7 +107,7 @@ To create a custom image using the Azure portal:
111
107
112
108
| Parameter | Value/Description |
113
109
|--|--|
114
-
| Resource group | Select an existing resource group from the list for the managed image.<br /><br />If you choose a different resource group to the one you selected on the **Basics** tab, you'll also need to add the same role assignment for the Managed Identity. |
110
+
| Resource group | Select an existing resource group from the list for the managed image.<br /><br />If you choose a different resource group to the one you selected on the **Basics** tab, you'll also need to add the same role assignment for the managed identity. |
115
111
| Image name | Select an existing managed image from the list or select **Create a managed image**. |
116
112
| Location | Select the Azure region from the list for the managed image. |
117
113
| Run output name | Enter a run output name for the image. This is a free text field. |
@@ -136,9 +132,10 @@ To create a custom image using the Azure portal:
136
132
|--|--|
137
133
| Build timeout (minutes) | Enter the [maximum duration to wait](../virtual-machines/linux/image-builder-json.md#properties-buildtimeoutinminutes) while building the image template (includes all customizations, validations, and distributions). |
138
134
| Build VM size | Select a size for the temporary VM created and used to build the template. You need to select a [VM size that matches the generation](../virtual-machines/generation-2.md) of your source image. |
139
-
| OS disk size GB) | Select the resource group you assigned the Managed Identity to.<br /><br />Alternatively, if you assigned the Managed Identity to the subscription, you can create a new resource group here. |
135
+
| OS disk size (GB) | Select the resource group you assigned the managed identity to.<br /><br />Alternatively, if you assigned the managed identity to the subscription, you can create a new resource group here. |
140
136
| Staging group | Enter a name for a new resource group you want Azure Image Builder to use to create the Azure resources it needs to create the image. If you leave this blank Azure Image Builder creates its own default resource group. |
141
-
| Virtual network | Select an existing virtual network for the VM used to build the template. This is optional. If you don't select an existing virtual network, a temporary one is created, along with a public IP address for the temporary VM. |
137
+
| Build VM managed identity | Select a user-assigned managed identity if you want the build VM to authenticate with other Azure services. For more information, see [User-assigned identity for the Image Builder Build VM](../virtual-machines/linux/image-builder-json.md#user-assigned-identity-for-the-image-builder-build-vm). |
138
+
| Virtual network | Select an existing virtual network for the VM used to build the template. If you don't select an existing virtual network, a temporary one is created, along with a public IP address for the temporary VM. |
142
139
| Subnet | If you selected an existing virtual network, select a subnet from the list. |
143
140
144
141
Once you've completed this tab, select **Next**.
@@ -149,7 +146,7 @@ To create a custom image using the Azure portal:
149
146
150
147
1. Select **+Add built-in script**.
151
148
152
-
1. Select the scripts you want to use from the list, and complete any required information.
149
+
1. Select the scripts you want to use from the list, and complete any required information. Built-in scripts include restarts where needed.
description: Learn about Custom image templates in Azure Virtual Desktop, where you can create custom images that you can use when deploying session host virtual machines.
description: Learn about custom image templates in Azure Virtual Desktop, where you can create custom images that you can use when deploying session host virtual machines.
4
4
ms.topic: conceptual
5
5
author: dknappettmsft
6
6
ms.author: daknappe
7
-
ms.date: 04/05/2023
7
+
ms.date: 09/08/2023
8
8
---
9
9
10
-
# Custom image templates in Azure Virtual Desktop (preview)
11
-
12
-
> [!IMPORTANT]
13
-
> Custom image templates in Azure Virtual Desktop is currently in PREVIEW.
14
-
> See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
10
+
# Custom image templates in Azure Virtual Desktop
15
11
16
12
Custom image templates in Azure Virtual Desktop enable you to easily create a custom image that you can use when deploying session host virtual machines (VMs). Using custom images helps you to standardize the configuration of your session host VMs for your organization. Custom image templates are built on [Azure Image Builder](../virtual-machines/image-builder-overview.md) and tailored for Azure Virtual Desktop.
17
13
@@ -34,7 +30,9 @@ The source image must be [supported for Azure Virtual Desktop](prerequisites.md#
34
30
- An existing managed image.
35
31
- An existing custom image template.
36
32
37
-
We've added several built-in scripts available for you to use that configures some of the most popular features and settings when using Azure Virtual Desktop. You can also add your own custom scripts to the template, as long as they're hosted at a publicly available location, such as GitHub or a web service. You need to specify a duration for the build, so make sure you allow enough time for your scripts to complete. Here are some examples of the built-in scripts you can add to a custom image template:
33
+
We've added several built-in scripts available for you to use that configures some of the most popular features and settings when using Azure Virtual Desktop. You can also add your own custom scripts to the template, as long as they're hosted at a publicly available location, such as GitHub or a web service. You need to specify a duration for the build, so make sure you allow enough time for your scripts to complete. Built-in scripts include restarts where needed.
34
+
35
+
Here are some examples of the built-in scripts you can add to a custom image template:
38
36
39
37
- Install language packs.
40
38
- Set the default language of the operating system.
@@ -44,12 +42,12 @@ We've added several built-in scripts available for you to use that configures so
44
42
- Enable FSLogix with Kerberos.
45
43
- Enable [RDP Shortpath for managed networks](rdp-shortpath.md?tabs=managed-networks).
When the custom image is being created and distributed, Azure Image Builder uses a user-assigned Managed Identity. Azure Image Builder uses this Managed Identity to create several resources in your subscription, such as a resource group, a VM used to build the image, Key Vault, and a storage account. The VM needs internet access to download the built-in scripts or your own scripts that you added. The built-in scripts are stored in the *RDS-templates* GitHub repository at [https://github.com/Azure/RDS-Templates](https://github.com/Azure/RDS-Templates).
50
+
When the custom image is being created and distributed, Azure Image Builder uses a user-assigned managed identity. Azure Image Builder uses this managed identity to create several resources in your subscription, such as a resource group, a VM used to build the image, Key Vault, and a storage account. The VM needs internet access to download the built-in scripts or your own scripts that you added. The built-in scripts are stored in the *RDS-templates* GitHub repository at [https://github.com/Azure/RDS-Templates](https://github.com/Azure/RDS-Templates).
53
51
54
52
You can choose whether you want the VM to connect to an existing virtual network and subnet, which will enable the VM to have access to other resources you may have available to that virtual network. If you don't specify an existing virtual network, a temporary virtual network, subnet, and public IP address are created for use by the VM. For more information on networking options, see [Azure VM Image Builder networking options](../virtual-machines/linux/image-builder-networking.md).
description: Troubleshoot custom image templates in Azure Virtual Desktop.
4
4
ms.topic: troubleshooting
5
5
author: dknappettmsft
6
6
ms.author: daknappe
7
-
ms.date: 04/05/2023
7
+
ms.date: 09/08/2023
8
8
---
9
9
10
-
# Troubleshoot Custom image templates in Azure Virtual Desktop (preview)
11
-
12
-
> [!IMPORTANT]
13
-
> Custom image templates in Azure Virtual Desktop is currently in PREVIEW.
14
-
> See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
10
+
# Troubleshoot custom image templates in Azure Virtual Desktop
15
11
16
12
Custom image templates in Azure Virtual Desktop enable you to easily create a custom image that you can use when deploying session host virtual machines (VMs). This article helps troubleshoot some issues you could run into.
17
13
@@ -43,3 +39,23 @@ The generation for the source image is shown when you select the image you want
43
39
## PrivateLinkService Network Policy is not disabled for the given subnet
44
40
45
41
If you receive the error message starting **PrivateLinkService Network Policy is not disabled for the given subnet**, you need to disable the *private service policy* on the subnet. For more information, see [Disable private service policy on the subnet](../virtual-machines/windows/image-builder-vnet.md#disable-private-service-policy-on-the-subnet).
42
+
43
+
## Removing the Microsoft Store app
44
+
45
+
Removing or uninstalling the Microsoft Store app is not supported. Learn how to [Configure access to the Microsoft Store](/windows/configuration/stop-employees-from-using-microsoft-store).
46
+
47
+
## Issues installing or enabling additional languages on Windows 10 images
48
+
49
+
Additional languages can be added by custom image templates, which uses the [Install-Language PowerShell cmdlet](/powershell/module/languagepackmanagement/install-language). If you have issues installing or enabling additional languages on Windows 10 Enterprise and Windows 10 Enterprise multi-session images, ensure that:
50
+
51
+
- You haven't disabled installing language packs by group policy on your image. The policy setting can be found at the following locations:
52
+
53
+
-**Computer Configuration** > **Administrative Templates** > **Control Panel** > **Regional and Language Options** > **Restrict Language Pack and Language Feature Installation**
54
+
55
+
-**User Configuration** > **Administrative Templates** > **Control Panel** > **Regional and Language Options** > **Restrict Language Pack and Language Feature Installation**
56
+
57
+
- Your session hosts can connect to Windows Update to download languages and latest cumulative updates.
58
+
59
+
## Is Trusted Launch or are Confidential VMs supported?
60
+
61
+
As custom image templates is based on Azure Image Builder, support for Trusted Launch or Confidential VMs is inherited. For more information, see [Confidential VM and Trusted Launch support](../virtual-machines/image-builder-overview.md#confidential-vm-and-trusted-launch-support).
0 commit comments