Skip to content

Commit 845a326

Browse files
authored
Merge pull request #185627 from sefriend/pd-assign
unassignment/reassignment doc
2 parents 60e7762 + d60ff40 commit 845a326

File tree

5 files changed

+78
-9
lines changed

5 files changed

+78
-9
lines changed

articles/virtual-desktop/configure-host-pool-personal-desktop-assignment-type.md

Lines changed: 78 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Azure Virtual Desktop personal desktop assignment type - Azure
3-
description: How to configure automatic or direct assignment for a Azure Virtual Desktop personal desktop host pool.
3+
description: How to configure automatic or direct assignment for an Azure Virtual Desktop personal desktop host pool.
44
author: Heidilohr
55
ms.topic: how-to
66
ms.date: 07/09/2020
@@ -22,11 +22,17 @@ You can configure the assignment type of your personal desktop host pool to adju
2222

2323
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).
2424

25+
## Personal host pools overview
26+
27+
A personal host pool is a type of host pool that has personal desktops. Personal desktops have one-to-one mapping, which means a single user can only be assigned to a single personal desktop. Every time the user signs in, their user session is directed to their assigned personal desktop session host. This host pool type is ideal for customers with resource-intensive workloads because user experience and session performance will improve if there's only one session on the session host. Another benefit of this host pool type is that user activities, files, and settings persist on the virtual machine operating system (VM OS) disk after the user signs out.
28+
29+
Users must be assigned to a personal desktop to start their session. There are two types of assignments in a personal host pool: automatic assignment and direct assignment.
30+
2531
## Configure automatic assignment
2632

2733
Automatic assignment is the default assignment type for new personal desktop host pools created in your Azure Virtual Desktop environment. Automatically assigning users doesn't require a specific session host.
2834

29-
To automatically assign users, first assign them to the personal desktop host pool so that they can see the desktop in their feed. When an assigned user launches the desktop in their feed, they will claim an available session host if they have not already connected to the host pool, which completes the assignment process.
35+
To automatically assign users, first assign them to the personal desktop host pool so that they can see the desktop in their feed. When an assigned user launches the desktop in their feed, their user session will be load-balanced to an available session host if they haven't already connected to the host pool.
3036

3137
To configure a host pool to automatically assign users to VMs, run the following PowerShell cmdlet:
3238

@@ -42,7 +48,7 @@ New-AzRoleAssignment -SignInName <userupn> -RoleDefinitionName "Desktop Virtuali
4248

4349
## Configure direct assignment
4450

45-
Unlike automatic assignment, when you use direct assignment, you must assign the user to both the personal desktop host pool and a specific session host before they can connect to their personal desktop. If the user is only assigned to a host pool without a session host assignment, they won't be able to access resources.
51+
Unlike automatic assignment, when you use direct assignment, you must assign the user to both the personal desktop host pool and a specific session host before they can connect to their personal desktop. If the user is only assigned to a host pool without a session host assignment, they won't be able to access resources and will see an error message that says, "No resources available."
4652

4753
To configure a host pool to require direct assignment of users to session hosts, run the following PowerShell cmdlet:
4854

@@ -68,21 +74,84 @@ To directly assign a user to a session host in the Azure portal:
6874
2. Enter **Azure Virtual Desktop** into the search bar.
6975
3. Under **Services**, select **Azure Virtual Desktop**.
7076
4. At the Azure Virtual Desktop page, go the menu on the left side of the window and select **Host pools**.
71-
5. Select the name of the host pool you want to update.
77+
5. Select the host pool you want to assign users to.
7278
6. Next, go to the menu on the left side of the window and select **Application groups**.
73-
7. Select the name of the desktop app group you want to edit, then select **Assignments** in the menu on the left side of the window.
74-
8. Select **+ Add**, then select the users or user groups you want to publish this desktop app group to.
79+
7. Select the name of the app group you want to assign users to, then select **Assignments** in the menu on the left side of the window.
80+
8. Select **+ Add**, then select the users or user groups you want to assign to this app group.
7581
9. Select **Assign VM** in the Information bar to assign a session host to a user.
76-
10. Select the session host you want to assign to the user, then select **Assign**.
82+
10. Select the session host you want to assign to the user, then select **Assign**. You can also select **Assignment** > **Assign user**.
7783
11. Select the user you want to assign the session host to from the list of available users.
7884
12. When you're done, select **Select**.
7985

