Skip to content

Commit 871c801

Browse files
authored
Merge pull request #112745 from Heidilohr/work-new-powershell
Created and updated app group management articles
2 parents c889f71 + 4fb303c commit 871c801

10 files changed

+202
-39
lines changed

articles/virtual-desktop/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@
3838
href: configure-vm-gpu.md
3939
- name: Expand an existing host pool
4040
href: expand-existing-host-pool.md
41+
- name: Manage app groups with PowerShell
42+
href: manage-app-groups-powershell.md
4143
- name: Create a profile container
4244
items:
4345
- name: Use a VM-based file share
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: Manage app groups for Windows Virtual Desktop PowerShell - Azure
3+
description: How to manage Windows Virtual Desktop app groups with PowerShell.
4+
services: virtual-desktop
5+
author: Heidilohr
6+
7+
ms.service: virtual-desktop
8+
ms.topic: conceptual
9+
ms.date: 04/30/2020
10+
ms.author: helohr
11+
manager: lizross
12+
---
13+
# Manage app groups using PowerShell
14+
15+
>[!IMPORTANT]
16+
>This content applies to the Spring 2020 update with Azure Resource Manager Windows Virtual Desktop objects. If you're using the Windows Virtual Desktop Fall 2019 release without Azure Resource Manager objects, see [this article](./virtual-desktop-fall-2019/manage-app-groups-2019.md).
17+
>
18+
> The Windows Virtual Desktop Spring 2020 update is currently in public preview. This preview version is provided without a service level agreement, and we don't recommend using it for production workloads. Certain features might not be supported or might have constrained capabilities.
19+
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
20+
21+
The default app group created for a new Windows Virtual Desktop host pool also publishes the full desktop. In addition, you can create one or more RemoteApp application groups for the host pool. Follow this tutorial to create a RemoteApp app group and publish individual **Start** menu apps.
22+
23+
In this tutorial, learn how to:
24+
25+
> [!div class="checklist"]
26+
> * Create a RemoteApp group.
27+
> * Grant access to RemoteApp programs.
28+
29+
## Prerequisites
30+
31+
This article assumes you've followed the instructions in [Set up the PowerShell module](powershell-module.md) to set up your PowerShell module and sign in to your Azure account.
32+
33+
## Create a RemoteApp group
34+
35+
To create a RemoteApp group with PowerShell:
36+
37+
1. Run the following PowerShell cmdlet to create a new empty RemoteApp app group.
38+
39+
```powershell
40+
New-AzWvdApplicationGroup -Name <appgroupname> -ResourceGroupName <resourcegroupname> -ApplicationGroupType "RemoteApp" -HostPoolArmPath '/subscriptions/SubscriptionId/resourcegroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName'-Location <azureregion>
41+
```
42+
43+
2. (Optional) To verify that the app group was created, you can run the following cmdlet to see a list of all app groups for the host pool.
44+
45+
```powershell
46+
Get-AzWvdApplicationGroup -Name <appgroupname> -ResourceGroupName <resourcegroupname>
47+
```
48+
49+
3. Run the following cmdlet to get a list of **Start** menu apps on the host pool's virtual machine image. Write down the values for **FilePath**, **IconPath**, **IconIndex**, and other important information for the application that you want to publish.
50+
51+
```powershell
52+
Get-AzWvdStartMenuItem -ApplicationGroupName <appgroupname> -ResourceGroupName <resourcegroupname> | Format-List | more
53+
```
54+
55+
The output should show all the Start menu items in a format like this:
56+
57+
```powershell
58+
AppAlias : access
59+
CommandLineArgument :
60+
FilePath : C:\Program Files\Microsoft Office\root\Office16\MSACCESS.EXE
61+
FriendlyName :
62+
IconIndex : 0
63+
IconPath : C:\Program Files\Microsoft Office\Root\VFS\Windows\Installer\{90160000-000F-0000-1000-0000000FF1CE}\accicons.exe
64+
Id : /subscriptions/resourcegroups/providers/Microsoft.DesktopVirtualization/applicationgroups/startmenuitems/Access
65+
Name : 0301RAG/Access
66+
Type : Microsoft.DesktopVirtualization/applicationgroups/startmenuitems
67+
68+
AppAlias : charactermap
69+
CommandLineArgument :
70+
FilePath : C:\windows\system32\charmap.exe
71+
FriendlyName :
72+
IconIndex : 0
73+
IconPath : C:\windows\system32\charmap.exe
74+
Id : /subscriptions/resourcegroups/providers/Microsoft.DesktopVirtualization/applicationgroups/startmenuitems/Character Map
75+
Name : 0301RAG/Character Map
76+
Type : Microsoft.DesktopVirtualization/applicationgroups/startmenuitems
77+
```
78+
79+
4. Run the following cmdlet to install the application based on `AppAlias`. `AppAlias` becomes visible when you run the output from step 3.
80+
81+
```powershell
82+
New-AzWvdApplication -AppAlias <appalias> -GroupName <appgroupname> -Name <remoteappname> -ResourceGroupName <resourcegroupname> -CommandLineSetting <DoNotAllow|Allow|Require>
83+
```
84+
85+
5. (Optional) Run the following cmdlet to publish a new RemoteApp program to the application group created in step 1.
86+
87+
```powershell
88+
New-AzWvdApplication -GroupName <appgroupname> -Name <remoteappname> -ResourceGroupName <resourcegroupname> -Filepath <filepath> -IconPath <iconpath> -IconIndex <iconindex> -CommandLineSetting <DoNotAllow|Allow|Require>
89+
```
90+
91+
6. To verify that the app was published, run the following cmdlet.
92+
93+
```powershell
94+
Get-AzWvdApplication -GroupName <appgroupname> -ResourceGroupName <resourcegroupname>
95+
```
96+
97+
7. Repeat steps 1–5 for each application that you want to publish for this app group.
98+
8. Run the following cmdlet to grant users access to the RemoteApp programs in the app group.
99+
100+
```powershell
101+
New-AzRoleAssignment -SignInName <userupn> -RoleDefinitionName "Desktop Virtualization User" -ResourceName <appgroupname> -ResourceGroupName <resourcegroupname> -ResourceType 'Microsoft.DesktopVirtualization/applicationGroups'
102+
```
103+
104+
## Next steps
105+
106+
If you came to this How-to guide from our tutorials, check out [Create a host pool to validate service updates](create-validation-host-pool.md). You can use a validation host pool to monitor service updates before rolling them out to your production environment.

