Get-AzWvdDesktop

Reference

Module:: Az.DesktopVirtualization

Get a desktop.

Syntax

Get-AzWvdDesktop
   -ApplicationGroupName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-InitialSkip <Int32>]
   [-IsDescending]
   [-PageSize <Int32>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzWvdDesktop
   -ApplicationGroupName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzWvdDesktop
   -InputObject <IDesktopVirtualizationIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get a desktop.

Examples

Example 1: Get a Windows Virtual Desktop Desktop by name

Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name DesktopName

Name                             Type
----                             ----
ApplicationGroupName/DesktopName Microsoft.DesktopVirtualization/applicationgroups/desktops

This command gets a Windows Virtual Desktop Desktop in an application Group.

Example 2: List Windows Virtual Desktop Desktops

Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName

Name                             Type
----                             ----
ApplicationGroupName/DesktopName Microsoft.DesktopVirtualization/applicationgroups/desktops

This command lists Windows Virtual Desktop Desktops in an application Group.

Parameters

-ApplicationGroupName

The name of the application group

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InitialSkip

Initial number of items to skip.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IDesktopVirtualizationIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-IsDescending

Indicates whether the collection is descending.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The name of the desktop within the specified desktop group

Type:	String
Aliases:	DesktopName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PageSize

Number of items per page.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IDesktopVirtualizationIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20231004Preview.IDesktop