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
title: Customize feed for Azure Virtual Desktop users - Azure
3
-
description: How to customize feed for Azure Virtual Desktop users with PowerShell cmdlets.
3
+
description: How to customize feed for Azure Virtual Desktop users using the Azure portal and PowerShell cmdlets.
4
4
author: Heidilohr
5
5
ms.topic: how-to
6
6
ms.date: 02/01/2024
@@ -16,115 +16,105 @@ You can customize the feed so the RemoteApp and remote desktop resources appear
16
16
17
17
## Prerequisites
18
18
19
-
This article assumes you've already downloaded and installed the Azure Virtual Desktop PowerShell module. If you haven't, follow the instructions in [Set up the PowerShell module](powershell-module.md).
19
+
If you're using either the Azure portal or PowerShell method, you'll need the following things:
20
20
21
-
## Customize the display name for a session host
21
+
- An Azure account assigned the [Desktop Virtualization Application Group Contributor](rbac.md#desktop-virtualization-application-group-contributor) role.
22
+
- If you want to use Azure PowerShell locally, see [Use Azure CLI and Azure PowerShell with Azure Virtual Desktop](cli-powershell.md) to make sure you have the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module installed. Alternatively, use the [Azure Cloud Shell](../cloud-shell/overview.md).
22
23
23
-
You can change the display name for a remote desktop for your users by setting its session host friendly name. By default, the session host friendly name is empty, so users only see the app name. You can set the session host friendly name using REST API.
24
24
25
-
>[!NOTE]
26
-
>The following instructions only apply to personal desktops, not pooled desktops. Also, personal host pools only allow and support desktop application groups.
25
+
## Customize the display name for a RemoteApp or desktop
You can change the display name for a published RemoteApp or desktop to make it easier for users to identify what to connect to.
29
28
29
+
#### [Azure portal](#tab/portal)
30
30
31
-
## Customize the display name for a RemoteApp
31
+
Here's how to customize the display name for a published RemoteApp or desktop using the Azure portal.
32
32
33
-
You can change the display name for a published RemoteApp by setting the friendly name. By default, the friendly name is the same as the name of the RemoteApp program.
33
+
1. Sign in to the [Azure portal](https://portal.azure.com).
34
34
35
-
To retrieve a list of published applications for an application group, run the following PowerShell cmdlet:
3. Under Services, select **Azure Virtual Desktop**.
40
38
41
-
To assign a friendly name to a RemoteApp, run the following cmdlet with the required parameters:
39
+
4. On the Azure Virtual Desktop page, select **Application groups** on the left side of the screen, then select the name of the application group you want to edit.
To confirm you've successfully updated the friendly name, run this cmdlet:
52
+
Here's how to customize the display name for a RemoteApp using PowerShell. By default, the display name is the same as the name of the application identifier.
2. To retrieve a list of published applications for an application group, run the following PowerShell cmdlet:
83
57
84
-
```powershell
85
-
FriendlyName : WordUpdate
86
-
```
58
+
```azurepowershell
59
+
$parameters = @{
60
+
ResourceGroupName = "<resourcegroupname>"
61
+
ApplicationGroupName = "<appgroupname>"
62
+
}
87
63
88
-
## Customize the display name for a Remote Desktop
64
+
Get-AzWvdApplication @parameters
65
+
```
89
66
90
-
You can change the display name for a published remote desktop by setting a friendly name. If you manually created a host pool and desktop application group through PowerShell, the default friendly name is "Session Desktop." If you created a host pool and desktop application group through the GitHub Azure Resource Manager template or the Azure Marketplace offering, the default friendly name is the same as the host pool name.
67
+
3. To assign a friendly name to a RemoteApp, run the following cmdlet with the required parameters:
91
68
92
-
To retrieve the remote desktop resource, run the following PowerShell cmdlet:
### Customize the display name for a Remote Desktop
103
82
104
-
## Customize a display name in the Azure portal
83
+
You can change the display name for a published remote desktop for all users by setting a friendly name. If you manually created a host pool and desktop application group through PowerShell, the default friendly name is **Session Desktop**. If you created a host pool and desktop application group through the GitHub Azure Resource Manager template or the Azure Marketplace offering, the default friendly name is the same as the host pool name. If you have a personal host pool, you can also [set a friendly name for individual session hosts](#set-a-friendly-name-for-an-individual-session-host-in-a-personal-host-pool).
105
84
106
-
You can change the display name for a published remote desktop by setting a friendly name using the Azure portal.
1. Sign in to the [Azure portal](https://portal.azure.com).
87
+
2. To assign a friendly name to the remote desktop resource, run the following PowerShell cmdlet:
109
88
110
-
2. Search for **Azure Virtual Desktop**.
89
+
```azurepowershell
90
+
$parameters = @{
91
+
ResourceGroupName = "<resourcegroupname>"
92
+
ApplicationGroupName = "<appgroupname>"
93
+
Name = "<applicationname>"
94
+
FriendlyName = "<newfriendlyname>"
95
+
}
111
96
112
-
3. Under Services, select **Azure Virtual Desktop**.
97
+
Update-AzWvdDesktop @parameters
98
+
```
113
99
114
-
4. On the Azure Virtual Desktop page, select **Application groups** on the left side of the screen, then select the name of the application group you want to edit. (For example, if you want to edit the display name of the desktop application group, select the application group named **Desktop**.)
100
+
3. To retrieve the friendly name for the remote desktop resource, run the following PowerShell cmdlet:
115
101
116
-
5. Select **Applications** in the menu on the left side of the screen.
6. Select the application you want to update, then enter a new **Display name**.
112
+
---
113
+
114
+
## Set a friendly name for an individual session host in a personal host pool
119
115
120
-
7. Select **Save**. The application you edited should now display the updated name.
116
+
For session hosts in a personal host pool, you can change the display name for a desktop for each individual session host by setting its friendly name using PowerShell. By default, the session host friendly name is empty, so all users only see the same desktop display name. There isn't currently a way to set the session host friendly name in the Azure portal.
Now that you've customized the feed for users, you can sign in to an Azure Virtual Desktop client to test it out. To do so, continue to the Connect to Azure Virtual Desktop How-tos:
125
120
126
-
*[Connect with Windows](./users/connect-windows.md)
127
-
*[Connect with the web client](./users/connect-web.md)
128
-
*[Connect with the Android client](./users/connect-android-chrome-os.md)
129
-
*[Connect with the iOS client](./users/connect-ios-ipados.md)
130
-
*[Connect with the macOS client](./users/connect-macos.md)
Copy file name to clipboardExpand all lines: articles/virtual-desktop/includes/include-session-hosts-friendly-name.md
+22-21Lines changed: 22 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,33 +5,34 @@ ms.topic: include
5
5
ms.date: 01/30/2024
6
6
---
7
7
8
-
Run the following command in PowerShell to add or change a session host's friendly name:
9
8
10
-
```powershell
11
-
$parameters = @{
12
-
HostPoolName = 'HostPoolName'
13
-
Name = 'SessionHostName'
14
-
ResourceGroupName = 'ResourceGroupName'
15
-
FriendlyName = 'SessionHostFriendlyName'
16
-
}
9
+
1. Launch the [Azure Cloud Shell](/azure/cloud-shell/overview) in the Azure portal with the *PowerShell* terminal type, or run PowerShell on your local device.
17
10
18
-
Update-AzWvdSessionHost @parameters
19
-
```
11
+
* If you're using Cloud Shell, make sure your [Azure context is set to the subscription you want to use](/powershell/azure/context-persistence).
20
12
13
+
* If you're using PowerShell locally, first [Sign in with Azure PowerShell](/powershell/azure/authenticate-azureps), then make sure your [Azure context is set to the subscription you want to use](/powershell/azure/context-persistence).
21
14
15
+
2. Run the following command in PowerShell to add or change a session host's friendly name:
22
16
23
-
### Get the session host friendly name
17
+
```azurepowershell
18
+
$parameters = @{
19
+
HostPoolName = 'HostPoolName'
20
+
Name = 'SessionHostName'
21
+
ResourceGroupName = 'ResourceGroupName'
22
+
FriendlyName = 'SessionHostFriendlyName'
23
+
}
24
24
25
-
To get the session host friendly name, run the following command in PowerShell:
25
+
Update-AzWvdSessionHost @parameters
26
+
```
26
27
27
-
```powershell
28
-
$sessionHostParams = @{
29
-
HostPoolName = 'HostPoolName'
30
-
Name = 'SessionHostName'
31
-
ResourceGroupName = 'ResourceGroupName'
32
-
}
28
+
3. To get the session host friendly name, run the following command in PowerShell:
0 commit comments