Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split Az.DesktopVirtualization Examples in generation #17093

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Disconnect a userSession.

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

This command disconnects a Windows Virtual Desktop UserSession in a Session Host.
Expand Down
4 changes: 3 additions & 1 deletion src/DesktopVirtualization/docs/Expand-AzWvdMsixImage.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,13 @@ Expands and Lists MSIX packages in an Image, given the Image Path.

### Example 1: Expands specified Image Path and retrieves Package metadata found in AppxManifest.xml
```powershell
PS C:\> Expand-AzWvdMsixImage -HostPoolName HostPoolName `
Expand-AzWvdMsixImage -HostPoolName HostPoolName `
-ResourceGroupName resourceGroupName `
-SubscriptionId SubscriptionId `
-Uri ImagePathURI
```

```output
Name Type
---- ----
HostPoolName/extractmsiximage Microsoft.DesktopVirtualization/hostpools/extractmsiximage
Expand Down
8 changes: 6 additions & 2 deletions src/DesktopVirtualization/docs/Get-AzWvdApplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Get an application.

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

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

### Example 2: List Windows Virtual Desktop Applications
```powershell
PS C:\> Get-AzWvdApplication -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName
Get-AzWvdApplication -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName
```

```output
Name Type
---- ----
ApplicationGroupName/ApplicationName1 Microsoft.DesktopVirtualization/applicationgroups/applications
Expand Down
8 changes: 6 additions & 2 deletions src/DesktopVirtualization/docs/Get-AzWvdApplicationGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,10 @@ Get an application group.

### Example 1: Get a Windows Virtual Desktop ApplicationGroup by name
```powershell
PS C:\> Get-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName -Name ApplicationGroupName
Get-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName -Name ApplicationGroupName
```

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

### Example 2: List Windows Virtual Desktop ApplicationGroups
```powershell
PS C:\> Get-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName
Get-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName
```

```output
Location Name Type
-------- ---- ----
eastus ApplicationGroupName1 Microsoft.DesktopVirtualization/applicationgroups
Expand Down
8 changes: 6 additions & 2 deletions src/DesktopVirtualization/docs/Get-AzWvdDesktop.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Get a desktop.

### Example 1: Get a Windows Virtual Desktop Desktop by name
```powershell
PS C:\> Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name DesktopName
Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name DesktopName
```

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

### Example 2: List Windows Virtual Desktop Desktops
```powershell
PS C:\> Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName
Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName
```

```output
Name Type
---- ----
ApplicationGroupName/DesktopName Microsoft.DesktopVirtualization/applicationgroups/desktops
Expand Down
8 changes: 6 additions & 2 deletions src/DesktopVirtualization/docs/Get-AzWvdHostPool.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ Get a host pool.

### Example 1: Get a Windows Virtual Desktop HostPool by name
```powershell
PS C:\> Get-AzWvdHostPool -ResourceGroupName ResourceGroupName -Name HostPoolName
Get-AzWvdHostPool -ResourceGroupName ResourceGroupName -Name HostPoolName
```

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

### Example 2: List Windows Virtual Desktop HostPools
```powershell
PS C:\> Get-AzWvdHostPool -ResourceGroupName ResourceGroupName
Get-AzWvdHostPool -ResourceGroupName ResourceGroupName
```

```output
Location Name Type
-------- ---- ----
eastus HostPoolName1 Microsoft.DesktopVirtualization/hostpools
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ Registration token of the host pool.

### Example 1: Get Windows Virtual Desktop registration token information by HostPoolName
```powershell
PS C:\> Get-AzWvdHostPoolRegistrationToken -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
Get-AzWvdHostPoolRegistrationToken -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
```

```output
ExpirationTime RegistrationTokenOperation Token
-------------- -------------------------- -----
4/1/2020 10:19:33 PM None eyJhbGciOiJSUzI1NiIsImtpZCI6IkMyRjU1RUYxNzg0MEFCNzkzMDk2RUYzRjdEMkNBRDk0NThGNDhEOTQiLCJ0eXAiOiJKV1QifQ.eyJSZWdpc3RyYXRpb25JZCI6IjU5NGJjZWUwLTk5MjQtNDg3ZC1iOW...
Expand Down
8 changes: 6 additions & 2 deletions src/DesktopVirtualization/docs/Get-AzWvdMsixPackage.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Get a msixpackage.