articles/virtual-desktop/manage-app-groups.md

Lines changed: 94 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,136 @@
11
---
2-
title: Manage app groups for Windows Virtual Desktop - Azure
3-
description: Describes how to set up Windows Virtual Desktop tenants in Azure Active Directory.
2+
title: Manage app groups for Windows Virtual Desktop portal - Azure
3+
description: How to manage Windows Virtual Desktop app groups with the Azure portal.
44
services: virtual-desktop
55
author: Heidilohr
66

77
ms.service: virtual-desktop
88
ms.topic: tutorial
9-
ms.date: 08/29/2019
9+
ms.date: 04/30/2020
1010
ms.author: helohr
1111
manager: lizross
1212
---
13-
# Tutorial: Manage app groups for Windows Virtual Desktop
13+
# Tutorial: Manage app groups with the Azure portal
1414

1515
>[!IMPORTANT]
1616
>This content applies to the Spring 2020 update with Azure Resource Manager Windows Virtual Desktop objects. If you're using the Windows Virtual Desktop Fall 2019 release without Azure Resource Manager objects, see [this article](./virtual-desktop-fall-2019/manage-app-groups-2019.md).
1717
>
1818
> The Windows Virtual Desktop Spring 2020 update is currently in public preview. This preview version is provided without a service level agreement, and we don't recommend using it for production workloads. Certain features might not be supported or might have constrained capabilities.
1919
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
2020
21-
The default app group created for a new Windows Virtual Desktop host pool also publishes the full desktop. In addition, you can create one or more RemoteApp application groups for the host pool. Follow this tutorial to create a RemoteApp app group and publish individual **Start** menu apps.
21+
The default app group created for a new Windows Virtual Desktop host pool also publishes the full desktop. In addition, you can create one or more RemoteApp application groups for the host pool. Follow this tutorial to create a RemoteApp app group and publish individual Start menu apps.
2222

