Skip to content

Commit 8978724

Browse files
author
Jill Grant
authored
Merge pull request #285257 from dknappettmsft/avd-rdp-reformat
AVD custom RDP properties reformatted and added CLI
2 parents ab6ea19 + d185bf7 commit 8978724

17 files changed

+226
-185
lines changed

articles/virtual-desktop/TOC.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,8 @@
394394
href: enroll-per-user-access-pricing.md
395395
- name: Host pools
396396
items:
397-
- name: Customize RDP properties
397+
- name: Set custom RDP properties
398+
displayName: customize
398399
href: customize-rdp-properties.md
399400
- name: Configure load balancing method
400401
displayName: load-balancing, lb

articles/virtual-desktop/app-attach-create-msix-image.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ You should create a new folder for the destination because a CIM disk image is m
5252
msixmgr.exe -Unpack -packagePath "C:\msix\myapp.msix" -destination "C:\msix\myapp\myapp.cim" -applyACLs -create -fileType cim -rootDirectory apps
5353
```
5454

55-
The output should be as follows:
55+
The output should be similar to the following example:
5656

5757
```Output
5858
Successfully created the CIM file: C:\msix\myapp\myapp.cim
@@ -72,7 +72,7 @@ Here's an example command to create a VHDX disk image from an MSIX image. A sing
7272
msixmgr.exe -Unpack -packagePath "C:\msix\myapp.msix" -destination "C:\msix\myapp.vhdx" -applyACLs -create -fileType vhdx -rootDirectory apps
7373
```
7474

75-
The output should be as follows:
75+
The output should be similar to the following example:
7676

7777
```Output
7878
Successfully created virtual disk

articles/virtual-desktop/app-attach-setup.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -164,10 +164,7 @@ Here's how to add an MSIX or Appx image as an app attach package using the Azure
164164

165165
# [Azure PowerShell](#tab/powershell)
166166

167-
Here's how to add an MSIX or Appx image as an app attach package using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization/) PowerShell module.
168-
169-
> [!IMPORTANT]
170-
> In the following examples, you'll need to change the `<placeholder>` values for your own.
167+
Here's how to add an MSIX or Appx image as an app attach package using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization/) PowerShell module. Be sure to change the `<placeholder>` values for your own.
171168

172169
[!INCLUDE [include-cloud-shell-local-powershell](includes/include-cloud-shell-local-powershell.md)]
173170

@@ -254,7 +251,7 @@ Here's how to add an MSIX or Appx image as an app attach package using the [Az.D
254251
Get-AzWvdAppAttachPackage @parameters | FL Name, ImagePackageApplication, ImagePackageFamilyName, ImagePath, ImageVersion, ImageIsActive, ImageIsRegularRegistration, SystemDataCreatedAt
255252
```
256253

257-
The output should be similar to the following output:
254+
The output should be similar to the following example:
258255

259256
```output
260257
Name : My App
@@ -698,10 +695,7 @@ Here's how to add an MSIX image using the Azure portal:
698695

699696
# [Azure PowerShell](#tab/powershell)
700697

701-
Here's how to add an MSIX package using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization/) PowerShell module.
702-
703-
> [!IMPORTANT]
704-
> In the following examples, you'll need to change the `<placeholder>` values for your own.
698+
Here's how to add an MSIX package using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization/) PowerShell module. Be sure to change the `<placeholder>` values for your own.
705699

706700
[!INCLUDE [include-cloud-shell-local-powershell](includes/include-cloud-shell-local-powershell.md)]
707701

