Skip to content

Commit 3a0119d

Browse files
committed
AVD custom RDP properties reformatted and added CLI
1 parent d0005c0 commit 3a0119d

15 files changed

+197
-142
lines changed

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: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ To configure automatic assignment in the Azure portal:
5151

5252
#### [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

@@ -98,7 +98,7 @@ To configure direct assignment in the Azure portal:
9898

9999
#### [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

@@ -159,7 +159,7 @@ To directly assign a user to a session host in the Azure portal:
159159

160160
#### [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

@@ -204,7 +204,7 @@ To unassign a personal desktop in the Azure portal:
204204

205205
#### [PowerShell](#tab/powershell2)
206206

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

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

@@ -258,7 +258,7 @@ To reassign a personal desktop in the Azure portal:
258258

259259
#### [PowerShell](#tab/powershell2)
260260

261-
Here's how to reassign a personal desktop using the [Az.DesktopVirtualization](/powershell/module/az.desktopvirtualization) PowerShell module.
261+
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.
262262

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

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.

articles/virtual-desktop/configure-single-sign-on.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ To configure the service principal, use the [Microsoft Graph PowerShell SDK](/po
161161
New-MgServicePrincipalRemoteDesktopSecurityConfigurationTargetDeviceGroup -ServicePrincipalId $WCLspId -BodyParameter $tdg
162162
```
163163

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

166166
```output
167167
Id DisplayName

articles/virtual-desktop/customize-feed-for-virtual-desktop-users.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,8 @@ ms.date: 02/01/2024
77
ms.author: daknappe
88
ms.custom: devx-track-azurepowershell, docs_inherited
99
---
10-
# Customize the feed for Azure Virtual Desktop users
1110

12-
>[!IMPORTANT]
13-
>This content applies to Azure Virtual Desktop with Azure Resource Manager Azure Virtual Desktop objects. If you're using Azure Virtual Desktop (classic) without Azure Resource Manager objects, see [this article](./virtual-desktop-fall-2019/customize-feed-virtual-desktop-users-2019.md).
11+
# Customize the feed for Azure Virtual Desktop users
1412

1513
You can customize the feed so the RemoteApp and remote desktop resources appear in a recognizable way for your users.
1614

@@ -19,12 +17,12 @@ You can customize the feed so the RemoteApp and remote desktop resources appear
1917
If you're using either the Azure portal or PowerShell method, you'll need the following things:
2018

2119
- 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).
2320

21+
- 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).
2422

25-
## Customize the display name for a RemoteApp or desktop
23+
## Customize the display name for a desktop or application
2624

27-
You can change the display name for a published RemoteApp or desktop to make it easier for users to identify what to connect to.
25+
Select the relevant tab for your scenario.
2826

2927
#### [Azure portal](#tab/portal)
3028

@@ -49,7 +47,7 @@ Here's how to customize the display name for a published RemoteApp or desktop us
4947

5048
### Customize the display name for a RemoteApp
5149

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.
50+
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. Be sure to change the `<placeholder>` values for your own.
5351

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

@@ -80,7 +78,7 @@ Here's how to customize the display name for a RemoteApp using PowerShell. By de
8078

8179
### Customize the display name for a Remote Desktop
8280

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).
81+
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). Be sure to change the `<placeholder>` values for your own.
8482

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

0 commit comments

Comments
 (0)