### Example 1: Get a MSIX Package by Name
```powershell
PS C:\> Get-AzWvdMsixPackage -HostPoolName HostPoolName -ResourceGroupName ResourceGroupName -SubscriptionId SubscriptionId -FullName PackageFullName
Get-AzWvdMsixPackage -HostPoolName HostPoolName -ResourceGroupName ResourceGroupName -SubscriptionId SubscriptionId -FullName PackageFullName
```

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

### Example 2: List MSIX Packages
```powershell
PS C:\> Get-AzWvdMsixPackage -HostPoolName HostPoolName -ResourceGroupName ResourceGroupName -SubscriptionId SubscriptionId
Get-AzWvdMsixPackage -HostPoolName HostPoolName -ResourceGroupName ResourceGroupName -SubscriptionId SubscriptionId
```

```output
Name Type
---- ----
HostPoolName/MSIXPackage_FullName1 Microsoft.DesktopVirtualization/hostpools/msixpackages
Expand Down
5 changes: 4 additions & 1 deletion src/DesktopVirtualization/docs/Get-AzWvdRegistrationInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ Get the Windows virtual desktop registration info.

### Example 1: Get a Windows Virtual Desktop Registration Token
```powershell
PS C:\> Get-AzWvdRegistrationInfo -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
Get-AzWvdRegistrationInfo -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
```

```output
ExpirationTime RegistrationTokenOperation Token
-------------- -------------------------- -----
4/1/2020 10:19:33 PM None eyJhbGciOiJSUzI1NiIsImtpZCI6IkMyRjU1RUYxNzg0MEFCNzkzMDk2RUYzRjdEMkNBRDk0NThGNDhEOTQiLCJ0eXAiOiJKV1QifQ.eyJSZWdpc3RyYXRpb25JZCI6IjU5NGJjZWUwLTk5MjQtNDg3ZC1iOW...
Expand Down
8 changes: 6 additions & 2 deletions src/DesktopVirtualization/docs/Get-AzWvdScalingPlan.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,10 @@ Get a scaling plan.

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

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

### Example 2: List Windows Virtual Desktop Scaling Plans
```powershell
PS C:\> Get-AzWvdScalingPlan -ResourceGroupName ResourceGroupName
Get-AzWvdScalingPlan -ResourceGroupName ResourceGroupName
```

```output
Location Name Type
-------- ---- ----
westcentralus scalingPlan1 Microsoft.DesktopVirtualization/scalingplans
Expand Down
8 changes: 6 additions & 2 deletions src/DesktopVirtualization/docs/Get-AzWvdSessionHost.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Get a session host.

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

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

### Example 2: List Windows Virtual Desktop SessionHosts
```powershell
PS C:\> Get-AzWvdSessionHost -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
Get-AzWvdSessionHost -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
```

```output
Name Type
---- ----
HostPoolName/SessionHostName1 Microsoft.DesktopVirtualization/hostpools/sessionhosts
Expand Down
4 changes: 3 additions & 1 deletion src/DesktopVirtualization/docs/Get-AzWvdStartMenuItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ List start menu items in the given application group.

### Example 2: List Windows Virtual Desktop Start Menu Items
```powershell
PS C:\> Get-AzWvdStartMenuItem -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName
Get-AzWvdStartMenuItem -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName
```

```output
Name Type
---- ----
ApplicationGroupName/Character Map Microsoft.DesktopVirtualization/applicationgroups/startmenuitems
Expand Down
12 changes: 9 additions & 3 deletions src/DesktopVirtualization/docs/Get-AzWvdUserSession.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,10 @@ Get a userSession.

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

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

### Example 2: List Windows Virtual Desktop UserSessions
```powershell
PS C:\> Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName
Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName
```

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

### Example 3: List Windows Virtual Desktop UserSessions in host pool
```powershell
PS C:\> Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
```

```output
Name Type
---- ----
HostPoolName/SessionHostName/2 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions
Expand Down
8 changes: 6 additions & 2 deletions src/DesktopVirtualization/docs/Get-AzWvdWorkspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ Get a workspace.