86+
87+
## How to unassign a personal desktop
88+
89+
To unassign a personal desktop, run the following PowerShell cmdlet:
90+
91+
```powershell
92+
Update-AzWvdSessionHost -HostPoolName <hostpoolname> -Name <sessionhostname> -ResourceGroupName <resourcegroupname> -AssignedUser "" -Force
93+
```
94+
95+
>[!IMPORTANT]
96+
> - You must include the _-Force_ parameter when running the PowerShell cmdlet to unassign a personal desktop. If you don't include the _-Force_ parameter, you'll receive an error message.
97+
> - There must be no existing user sessions on the session host when you unassign the user from the personal desktop. If there's an existing user session on the session host while you're unassigning it, you won't be able to unassign the personal desktop successfully.
98+
> - If the session host has no user assignment, nothing will happen when you run this cmdlet.
99+
100+
To unassign a personal desktop in the Azure portal:
101+
1. Sign in to the Azure portal at <https://portal.azure.com>.
102+
2. Enter **Azure Virtual Desktop** into the search bar.
103+
3. Under **Services**, select **Azure Virtual Desktop**.
104+
4. At the Azure Virtual Desktop page, go the menu on the left side of the window and select **Host pools**.
105+
5. Select the host pool you want to modify user assignment for.
106+
6. Next, go to the menu on the left side of the window and select **Session hosts**.
107+
7. Select the checkbox next to the session host you want to unassign a user from, select the ellipses at the end of the row, and then select **Unassign user**. You can also select **Assignment** > **Unassign user**.
108+
109+
> [!div class="mx-imgBorder"]
110+
> ![A screenshot of the unassign user menu option from the ellipses menu for unassigning a personal desktop.](media/unassign.png)
111+
112+
> [!div class="mx-imgBorder"]
113+
> ![A screenshot of the unassign user menu option from the assignment menu for unassigning a personal desktop.](media/unassign-2.png)
114+
115+
8. Select **Unassign** when prompted with the warning.
116+
117+
## How to reassign a personal desktop
118+
119+
To reassign a personal desktop, run the following PowerShell cmdlet:
120+
121+
```powershell
122+
Update-AzWvdSessionHost -HostPoolName <hostpoolname> -Name <sessionhostname> -ResourceGroupName <resourcegroupname> -AssignedUser <userupn> -Force
123+
```
124+
125+
>[!IMPORTANT]
126+
> - You must include the _-Force_ parameter when running the PowerShell cmdlet to reassign a personal desktop. If you don't include the _-Force_ parameter, you'll receive an error message.
127+
> - There must be no existing user sessions on the session host when you reassign a personal desktop. If there's an existing user session on the session host while you're reassigning it, you won't be able to reassign the personal desktop successfully.
128+
> - If the user principal name (UPN) you enter for the _-AssignedUser_ parameter is the same as the UPN currently assigned to the personal desktop, the cmdlet won't do anything.
129+
> - If the session host currently has no user assignment, the personal desktop will be assigned to the provided UPN.
130+
131+
To reassign a personal desktop in the Azure portal:
132+
1. Sign in to the Azure portal at <https://portal.azure.com>.
133+
2. Enter **Azure Virtual Desktop** into the search bar.
134+
3. Under **Services**, select **Azure Virtual Desktop**.
135+
4. At the Azure Virtual Desktop page, go the menu on the left side of the window and select **Host pools**.
136+
5. Select the host pool you want to modify user assignment for.
137+
6. Next, go to the menu on the left side of the window and select **Session hosts**.
138+
7. Select the checkbox next to the session host you want to reassign to a different user, select the ellipses at the end of the row, and then select **Assign to a different user**. You can also select **Assignment** > **Assign to a different user**.
139+
140+
> [!div class="mx-imgBorder"]
141+
> ![A screenshot of the assign to a different user menu option from the ellipses menu for reassigning a personal desktop.](media/reassign-doc.png)
142+
143+
> [!div class="mx-imgBorder"]
144+
> ![A screenshot of the assign to a different user menu option from the assignment menu for reassigning a personal desktop.](media/reassign.png)
145+
146+
8. Select the user you want to assign the session host to from the list of available users.
147+
9. When you're done, select **Select**.
148+
80149
## Next steps
81150

82-
Now that you've configured the personal desktop assignment type, you can sign in to a Azure Virtual Desktop client to test it as part of a user session. These next two How-tos will tell you how to connect to a session using the client of your choice:
151+
Now that you've configured the personal desktop assignment type, you can sign in to an Azure Virtual Desktop client to test it as part of a user session. These articles will show you how to connect to a session using the client of your choice:
83152

84153
- [Connect with the Windows Desktop client](./user-documentation/connect-windows-7-10.md)
85154
- [Connect with the web client](./user-documentation/connect-web.md)
86155
- [Connect with the Android client](./user-documentation/connect-android.md)
87156
- [Connect with the iOS client](./user-documentation/connect-ios.md)
88-
- [Connect with the macOS client](./user-documentation/connect-macos.md)
157+
- [Connect with the macOS client](./user-documentation/connect-macos.md)
60.4 KB
Loading
89.7 KB
Loading
89.5 KB
Loading
182 KB
Loading

0 commit comments

Comments
 (0)