@@ -718,7 +712,7 @@ Here's how to add an MSIX package using the [Az.DesktopVirtualization](/powershe
718712
$app = Expand-AzWvdMsixImage @parameters
719713
```
720714

721-
The output should be similar to the following output:
715+
The output should be similar to the following example:
722716

723717
```output
724718
Name
@@ -776,7 +770,7 @@ Here's how to add an MSIX package using the [Az.DesktopVirtualization](/powershe
776770
Get-AzWvdMsixPackage @parameters | ? PackageFamilyName -eq $app.PackageFamilyName | FL *
777771
```
778772

779-
The output should be similar to the following output:
773+
The output should be similar to the following example:
780774

781775
```output
782776
DisplayName : My App
@@ -836,7 +830,7 @@ Here's how to change a package's registration type and state using the [Az.Deskt
836830
Get-AzWvdMsixPackage @parameters | Select-Object DisplayName, ImagePath, Name, Version, IsRegularRegistration, IsActive
837831
```
838832

839-
The output should be similar to the following output:
833+
The output should be similar to the following example:
840834

841835
```output
842836
DisplayName ImagePath Name Version IsRegularRegistration IsActive
@@ -1011,7 +1005,7 @@ Here's how to remove applications using the [Az.DesktopVirtualization](/powershe
10111005
Get-AzWvdMsixPackage @parameters | Select-Object DisplayName, ImagePath, PackageFamilyName, Version
10121006
```
10131007

1014-
The output should be similar to the following output:
1008+
The output should be similar to the following example:
10151009

10161010
```output
10171011
DisplayName ImagePath Name Version

articles/virtual-desktop/autoscale-create-assign-scaling-plan.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -198,10 +198,7 @@ Now that you've assigned the *Desktop Virtualization Power On Off Contributor* r
198198

199199
### [PowerShell](#tab/powershell)
200200

201-
Here's how to create a scaling plan using the Az.DesktopVirtualization PowerShell module. The following examples show you how to create a scaling plan and scaling plan schedule.
202-
203-
> [!IMPORTANT]
204-
> In the following examples, you'll need to change the `<placeholder>` values for your own.
201+
Here's how to create a scaling plan using the Az.DesktopVirtualization PowerShell module. The following examples show you how to create a scaling plan and scaling plan schedule. Be sure to change the `<placeholder>` values for your own.
205202

206203
[!INCLUDE [include-cloud-shell-local-powershell](includes/include-cloud-shell-local-powershell.md)]
207204

articles/virtual-desktop/configure-host-pool-load-balancing.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,12 @@ To configure load balancing for a pooled host pool, you need:
5050

5151
- An Azure account assigned the [Desktop Virtualization Host Pool Contributor](rbac.md#desktop-virtualization-host-pool-contributor) role.
5252

53-
- 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).
54-
53+
- 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).
5554

5655
## Configure load balancing
5756

57+
Select the relevant tab for your scenario.
58+
5859
### [Azure portal](#tab/portal)
5960

6061
Here's how to configure load balancing with the Azure portal:
@@ -73,7 +74,7 @@ Here's how to configure load balancing with the Azure portal:
7374

7475
### [Azure PowerShell](#tab/powershell)
7576

76-
Here's how to configure load balancing with Azure PowerShell:
77+
Here's how to configure load balancing with Azure PowerShell. Be sure to change the `<placeholder>` values for your own.
7778

7879
[!INCLUDE [include-cloud-shell-local-powershell](includes/include-cloud-shell-local-powershell.md)]
7980

@@ -115,7 +116,7 @@ Here's how to configure load balancing with Azure PowerShell:
115116
Get-AzWvdHostPool @parameters | Format-Table Name, LoadBalancerType, MaxSessionLimit
116117
```
117118

118-
The output should be similar to the following output:
119+
The output should be similar to the following example:
119120

120121
```output
121122
Name LoadBalancerType MaxSessionLimit
@@ -160,7 +161,7 @@ Here's how to configure load balancing with Azure CLI:
160161
--output table
161162
```
162163

163-
The output should be similar to the following output:
164+
The output should be similar to the following example:
164165

165166
```output
166167
Name LoadBalancerType MaxSessionLimit

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

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -49,30 +49,30 @@ To configure automatic assignment in the Azure portal:
4949

5050
1. Select **Save**.
5151

52-
#### [PowerShell](#tab/powershell)
52+
#### [Azure PowerShell](#tab/powershell)
5353

54-
Here's how to configure a host pool to automatically assign users to VMs using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module.
54+
Here's how to configure a host pool to automatically assign users to VMs using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module. Be sure to change the `<placeholder>` values for your own.
5555

5656
[!INCLUDE [include-cloud-shell-local-powershell](includes/include-cloud-shell-local-powershell.md)]
5757

58-
2. Run the `Update-AzWvdHostPool` command in the following example to configure a host pool to automatically assign users to VMs. For more information about the parameters,see the [az-desktopvirtualization-hostpool Azure CLI reference](/cli/azure/desktopvirtualization/hostpool).
58+
2. Run the command in the following example to configure a host pool to automatically assign users to session hosts:
5959

6060
```powershell
61-
Update-AzWvdHostPool -ResourceGroupName $resourceGroupName -Name $hostPoolName -PersonalDesktopAssignmentType Automatic
61+
Update-AzWvdHostPool -ResourceGroupName <ResourceGroupName> -Name <HostPoolName> -PersonalDesktopAssignmentType Automatic
6262
```
6363

6464
#### [Azure CLI](#tab/cli)
6565

66-
Here's how to configure a host pool to automatically assign users to VMs using the [az-desktopvirtualization-hostpool-update](/cli/azure/desktopvirtualization/hostpool#az-desktopvirtualization-hostpool-update) command.
66+
Here's how to configure a host pool to automatically assign users to VMs using the [desktopvirtualization](/cli/azure/desktopvirtualization) command. Be sure to change the `<placeholder>` values for your own.
6767

6868
[!INCLUDE [include-cloud-shell-local-cli](includes/include-cloud-shell-local-cli.md)]
6969

