Skip to content

Commit 59291a5

Browse files
CaptainFanZzzCaptainFanZzz
authored
Split Az.DesktopVirtualization Examples (#17092)
1 parent 3ff3183 commit 59291a5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+143
-56
lines changed

‎src/DesktopVirtualization/help/Disconnect-AzWvdUserSession.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Disconnect a userSession.
3232

3333
### Example 1: Disconnect a Windows Virtual Desktop UserSession by name
3434
```powershell
35-
PS C:\> Disconnect-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName -Id 2
35+
Disconnect-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName -Id 2
3636
```
3737

3838
This command disconnects a Windows Virtual Desktop UserSession in a Session Host.

‎src/DesktopVirtualization/help/Expand-AzWvdMsixImage.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,13 @@ Expands and Lists MSIX packages in an Image, given the Image Path.
4343

4444
### Example 1: Expands specified Image Path and retrieves Package metadata found in AppxManifest.xml
4545
```powershell
46-
PS C:\> Expand-AzWvdMsixImage -HostPoolName HostPoolName `
46+
Expand-AzWvdMsixImage -HostPoolName HostPoolName `
4747
-ResourceGroupName resourceGroupName `
4848
-SubscriptionId SubscriptionId `
4949
-Uri ImagePathURI
50+
```
5051

52+
```output
5153
Name Type
5254
---- ----
5355
HostPoolName/extractmsiximage Microsoft.DesktopVirtualization/hostpools/extractmsiximage

‎src/DesktopVirtualization/help/Get-AzWvdApplication.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ Get an application.
3737

3838
### Example 1: Get a Windows Virtual Desktop Application by name
3939
```powershell
40-
PS C:\> Get-AzWvdApplication -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name ApplicationName
40+
Get-AzWvdApplication -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name ApplicationName
41+
```
4142

43+
```output
4244
Name Type
4345
---- ----
4446
ApplicationGroupName/ApplicationName Microsoft.DesktopVirtualization/applicationgroups/applications
@@ -48,8 +50,10 @@ This command gets a Windows Virtual Desktop Application in an applicaton Group.
4850

4951
### Example 2: List Windows Virtual Desktop Applications
5052
```powershell
51-
PS C:\> Get-AzWvdApplication -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName
53+
Get-AzWvdApplication -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName
54+
```
5255

56+
```output
5357
Name Type
5458
---- ----
5559
ApplicationGroupName/ApplicationName1 Microsoft.DesktopVirtualization/applicationgroups/applications

‎src/DesktopVirtualization/help/Get-AzWvdApplicationGroup.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,10 @@ Get an application group.
4343

4444
### Example 1: Get a Windows Virtual Desktop ApplicationGroup by name
4545
```powershell
46-
PS C:\> Get-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName -Name ApplicationGroupName
46+
Get-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName -Name ApplicationGroupName
47+
```
4748

49+
```output
4850
Location Name Type
4951
-------- ---- ----
5052
eastus ApplicationGroupName Microsoft.DesktopVirtualization/applicationgroups
@@ -54,8 +56,10 @@ This command gets a Windows Virtual Desktop ApplicationGroup in a Resource Group
5456

5557
### Example 2: List Windows Virtual Desktop ApplicationGroups
5658
```powershell
57-
PS C:\> Get-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName
59+
Get-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName
60+
```
5861

62+
```output
5963
Location Name Type
6064
-------- ---- ----
6165
eastus ApplicationGroupName1 Microsoft.DesktopVirtualization/applicationgroups

‎src/DesktopVirtualization/help/Get-AzWvdDesktop.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ Get a desktop.
3737

3838
### Example 1: Get a Windows Virtual Desktop Desktop by name
3939
```powershell
40-
PS C:\> Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name DesktopName
40+
Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name DesktopName
41+
```
4142

43+
```output
4244
Name Type
4345
---- ----
4446
ApplicationGroupName/DesktopName Microsoft.DesktopVirtualization/applicationgroups/desktops
@@ -48,8 +50,10 @@ This command gets a Windows Virtual Desktop Desktop in an applicaton Group.
4850

4951
### Example 2: List Windows Virtual Desktop Desktops
5052
```powershell
51-
PS C:\> Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName
53+
Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName
54+
```
5255

56+
```output
5357
Name Type
5458
---- ----
5559
ApplicationGroupName/DesktopName Microsoft.DesktopVirtualization/applicationgroups/desktops

‎src/DesktopVirtualization/help/Get-AzWvdHostPool.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,10 @@ Get a host pool.
4242

4343
### Example 1: Get a Windows Virtual Desktop HostPool by name
4444
```powershell
45-
PS C:\> Get-AzWvdHostPool -ResourceGroupName ResourceGroupName -Name HostPoolName
45+
Get-AzWvdHostPool -ResourceGroupName ResourceGroupName -Name HostPoolName
46+
```
4647

48+
```output
4749
Location Name Type
4850
-------- ---- ----
4951
eastus HostPoolName Microsoft.DesktopVirtualization/hostpools
@@ -53,8 +55,10 @@ This command gets a Windows Virtual Desktop HostPool in a Resource Group.
5355

5456
### Example 2: List Windows Virtual Desktop HostPools
5557
```powershell
56-
PS C:\> Get-AzWvdHostPool -ResourceGroupName ResourceGroupName
58+
Get-AzWvdHostPool -ResourceGroupName ResourceGroupName
59+
```
5760

61+
```output
5862
Location Name Type
5963
-------- ---- ----
6064
eastus HostPoolName1 Microsoft.DesktopVirtualization/hostpools

‎src/DesktopVirtualization/help/Get-AzWvdHostPoolRegistrationToken.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@ Registration token of the host pool.
3131

3232
### Example 1: Get Windows Virtual Desktop registration token information by HostPoolName
3333
```powershell
34-
PS C:\> Get-AzWvdHostPoolRegistrationToken -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
34+
Get-AzWvdHostPoolRegistrationToken -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
35+
```
3536

37+
```output
3638
ExpirationTime RegistrationTokenOperation Token
3739
-------------- -------------------------- -----
3840
4/1/2020 10:19:33 PM None eyJhbGciOiJSUzI1NiIsImtpZCI6IkMyRjU1RUYxNzg0MEFCNzkzMDk2RUYzRjdEMkNBRDk0NThGNDhEOTQiLCJ0eXAiOiJKV1QifQ.eyJSZWdpc3RyYXRpb25JZCI6IjU5NGJjZWUwLTk5MjQtNDg3ZC1iOW...

‎src/DesktopVirtualization/help/Get-AzWvdMsixPackage.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ Get a msixpackage.
3737

3838
### Example 1: Get a MSIX Package by Name
3939
```powershell
40-
PS C:\> Get-AzWvdMsixPackage -HostPoolName HostPoolName -ResourceGroupName ResourceGroupName -SubscriptionId SubscriptionId -FullName PackageFullName
40+
Get-AzWvdMsixPackage -HostPoolName HostPoolName -ResourceGroupName ResourceGroupName -SubscriptionId SubscriptionId -FullName PackageFullName
41+
```
4142

43+
```output
4244
Name Type
4345
---- ----
4446
HostPoolName/MSIXPackage_FullName Microsoft.DesktopVirtualization/hostpools/msixpackages
@@ -48,8 +50,10 @@ This command gets a MSIX Package in a HostPool.
4850

4951
### Example 2: List MSIX Packages
5052
```powershell
51-
PS C:\> Get-AzWvdMsixPackage -HostPoolName HostPoolName -ResourceGroupName ResourceGroupName -SubscriptionId SubscriptionId
53+
Get-AzWvdMsixPackage -HostPoolName HostPoolName -ResourceGroupName ResourceGroupName -SubscriptionId SubscriptionId
54+
```
5255

56+
```output
5357
Name Type
5458
---- ----
5559
HostPoolName/MSIXPackage_FullName1 Microsoft.DesktopVirtualization/hostpools/msixpackages

‎src/DesktopVirtualization/help/Get-AzWvdRegistrationInfo.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ Get the Windows virtual desktop registration info.
2424

2525
### Example 1: Get a Windows Virtual Desktop Registration Token
2626
```powershell
27-
PS C:\> Get-AzWvdRegistrationInfo -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
27+
Get-AzWvdRegistrationInfo -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
28+
```
29+
30+
```output
2831
ExpirationTime RegistrationTokenOperation Token
2932
-------------- -------------------------- -----
3033
4/1/2020 10:19:33 PM None eyJhbGciOiJSUzI1NiIsImtpZCI6IkMyRjU1RUYxNzg0MEFCNzkzMDk2RUYzRjdEMkNBRDk0NThGNDhEOTQiLCJ0eXAiOiJKV1QifQ.eyJSZWdpc3RyYXRpb25JZCI6IjU5NGJjZWUwLTk5MjQtNDg3ZC1iOW...

‎src/DesktopVirtualization/help/Get-AzWvdScalingPlan.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,10 @@ Get a scaling plan.
4848

4949
### Example 1: Get a Windows Virtual Desktop Scaling Plan by name
5050
```powershell
51-
PS C:\> Get-AzWvdScalingPlan -ResourceGroupName ResourceGroupName -Name scalingPlan1
51+
Get-AzWvdScalingPlan -ResourceGroupName ResourceGroupName -Name scalingPlan1
52+
```
5253

54+
```output
5355
Location Name Type
5456
-------- ---- ----
5557
westcentralus scalingPlan1 Microsoft.DesktopVirtualization/scalingplans
@@ -59,8 +61,10 @@ This command gets a Windows Virtual Desktop Scaling Plan in a Resource Group.
5961

6062
### Example 2: List Windows Virtual Desktop Scaling Plans
6163
```powershell
62-
PS C:\> Get-AzWvdScalingPlan -ResourceGroupName ResourceGroupName
64+
Get-AzWvdScalingPlan -ResourceGroupName ResourceGroupName
65+
```
6366

67+
```output
6468
Location Name Type
6569
-------- ---- ----
6670
westcentralus scalingPlan1 Microsoft.DesktopVirtualization/scalingplans

‎src/DesktopVirtualization/help/Get-AzWvdSessionHost.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ Get a session host.
3737

3838
### Example 1: Get a Windows Virtual Desktop SessionHost by name
3939
```powershell
40-
PS C:\> Get-AzWvdSessionHost -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -Name SessionHostName
40+
Get-AzWvdSessionHost -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -Name SessionHostName
41+
```
4142

43+
```output
4244
Name Type
4345
---- ----
4446
HostPoolName/SessionHostName Microsoft.DesktopVirtualization/hostpools/sessionhosts
@@ -48,8 +50,10 @@ This command gets a Windows Virtual Desktop SessionHost in a Host Pool.
4850

4951
### Example 2: List Windows Virtual Desktop SessionHosts
5052
```powershell
51-
PS C:\> Get-AzWvdSessionHost -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
53+
Get-AzWvdSessionHost -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
54+
```
5255

56+
```output
5357
Name Type
5458
---- ----
5559
HostPoolName/SessionHostName1 Microsoft.DesktopVirtualization/hostpools/sessionhosts

‎src/DesktopVirtualization/help/Get-AzWvdStartMenuItem.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ List start menu items in the given application group.
2424

2525
### Example 2: List Windows Virtual Desktop Start Menu Items
2626
```powershell
27-
PS C:\> Get-AzWvdStartMenuItem -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName
27+
Get-AzWvdStartMenuItem -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName
28+
```
2829

30+
```output
2931
Name Type
3032
---- ----
3133
ApplicationGroupName/Character Map Microsoft.DesktopVirtualization/applicationgroups/startmenuitems

‎src/DesktopVirtualization/help/Get-AzWvdUserSession.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,10 @@ Get a userSession.
4343

4444
### Example 1: Get a Windows Virtual Desktop UserSession by name
4545
```powershell
46-
PS C:\> Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName -Id 2
46+
Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName -Id 2
47+
```
4748

49+
```output
4850
Name Type
4951
---- ----
5052
HostPoolName/SessionHostName/2 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions
@@ -54,8 +56,10 @@ This command gets a Windows Virtual Desktop UserSession in a Session Host.
5456

5557
### Example 2: List Windows Virtual Desktop UserSessions
5658
```powershell
57-
PS C:\> Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName
59+
Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName
60+
```
5861

62+
```output
5963
Name Type
6064
---- ----
6165
HostPoolName/SessionHostName/2 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions
@@ -66,8 +70,10 @@ This command lists a Windows Virtual Desktop UserSessions in a Session Host.
6670

6771
### Example 3: List Windows Virtual Desktop UserSessions in host pool
6872
```powershell
69-
PS C:\> Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
73+
Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
74+
```
7075

76+
```output
7177
Name Type
7278
---- ----
7379
HostPoolName/SessionHostName/2 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions

‎src/DesktopVirtualization/help/Get-AzWvdWorkspace.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,10 @@ Get a workspace.
4242

4343
### Example 1: Get a Windows Virtual Desktop Workspace by name
4444
```powershell
45-
PS C:\> Get-AzWvdWorkspace -ResourceGroupName ResourceGroupName -Name WorkspaceName
45+
Get-AzWvdWorkspace -ResourceGroupName ResourceGroupName -Name WorkspaceName
46+
```
4647

48+
```output
4749
Location Name Type
4850
-------- ---- ----
4951
eastus WorkspaceName Microsoft.DesktopVirtualization/workspaces
@@ -53,8 +55,10 @@ This command gets a Windows Virtual Desktop Workspace in a Resource Group.
5355

5456
### Example 2: List Windows Virtual Desktop Workspaces
5557
```powershell
56-
PS C:\> Get-AzWvdWorkspace -ResourceGroupName ResourceGroupName
58+
Get-AzWvdWorkspace -ResourceGroupName ResourceGroupName
59+
```
5760

61+
```output
5862
Location Name Type
5963
-------- ---- ----
6064
eastus WorkspaceName1 Microsoft.DesktopVirtualization/workspaces

‎src/DesktopVirtualization/help/New-AzWvdApplication.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Create or update an application.
3535

3636
### Example 1: Create a Windows Virtual Desktop Application
3737
```powershell
38-
PS C:\> New-AzWvdApplication -ResourceGroupName ResourceGroupName `
38+
New-AzWvdApplication -ResourceGroupName ResourceGroupName `
3939
-GroupName ApplicationGroupName `
4040
-Name ApplicationName `
4141
-FilePath 'C:\windows\system32\mspaint.exe' `
@@ -45,7 +45,9 @@ PS C:\> New-AzWvdApplication -ResourceGroupName ResourceGroupName `
4545
-IconPath 'C:\windows\system32\mspaint.exe' `
4646
-CommandLineSetting 'Allow' `
4747
-ShowInPortal:$true
48+
```
4849

50+
```output
4951
Name Type
5052
---- ----
5153
ApplicationGroupName/ApplicationName Microsoft.DesktopVirtualization/applicationgroups/applications

‎src/DesktopVirtualization/help/New-AzWvdApplicationGroup.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,16 @@ Create or update an applicationGroup.
3030

3131
### Example 1: Create a Windows Virtual Desktop ApplicationGroup by name
3232
```powershell
33-
PS C:\> New-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName `
33+
New-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName `
3434
-Name ApplicationGroupName `
3535
-Location 'eastus' `
3636
-FriendlyName 'Friendly Name' `
3737
-Description 'Description' `
3838
-HostPoolArmPath '/subscriptions/SubscriptionId/resourcegroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName' `
3939
-ApplicationGroupType 'RemoteApp'
40+
```
4041

42+
```output
4143
Location Name Type
4244
-------- ---- ----
4345
eastus ApplicationGroupName Microsoft.DesktopVirtualization/applicationgroups
@@ -47,14 +49,16 @@ This command creates a Windows Virtual Desktop ApplicationGroup in a Resource Gr
4749

4850
### Example 2: Create a Windows Virtual Desktop ApplicationGroup by name
4951
```powershell
50-
PS C:\> New-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName `
52+
New-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName `
5153
-Name ApplicationGroupName `
5254
-Location 'eastus' `
5355
-FriendlyName 'Friendly Name' `
5456
-Description 'Description' `
5557
-HostPoolArmPath '/subscriptions/SubscriptionId/resourcegroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName' `
5658
-ApplicationGroupType 'Desktop'
59+
```
5760

61+
```output
5862
Location Name Type
5963
-------- ---- ----
6064
eastus ApplicationGroupName Microsoft.DesktopVirtualization/applicationgroups

‎src/DesktopVirtualization/help/New-AzWvdHostPool.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Create or update a host pool.
4343

4444
### Example 1: Create a Windows Virtual Desktop HostPool by name
4545
```powershell
46-
PS C:\> New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
46+
New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
4747
-Name HostPoolName `
4848
-Location 'eastus' `
4949
-HostPoolType 'Pooled' `
@@ -61,17 +61,19 @@ PS C:\> New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
6161
-CustomRdpProperty $null `
6262
-Ring $null `
6363
-ValidationEnvironment:$false
64+
```
6465

66+
```output
6567
Location Name Type
6668
-------- ---- ----
6769
eastus HostPoolName Microsoft.DesktopVirtualization/hostpools
6870
```
6971

7072
This command creates a Windows Virtual Desktop HostPool in a Resource Group.
7173

72-
### Example 1: Create a Windows Virtual Desktop HostPool by name
74+
### Example 2: Create a Windows Virtual Desktop HostPool by name
7375
```powershell
74-
PS C:\> New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
76+
New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
7577
-Name HostPoolName `
7678
-Location 'eastus' `
7779
-HostPoolType 'Personal' `
@@ -89,7 +91,9 @@ PS C:\> New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
8991
-CustomRdpProperty $null `
9092
-Ring $null `
9193
-ValidationEnvironment:$false
94+
```
9295

96+
```output
9397
Location Name Type
9498
-------- ---- ----
9599
eastus HostPoolName Microsoft.DesktopVirtualization/hostpools

0 commit comments

Comments
 (0)