Skip to content

Commit ee807f5

Browse files
HeidilohrHeidilohr
committed
Created new doc & started updating existing doc.
1 parent b1d695f commit ee807f5

File tree

3 files changed

+181
-39
lines changed

3 files changed

+181
-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

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

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
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: tutorial
9+
ms.date: 04/30/2020
10+
ms.author: helohr
11+
manager: lizross
12+
---
13+
# Tutorial: 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+
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:
30+
31+
```powershell
32+
Add-RdsAccount -DeploymentUrl "https://rdbroker.wvd.microsoft.com"
33+
```
34+
35+
## Create a RemoteApp group
36+
37+
1. Run the following PowerShell cmdlet to create a new empty RemoteApp app group.
38+
39+
```powershell
40+
New-RdsAppGroup <tenantname> <hostpoolname> <appgroupname> -ResourceType "RemoteApp"
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-RdsAppGroup <tenantname> <hostpoolname>
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-RdsStartMenuApp <tenantname> <hostpoolname> <appgroupname>
53+
```
54+
55+
4. Run the following cmdlet to install the application based on `AppAlias`. `AppAlias` becomes visible when you run the output from step 3.
56+
57+
```powershell
58+
New-RdsRemoteApp <tenantname> <hostpoolname> <appgroupname> -Name <remoteappname> -AppAlias <appalias>
59+
```
60+
61+
5. (Optional) Run the following cmdlet to publish a new RemoteApp program to the application group created in step 1.
62+
63+
```powershell
64+
New-RdsRemoteApp <tenantname> <hostpoolname> <appgroupname> -Name <remoteappname> -Filepath <filepath> -IconPath <iconpath> -IconIndex <iconindex>
65+
```
66+
67+
6. To verify that the app was published, run the following cmdlet.
68+
69+
```powershell
70+
Get-RdsRemoteApp <tenantname> <hostpoolname> <appgroupname>
71+
```
72+
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.
75+
76+
```powershell
77+
Add-RdsAppGroupUser <tenantname> <hostpoolname> <appgroupname> -UserPrincipalName <userupn>
78+
```
79+
80+
## Next steps
81+
82+
In this tutorial, you learned how to create an app group, populate it with RemoteApp programs, and assign users to the app group. To learn how to create a validation host pool, see the following tutorial. You can use a validation host pool to monitor service updates before rolling them out to your production environment.
83+
84+
> [!div class="nextstepaction"]
85+
> [Create a host pool to validate service updates](./create-validation-host-pool.md)

‎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 virtual machines 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/).
36+
37+
2. Search for and select **Windows Virtual Desktop**.
3638

37-
1. Run the following PowerShell cmdlet to create a new empty RemoteApp app group.
39+
3. Select **Application Groups** in the menu on the left side of the page, then select **+ Add**.
3840

39-
```powershell
40-
New-RdsAppGroup <tenantname> <hostpoolname> <appgroupname> -ResourceType "RemoteApp"
41-
```
41+
4. 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.
4242

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.
43+
5. Select the host pool that will be associated with the application group.
4444

45-
```powershell
46-
Get-RdsAppGroup <tenantname> <hostpoolname>
47-
```
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. So, an app group needs to be associated with a host pool during creation.
4847
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.
48+
![](media/fa2a6efddb0d220c6bfdbf2c86194406.png)
5049

51-
```powershell
52-
Get-RdsStartMenuApp <tenantname> <hostpoolname> <appgroupname>
53-
```
50+
6. If you want to add virtual machines to your host pool, select **Host pools** in the menu on the left side of the screen. Next, select the name of the host pool you want to add virtual machines to.
5451

