Get-RdsHostPool
Gets the properties of a host pool.
Syntax
Default (Default)
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | HostPoolName |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-TenantName
The name of the tenant.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| 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.