Get-RdsHostPool

Reference

Module:: WindowsVirtualDesktopPowershell

Gets the properties of a host pool.

Syntax

Get-RdsHostPool
   [-TenantName] <String>
   [[-Name] <String>]
   [<CommonParameters>]

Description

The Get-RdsHostPool cmdlet gets the properties of the specified host pool. If you do not specify a host pool, this cmdlet returns properties for all host pools in the specified tenant authorized for the current user.

Examples

Example 1: Get all host pools in the specified tenant

PS C:\> Get-RdsHostPool -TenantName "contoso"

TenantName            : contoso
TenantGroupName       : Default Tenant Group
HostPoolName          : contosoHostPool
FriendlyName          :
Description           :
Persistent            : False
CustomRdpProperty     :
MaxSessionLimit       : 999999
LoadBalancerType      : BreadthFirst
ValdationEnv          : True
Ring                  : 
AssignmentType        : 

TenantName            : contoso
TenantGroupName       : Default Tenant Group
HostPoolName          : contosoPersonal
FriendlyName          :
Description           :
Persistent            : True
CustomRdpProperty     :
MaxSessionLimit       : 999999
LoadBalancerType      : Persistent
ValdationEnv          : True
Ring                  : 
AssignmentType        : Automatic

This command gets the properties of all host pools in the specified tenant that are authorized for the current user.

Example 2: Get a specific host pool

PS C:\> Get-RdsTenant -TenantName "contoso" -Name "contosoHostPool"

TenantName            : Contoso
TenantGroupName       : Default Tenant Group
HostPoolName          : contosoHostPool
FriendlyName          :
Description           :
Persistent            : False
CustomRdpProperty     :
MaxSessionLimit       : 999999
LoadBalancerType      : BreadthFirst
ValdationEnv          : True
Ring                  : 
AssignmentType        :

This command gets the properties of the specified host pool in the tenant. The host pool and its properties are displayed only if the host pool exists in the tenant and the current user is properly authorized.

Parameters

-Name

The name of the host pool.

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

-TenantName

The name of the tenant.

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

Inputs

System.String

Outputs

Microsoft.RDInfra.RDManagementData.RdMgmtHostPool