### Example 1: Get a Windows Virtual Desktop Workspace by name
```powershell
PS C:\> Get-AzWvdWorkspace -ResourceGroupName ResourceGroupName -Name WorkspaceName
Get-AzWvdWorkspace -ResourceGroupName ResourceGroupName -Name WorkspaceName
```

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

### Example 2: List Windows Virtual Desktop Workspaces
```powershell
PS C:\> Get-AzWvdWorkspace -ResourceGroupName ResourceGroupName
Get-AzWvdWorkspace -ResourceGroupName ResourceGroupName
```

```output
Location Name Type
-------- ---- ----
eastus WorkspaceName1 Microsoft.DesktopVirtualization/workspaces
Expand Down
4 changes: 3 additions & 1 deletion src/DesktopVirtualization/docs/New-AzWvdApplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Create or update an application.

### Example 1: Create a Windows Virtual Desktop Application
```powershell
PS C:\> New-AzWvdApplication -ResourceGroupName ResourceGroupName `
New-AzWvdApplication -ResourceGroupName ResourceGroupName `
-GroupName ApplicationGroupName `
-Name ApplicationName `
-FilePath 'C:\windows\system32\mspaint.exe' `
Expand All @@ -45,7 +45,9 @@ PS C:\> New-AzWvdApplication -ResourceGroupName ResourceGroupName `
-IconPath 'C:\windows\system32\mspaint.exe' `
-CommandLineSetting 'Allow' `
-ShowInPortal:$true
```

```output
Name Type
---- ----
ApplicationGroupName/ApplicationName Microsoft.DesktopVirtualization/applicationgroups/applications
Expand Down
8 changes: 6 additions & 2 deletions src/DesktopVirtualization/docs/New-AzWvdApplicationGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,16 @@ Create or update an applicationGroup.

### Example 1: Create a Windows Virtual Desktop ApplicationGroup by name
```powershell
PS C:\> New-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName `
New-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName `
-Name ApplicationGroupName `
-Location 'eastus' `
-FriendlyName 'Friendly Name' `
-Description 'Description' `
-HostPoolArmPath '/subscriptions/SubscriptionId/resourcegroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName' `
-ApplicationGroupType 'RemoteApp'
```

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

### Example 2: Create a Windows Virtual Desktop ApplicationGroup by name
```powershell
PS C:\> New-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName `
New-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName `
-Name ApplicationGroupName `
-Location 'eastus' `
-FriendlyName 'Friendly Name' `
-Description 'Description' `
-HostPoolArmPath '/subscriptions/SubscriptionId/resourcegroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName' `
-ApplicationGroupType 'Desktop'
```

```output
Location Name Type
-------- ---- ----
eastus ApplicationGroupName Microsoft.DesktopVirtualization/applicationgroups
Expand Down
10 changes: 7 additions & 3 deletions src/DesktopVirtualization/docs/New-AzWvdHostPool.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Create or update a host pool.

### Example 1: Create a Windows Virtual Desktop HostPool by name
```powershell
PS C:\> New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
-Name HostPoolName `
-Location 'eastus' `
-HostPoolType 'Pooled' `
Expand All @@ -61,17 +61,19 @@ PS C:\> New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
-CustomRdpProperty $null `
-Ring $null `
-ValidationEnvironment:$false
```

```output
Location Name Type
-------- ---- ----
eastus HostPoolName Microsoft.DesktopVirtualization/hostpools
```

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

### Example 1: Create a Windows Virtual Desktop HostPool by name
### Example 2: Create a Windows Virtual Desktop HostPool by name
```powershell
PS C:\> New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
-Name HostPoolName `
-Location 'eastus' `
-HostPoolType 'Personal' `
Expand All @@ -89,7 +91,9 @@ PS C:\> New-AzWvdHostPool -ResourceGroupName ResourceGroupName `
-CustomRdpProperty $null `
-Ring $null `
-ValidationEnvironment:$false
```

```output
Location Name Type
-------- ---- ----
eastus HostPoolName Microsoft.DesktopVirtualization/hostpools
Expand Down
Loading