Get-AzWvdSessionHost
Syntax
List (Default)
Get-AzWvdSessionHost
-HostPoolName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-InitialSkip <Int32>]
[-IsDescending]
[-PageSize <Int32>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzWvdSessionHost
-HostPoolName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentityHostPool
Get-AzWvdSessionHost
-Name <String>
-HostPoolInputObject <IDesktopVirtualizationIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
Get-AzWvdSessionHost
-InputObject <IDesktopVirtualizationIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
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/sessionhosts
This 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/sessionhosts
This 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.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentityHostPool
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-HostPoolName
The name of the host pool within the specified resource group
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-InitialSkip
Initial number of items to skip.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-IsDescending
Indicates whether the collection is descending.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the session host within the specified host pool
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: SessionHostName
Parameter sets
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityHostPool
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PageSize
Number of items per page.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
The value must be an UUID.
Parameter properties
Type: String [ ]
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
