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
# Set custom Remote Desktop Protocol properties on a host pool in Azure Virtual Desktop
11
+
# Set custom Remote Desktop Protocol (RDP) properties on a host pool in Azure Virtual Desktop
12
12
13
-
When users sign in to Windows App or the Remote Desktop app, desktops and applications that they have access to are shown. For each desktop and application, there is a corresponding `.rdp` file that contains all the connection properties to use when connecting to a remote session. These properties are set per host pool and are known as RDP properties.
13
+
When users sign in to Windows App or the Remote Desktop app, desktops and applications that they have access to are shown. For each desktop and application, there is a corresponding `.rdp` file that contains all the connection properties to use when connecting to a remote session over the Remote Desktop Protocol (RDP). These RDP properties are set per host pool.
14
14
15
15
Each host pool has a set of default RDP properties and values. You can add other properties to the default set or override the default values by setting custom RDP properties. This article shows you how to set custom RDP properties on a host pool by using the Azure portal, Azure PowerShell, and Azure CLI.
16
16
@@ -21,17 +21,17 @@ Host pools have the following RDP properties and values by default:
21
21
| RDP Property | Details |
22
22
|--|--|
23
23
|`audiomode:i:0`| Determines whether the local or remote machine plays audio. |
24
-
|`redirectclipboard:i:1`| Determines whether clipboard redirection is enabled. |
25
-
|`redirectcomports:i:1`| Determines whether COM (serial) ports on the local computer will be redirected and available in the remote session. |
24
+
|`devicestoredirect:s:*`| Determines which peripherals that use the Media Transfer Protocol (MTP) or Picture Transfer Protocol (PTP), such as a digital camera, are redirected from a local Windows device to a remote session. |
25
+
|`drivestoredirect:s:*`| Determines which fixed, removable, and network drives on the local device will be redirected and available in a remote session. |
26
26
|`enablecredsspsupport:i:1`| Determines whether the client will use the Credential Security Support Provider (CredSSP) for authentication if it's available. |
27
-
|`drivestoredirect:s:*`| Determines which disk drives on the local computer will be redirected and available in the remote session. |
28
-
|`redirectprinters:i:1`| Determines whether printers configured on the local computer will be redirected and available in the remote session. |
29
-
|`devicestoredirect:s:*`| Determines which devices on the local computer will be redirected and available in the remote session. |
30
-
|`use multimon:i:1`| Determines whether the remote session will use one or multiple displays from the local computer. Only applicable for desktop application groups. It's ignored for RemoteApp application groups. |
31
-
|`redirectsmartcards:i:1`| Determines whether smart card devices on the local computer will be redirected and available in the remote session. |
32
-
|`usbdevicestoredirect:s:*`| Determines which supported RemoteFX USB devices on the client computer will be redirected and available in the remote session when you connect to a remote session that supports RemoteFX USB redirection. |
33
-
|`videoplaybackmode:i:1`| Determines if the connection will use RDP-efficient multimedia streaming for video playback. |
34
-
|`redirectwebauthn:i:1`| Determines whether WebAuthn requests on the remote computer will be redirected to the local computer allowing the use of local authenticators (such as Windows Hello for Business and security key). |
27
+
|`redirectclipboard:i:1`| Determines whether to redirect the clipboard. |
28
+
|`redirectcomports:i:1`| Determines whether serial or COM ports on the local device are redirected to a remote session. |
29
+
|`redirectprinters:i:1`| Determines whether printers available on the local device are redirected to a remote session. |
30
+
|`redirectsmartcards:i:1`| Determines whether smart card devices on the local device will be redirected and available in a remote session. |
31
+
|`redirectwebauthn:i:1`| Determines whether WebAuthn requests from a remote session are redirected to the local device allowing the use of local authenticators (such as Windows Hello for Business and security keys). |
32
+
|`usbdevicestoredirect:s:*`| Determines which supported USB devices on the client computer are redirected using opaque low-level redirection to a remote session. |
33
+
|`use multimon:i:1`| Determines whether the remote session will use one or multiple displays from the local device. |
34
+
|`videoplaybackmode:i:1`| Determines whether the connection will use RDP-efficient multimedia streaming for video playback. |
35
35
36
36
For a full list of supported properties and values, see [Supported RDP properties with Azure Virtual Desktop](rdp-properties.md)
37
37
@@ -48,7 +48,7 @@ Before you can set custom RDP properties on a host pool, you need:
48
48
49
49
- If you want to use Azure CLI or Azure PowerShell locally, see [Use Azure CLI and Azure PowerShell with Azure Virtual Desktop](cli-powershell.md) to make sure you have the [desktopvirtualization](/cli/azure/desktopvirtualization) Azure CLI extension or the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module installed. Alternatively, use the [Azure Cloud Shell](../cloud-shell/overview.md).
50
50
51
-
## Configure RDP properties
51
+
## Configure custom RDP properties
52
52
53
53
Select the relevant tab for your scenario.
54
54
@@ -199,6 +199,8 @@ To configure RDP properties using Azure CLI, use the following examples. Be sure
199
199
200
200
4. Users need to refresh their resources to receive the changes.
201
201
202
+
---
203
+
202
204
## Related content
203
205
204
206
- [Supported RDP properties with Azure Virtual Desktop](rdp-properties.md)
0 commit comments