70-
2. Run the command in the following example to configure a host pool to automatically assign users to VMs. For more information about the parameters, see the [az-desktopvirtualization-hostpool Azure CLI reference](/cli/azure/desktopvirtualization/hostpool).
70+
2. Run the command in the following example to configure a host pool to automatically assign users to session hosts:
7171

7272
```azurecli
7373
az desktopvirtualization hostpool update \
74-
--resource-group $resourceGroupName \
75-
--name $hostPoolName \
74+
--resource-group <ResourceGroupName> \
75+
--name <HostPoolName> \
7676
--personal-desktop-assignment-type Automatic
7777
```
7878

@@ -96,38 +96,38 @@ To configure direct assignment in the Azure portal:
9696

9797
1. Select **Save**.
9898

99-
#### [PowerShell](#tab/powershell)
99+
#### [Azure PowerShell](#tab/powershell)
100100

101-
Here's how to configure a host pool to require direct assignment of users to session hosts using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module.
101+
Here's how to configure a host pool to require direct assignment of users to session hosts using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module. Be sure to change the `<placeholder>` values for your own.
102102

103103
[!INCLUDE [include-cloud-shell-local-powershell](includes/include-cloud-shell-local-powershell.md)]
104104

105-
2. Run the `Update-AzWvdHostPool` command in the following example to configure a host pool to require direct assignment. For more information about the parameters, see the [Update-AzWvdHostPool](/powershell/module/az.desktopvirtualization/update-azwvdhostpool) reference.
105+
2. Run the command in the following example to configure a host pool to require direct assignment:
106106

107107
```powershell
108-
Update-AzWvdHostPool -ResourceGroupName $resourceGroupName -Name $hostPoolName -PersonalDesktopAssignmentType Direct
108+
Update-AzWvdHostPool -ResourceGroupName <ResourceGroupName> -Name <HostPoolName> -PersonalDesktopAssignmentType Direct
109109
```
110110

111111
#### [Azure CLI](#tab/cli)
112112

113-
Here's how to configure a host pool to automatically assign users to VMs using the [az-desktopvirtualization-hostpool-update](/cli/azure/desktopvirtualization/hostpool#az-desktopvirtualization-hostpool-update) command.
113+
Here's how to configure a host pool to automatically assign users to VMs using the [desktopvirtualization](/cli/azure/desktopvirtualization) command. Be sure to change the `<placeholder>` values for your own.
114114

115115
[!INCLUDE [include-cloud-shell-local-cli](includes/include-cloud-shell-local-cli.md)]
116116

117-
2. Run the command in the following example to configure a host pool to automatically assign users to VMs. For more information about the parameters, see the [az-desktopvirtualization-hostpool Azure CLI reference](/cli/azure/desktopvirtualization/hostpool).
117+
2. Run the command in the following example to configure a host pool to automatically assign users to session hosts:
118118

119119
```azurecli
120120
az desktopvirtualization hostpool update \
121-
--resource-group $resourceGroupName \
122-
--name $hostPoolName \
121+
--resource-group <ResourceGroupName> \
122+
--name <HostPoolName> \
123123
--personal-desktop-assignment-type Direct
124124
```
125125

126126
---
127127

128128
### Directly assign users to session hosts
129129

130-
Here's how to directly assign users to session hosts using the Azure portal or PowerShell. You can't assign users to session hosts using Azure CLI.
130+
Here's how to directly assign users to session hosts using the Azure portal or Azure PowerShell. You can't assign users to session hosts using Azure CLI.
131131

132132
#### [Azure portal](#tab/azure2)
133133

@@ -157,24 +157,23 @@ To directly assign a user to a session host in the Azure portal:
157157

158158
1. When you're done, select **Select**.
159159

160-
#### [PowerShell](#tab/powershell2)
160+
#### [Azure PowerShell](#tab/powershell2)
161161

162-
Here's how to configure a host pool to assign a user to a specific session host using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module.
162+
Here's how to configure a host pool to assign a user to a specific session host using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module. Be sure to change the `<placeholder>` values for your own.
163163

164164
[!INCLUDE [include-cloud-shell-local-powershell](includes/include-cloud-shell-local-powershell.md)]
165165

166166
2. Run the `Update-AzWvdHostPool` command in the following example to assign a user to a session host. For more information about the parameters, see the [Update-AzWvdHostPool](/powershell/module/az.desktopvirtualization/update-azwvdhostpool) reference.
167167

168168
```powershell
169-
Update-AzWvdSessionHost -HostPoolName $hostPoolName -Name $sessionHostName -ResourceGroupName $resourceGroupName -AssignedUser $userupn
169+
Update-AzWvdSessionHost -HostPoolName <HostPoolName> -Name <SessionHostName> -ResourceGroupName <ResourceGroupName> -AssignedUser <UserUPN>
170170
```
171171