55-
4. Run the following cmdlet to install the application based on `AppAlias`. `AppAlias` becomes visible when you run the output from step 3.
52+
After that, select **Application groups** from the menu on the left side of the screen, then select **+ Add**.
53+
54+
![](media/bd0b037abe969ff33b219949432ab341.png)
55+
56+
Finally, select the subscription group and resource group you want to create the app group in. You can choose to create a new resource group instead of selecting an existing one.
57+
58+
>[!NOTE]
59+
>With this approach, the host pool that is related to the application group is already selected since you navigated from the host pool context.
60+
61+
![](media/522f3865c86b16d51c570621b4353386.png)
62+
63+
7. Select **RemoteApp** under **Application group type** and provide a name.
64+
65+
![](media/dacceac6fc2408bdb2fbe521d530a092.png)
66+
67+
1. Select **Assignments**.
68+
69+
![](media/35e982bc311922d99943d955441908f5.png)
70+
71+
1. To publish individual users or user groups to the app group, select **+Add Azure AD users or user groups**.
72+
73+
2. When the Azure Active Directory user selector opens, select single or multiple users and user groups.
74+
75+
![](media/ad4dcb32deebf98ea07e6b2d29deb934.png)
76+
77+
1. Select **Select**.
78+
79+
2. Select **Applications**, then select **+Add applications**.
80+
81+
3. To add an application from the start menu:
82+
83+
- For *Application source*, choose Start menu and then choose the application from the list under *Application*.
84+
85+
![](media/ae82f483a6bf5c6abfc80fae3e9ceafd.png)
86+
87+
- Add a *Display name*. This will be the name shown to the user on their client.
88+
89+
- Leave the other options as is and click on **Save**.
90+
91+
4. To add an application from specific file path:
92+
93+
1. For *Application source*, choose File path.
94+
95+
2. Enter the path to the application on the session host, registered with the associated host pool.
96+
97+
3. Enter all other details of the application like *Application name, Display name, Icon path and Icon index*.
98+
99+
4. Click on **Save**.
100+
101+
![](media/3f5d93ee4c09d2681ea7dd540b8e71d5.png)
102+
103+
Repeat this for every application you want added to the application group.
104+
105+
1. Click on Workspace. As part of the application group creation wizard, you can hoose to register the app group to a workspace.
106+
107+
2. If you want to register the app group to a workspace, choose Yes. If you want to register the app group at a later time, choose No.
108+
109+
![](media/35ad245ea9f0c7ad0672d4990ef72464.png)
110+
111+
1. If yes, you can then create a new workspace or select from existing workspaces. Only workspaces created in the same location as the host pool will be allowed to register the app group to. Also if you have previously registered another app group (from the same host pool) to a workspace, it will be selected and you cannot edit it. All app groups from a host pool must be registered to the same workspace.
112+
113+
![](media/1b64e643f42d458b1245087ccc4ada9f.png)
114+
115+
Then click on **Tags**. This can be skipped and you can choose to select **Review + create.**
116+
117+
Then select **Review + create**
118+
119+
validate all your input.
56120

57-
```powershell
58-
New-RdsRemoteApp <tenantname> <hostpoolname> <appgroupname> -Name <remoteappname> -AppAlias <appalias>
59-
```
121+
Once validation is completed click **Create**. Optionally you can download the ARM template used by the wizard.
60122

61-
5. (Optional) Run the following cmdlet to publish a new RemoteApp program to the application group created in step 1.
123+
When the deployment completes, these are the following will be completed:
62124

63-
```powershell
64-
New-RdsRemoteApp <tenantname> <hostpoolname> <appgroupname> -Name <remoteappname> -Filepath <filepath> -IconPath <iconpath> -IconIndex <iconindex>
65-
```
125+
- The RemoteApp app group
66126

67-
6. To verify that the app was published, run the following cmdlet.
127+
- Applications added to the app group
68128

69-
```powershell
70-
Get-RdsRemoteApp <tenantname> <hostpoolname> <appgroupname>
71-
```
129+
- App group published to the selected users and user groups.
72130

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.
131+
- If you chose to create a workspace, workspace will be created
75132

76-
```powershell
77-
Add-RdsAppGroupUser <tenantname> <hostpoolname> <appgroupname> -UserPrincipalName <userupn>
78-
```
133+
- If you chose to register the app group, the registration will be complete
79134

80135
## Next steps
81136

0 commit comments

Comments
 (0)