Get-AzWvdSessionHost
Get a session host.
Syntax
Get-AzWvdSessionHost
-HostPoolName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-InitialSkip <Int32>]
[-IsDescending]
[-PageSize <Int32>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzWvdSessionHost
-HostPoolName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzWvdSessionHost
-Name <String>
-HostPoolInputObject <IDesktopVirtualizationIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzWvdSessionHost
-InputObject <IDesktopVirtualizationIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Description
Get a session host.
Examples
Example 1: Get a Windows Virtual Desktop SessionHost by name
Get-AzWvdSessionHost -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -Name SessionHostName
Name Type
---- ----
HostPoolName/SessionHostName Microsoft.DesktopVirtualization/hostpools/sessionhostsThis command gets a Windows Virtual Desktop SessionHost in a Host Pool.
Example 2: List Windows Virtual Desktop SessionHosts
Get-AzWvdSessionHost -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName
Name Type
---- ----
HostPoolName/SessionHostName1 Microsoft.DesktopVirtualization/hostpools/sessionhosts
HostPoolName/SessionHostName2 Microsoft.DesktopVirtualization/hostpools/sessionhostsThis command lists a Windows Virtual Desktop SessionHosts in a Host Pool.
Parameters
-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 |
-HostPoolInputObject
Identity Parameter
| Type: | IDesktopVirtualizationIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-HostPoolName
The name of the host pool within the specified resource group
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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
| 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 session host within the specified host pool
| Type: | String |
| Aliases: | SessionHostName |
| 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. The value must be an UUID.
| Type: | String[] |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