172-
173172
---
174173

175174
## Unassign a personal desktop
176175

177-
Here's how to unassign a personal desktop using the Azure portal or PowerShell. You can't unassign a personal desktop using Azure CLI.
176+
Here's how to unassign a personal desktop using the Azure portal or Azure PowerShell. You can't unassign a personal desktop using Azure CLI.
178177

179178
#### [Azure portal](#tab/azure2)
180179

@@ -202,9 +201,9 @@ To unassign a personal desktop in the Azure portal:
202201
203202
1. Select **Unassign** when prompted with the warning.
204203

205-
#### [PowerShell](#tab/powershell2)
204+
#### [Azure PowerShell](#tab/powershell2)
206205

207-
Here's how to configure a host pool to unassign a personal desktop using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module.
206+
Here's how to configure a host pool to unassign a personal desktop. Be sure to change the `<placeholder>` values for your own.
208207

209208
[!INCLUDE [include-cloud-shell-local-powershell](includes/include-cloud-shell-local-powershell.md)]
210209

@@ -222,12 +221,11 @@ Here's how to configure a host pool to unassign a personal desktop using the [Az
222221
Invoke-AzRestMethod @unassignDesktopParams
223222
```
224223

225-
226224
---
227225

228226
## Reassign a personal desktop
229227

230-
Here's how to reassign a personal desktop using the Azure portal or PowerShell. You can't reassign a personal desktop using Azure CLI.
228+
Here's how to reassign a personal desktop using the Azure portal or Azure PowerShell. You can't reassign a personal desktop using Azure CLI.
231229

232230
#### [Azure portal](#tab/azure2)
233231

@@ -256,9 +254,9 @@ To reassign a personal desktop in the Azure portal:
256254

257255
1. When you're done, select **Select**.
258256

259-
#### [PowerShell](#tab/powershell2)
257+
#### [Azure PowerShell](#tab/powershell2)
260258

261-
Here's how to reassign a personal desktop using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module.
259+
Here's how to reassign a personal desktop using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module. Be sure to change the `<placeholder>` values for your own.
262260

263261
[!INCLUDE [include-cloud-shell-local-powershell](includes/include-cloud-shell-local-powershell.md)]
264262

@@ -291,7 +289,6 @@ You can give personal desktops you create *friendly names* to help users disting
291289

292290
[!INCLUDE [include-session-hosts-friendly-name](includes/include-session-hosts-friendly-name.md)]
293291

294-
295292
## Next steps
296293

297294
Now that you've configured the personal desktop assignment type and given your session host a friendly name, 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:
@@ -300,4 +297,4 @@ Now that you've configured the personal desktop assignment type and given your s
300297
- [Connect with the web client](./users/connect-web.md)
301298
- [Connect with the Android client](./users/connect-android-chrome-os.md)
302299
- [Connect with the iOS client](./users/connect-ios-ipados.md)
303-
- [Connect with the macOS client](./users/connect-macos.md)
300+
- [Connect with the macOS client](./users/connect-macos.md)

articles/virtual-desktop/configure-rdp-shortpath.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ For session hosts, UDP is enabled by default in Windows. To check the RDP transp
153153
}
154154
```
155155

156-
The output should be similar to the following output:
156+
The output should be similar to the following example:
157157

158158
```output
159159
The RDP transport protocols setting hasn't been changed from its default value.
@@ -199,7 +199,7 @@ Here's how to configure RDP Shortpath in the host pool networking settings using
199199

200200
# [Azure PowerShell](#tab/powershell)
201201

202-
Here's how to configure RDP Shortpath in the host pool networking settings using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module. In the following examples, you need to change the `<placeholder>` values for your own.
202+
Here's how to configure RDP Shortpath in the host pool networking settings using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module. Be sure to change the `<placeholder>` values for your own.
203203

204204
> [!TIP]
205205
> Be sure to use version 5.2.1 preview of the Az.DesktopVirtualization module.
@@ -217,7 +217,7 @@ Here's how to configure RDP Shortpath in the host pool networking settings using
217217
Get-AzWvdHostPool @parameters | FL ManagedPrivateUdp, DirectUdp, PublicUdp, RelayUdp
218218
```
219219

220-
The output should be similar to the following output:
220+
The output should be similar to the following example:
221221

222222
```output
223223
ManagedPrivateUdp : Default
@@ -310,7 +310,7 @@ Here's how to configure RDP Shortpath in the host pool networking settings using
310310
}
311311
```
312312

313-
The output should be similar to the following output:
313+
The output should be similar to the following example:
314314

315315
```output
316316
The default setting hasn't been changed from its default value. UDP is enabled.

0 commit comments

Comments
 (0)