2323
In this tutorial, learn how to:
2424

2525
> [!div class="checklist"]
2626
> * Create a RemoteApp group.
2727
> * Grant access to RemoteApp programs.
2828
29-
Before you begin, [download and import the Windows Virtual Desktop PowerShell module](/powershell/windows-virtual-desktop/overview/) to use in your PowerShell session if you haven't already. After that, run the following cmdlet to sign in to your account:
29+
## Create a RemoteApp group
3030

31-
```powershell
32-
Add-RdsAccount -DeploymentUrl "https://rdbroker.wvd.microsoft.com"
33-
```
31+
If you've already created a host pool and session host VMs using the Azure
32+
portal or PowerShell, you can add application groups from the Azure portal with
33+
the following process:
3434

35-
## Create a RemoteApp group
35+
1. Sign in to the [Azure portal](https://portal.azure.com/).
3636

37-
1. Run the following PowerShell cmdlet to create a new empty RemoteApp app group.
37+
2. Search for and select **Windows Virtual Desktop**.
3838

39-
```powershell
40-
New-RdsAppGroup <tenantname> <hostpoolname> <appgroupname> -ResourceType "RemoteApp"
41-
```
39+
3. Select **Application Groups** in the menu on the left side of the page, then select **+ Add**.
4240

43-
2. (Optional) To verify that the app group was created, you can run the following cmdlet to see a list of all app groups for the host pool.
41+
4. On the **Basics** tab, select the subscription group and resource group you want to create the app group for. You can also choose to create a new resource group instead of selecting an existing one.
4442

45-
```powershell
46-
Get-RdsAppGroup <tenantname> <hostpoolname>
47-
```
43+
5. Select the host pool that will be associated with the application group from the drop-down menu next to **Host pool**.
4844

49-
3. Run the following cmdlet to get a list of **Start** menu apps on the host pool's virtual machine image. Write down the values for **FilePath**, **IconPath**, **IconIndex**, and other important information for the application that you want to publish.
45+
>[!NOTE]
46+
>You must select the host pool associated with the application group. App groups have apps or desktops that are served from a session host and session hosts are part of host pools. The app group needs to be associated with a host pool during creation.
5047
51-
```powershell
52-
Get-RdsStartMenuApp <tenantname> <hostpoolname> <appgroupname>
53-
```
48+
> [!div class="mx-imgBorder"]
49+
> ![A screenshot of the Basics tab in the Azure portal.](media/basics-tab.png)
50+
51+
6. If you want to add application groups to your host pool, select **Host pools** in the menu on the left side of the screen.
52+
53+
Next, select the name of the host pool you want to add application groups to.
5454

55-
4. Run the following cmdlet to install the application based on `AppAlias`. `AppAlias` becomes visible when you run the output from step 3.
55+
After that, select **Application groups** from the menu on the left side of the screen, then select **+Add**.
56+
57+
Finally, select the subscription group and resource group you want to create the app group in. You can either select the name of an existing resource group from the drop-down menu or select **Create new** to make a new one.
58+
59+
>[!NOTE]
60+
>When you add application groups to your host pool, the host pool that's related to the application group is already selected because you navigated from it.
61+
>
62+
> [!div class="mx-imgBorder"]
63+
>![A screenshot of the Basics tab with the host pool preselected.](media/host-pool-selected.png)
64+
65+
7. Select **RemoteApp** under Application group type, then enter a name for your RemoteApp.
66+
67+
> [!div class="mx-imgBorder"]
68+
> ![A screenshot of the Application group type fields. "RemoteApp" is highlighted.](media/remoteapp-button.png)
69+
70+
8. Select the **Assignments** tab.
71+
72+
9. To publish individual users or user groups to the app group, select **+Add Azure AD users or user groups**.
73+
74+
10. Select the number of users you want to add the apps to. You can select single or multiple users and user groups.
75+
76+
> [!div class="mx-imgBorder"]
77+
> ![A screenshot of the user selection menu.](media/select-users.png)
78+
79+
11. Select **Select**.
80+
81+
12. Select the **Applications** tab, then select **+Add applications**.
82+
83+
13. To add an application from the start menu:
84+
85+
- Go to **Application source** and select **Start menu** from the drop-down menu. Next, go to **Application** and choose the application from the drop-down menu.
86+
87+
> [!div class="mx-imgBorder"]
88+
> ![A screenshot of the add application screen with the Start menu selected.](media/add-app-start.png)
89+
90+
- In **Display name**, enter the name for the application that will be shown to the user on their client.
91+
92+
- Leave the other options as-is and select **Save**.
93+
94+
14. To add an application from specific file path:
95+
96+
- Go to **Application source** and select **File path** from the drop-down menu.
97+
98+
- Enter the path to the application on the session host, registered with the associated host pool.
99+
100+
- Enter the application's details in the **Application name**, **Display name**, **Icon path**, and **Icon index** fields.
101+
102+
- Select **Save**.
103+
104+
> [!div class="mx-imgBorder"]
105+
> ![A screenshot of the add application page with file path selected.](media/add-app-file.png)
106+
107+
Repeat this process for every application you want to add to the application group.
108+
109+
15. Next, select the **Workspace** tab.
110+
111+
16. If you want to register the app group to a workspace, go to **Register application group** and select **Yes**. If you'd rather register the app group at a later time, select **No**.
56112

57-
```powershell
58-
New-RdsRemoteApp <tenantname> <hostpoolname> <appgroupname> -Name <remoteappname> -AppAlias <appalias>
59-
```
113+
17. If you select **Yes**, you can select an existing workspace to register your app group to.
114+
115+
>[!NOTE]
116+
>You can only register the app group to workspaces created in the same location as the host pool. Also. if you've previously registered another app group from the same host pool as your new app group to a workspace, it will be selected and you can't edit it. All app groups from a host pool must be registered to the same workspace.
60117
61-
5. (Optional) Run the following cmdlet to publish a new RemoteApp program to the application group created in step 1.
118+
> [!div class="mx-imgBorder"]
119+
> ![A screenshot of the register application group page for an already existing workspace. The host pool is preselected.](media/register-existing.png)
62120
63-
```powershell
64-
New-RdsRemoteApp <tenantname> <hostpoolname> <appgroupname> -Name <remoteappname> -Filepath <filepath> -IconPath <iconpath> -IconIndex <iconindex>
65-
```
121+
18. Optionally, if you want to create tags to make your workspace easy to organize, select the **Tags** tab and enter your tag names.
66122

67-
6. To verify that the app was published, run the following cmdlet.
123+
19. When you're done, select the **Review + create** tab.
68124

69-
```powershell
70-
Get-RdsRemoteApp <tenantname> <hostpoolname> <appgroupname>
71-
```
125+
20. Wait a bit for the validation process to complete. When it's done, select **Create** to deploy your app group.
72126

73-
7. Repeat steps 1–5 for each application that you want to publish for this app group.
74-
8. Run the following cmdlet to grant users access to the RemoteApp programs in the app group.
127+
The deployment process will do the following things for you:
75128

76-
```powershell
77-
Add-RdsAppGroupUser <tenantname> <hostpoolname> <appgroupname> -UserPrincipalName <userupn>
78-
```
129+
- Create the RemoteApp app group.
130+
- Add your selected apps to the app group.
131+
- Publish the app group published to users and user groups you selected.
132+
- Register the app group, if you chose to do so.
133+
- Create a link to an Azure Resource Manager template based on your configuration that you can download and save for later.
79134

80135
## Next steps
81136

84.2 KB
Loading
91.8 KB
Loading
108 KB
Loading
99.4 KB
Loading
70.5 KB
Loading
40.3 KB
Loading
46.1 KB
Loading

0 commit comments

Comments
 (0)