New-RdsHostPool
Creates a host pool.
Syntax
Default (Default)
New-RdsHostPool
[-TenantName] <String>
[-Name] <String>
[-ValidationEnv <bool>]
[-Ring <int>]
[-Description <String>]
[-FriendlyName <String>]
[-Persistent]
[<CommonParameters>]
Description
Creates a host pool within a tenant. The host pool contains one or more session hosts where users can connect to run programs, save files, and use resources on those hosts.
At creation time, you can decide to create a persistent host pool by using the persistent flag. By making a persistent host pool, the user will always connect to the same session host for their sessions. If you do not use this flag, a pooled host pool is created. In a pooled host pool, users are connected to a session host in the pool that is dynamically selected by the load balancer.
Examples
Example 1: Create a pooled host pool
PS C:\> New-RdsHostPool -TenantName "contoso" -Name "contosoHostPool"
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoHostPool
FriendlyName :
Description :
Persistent : False
CustomRdpProperty :
MaxSessionLimit : 999999
LoadBalancerType : BreadthFirst
ValidationEnv : False
Ring :
AssignmentType :
This command creates a new pooled host pool in the specified tenant. The host pool comes populated with some pre-defined values. To change these values, run the Set-RdsHostPool cmdlet.
Example 2: Create a personal desktop host pool
PS C:\> New-RdsHostPool -TenantName "contoso" -Name "contosoPersonal" -Persistent
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoPersonal
FriendlyName :
Description :
Persistent : True
CustomRdpProperty :
MaxSessionLimit : 999999
LoadBalancerType : Persistent
ValidationEnv : False
Ring :
AssignmentType : Automatic
This command creates a new personal desktop host pool in the specified tenant. If you do not provide the assignment type when running the command, the personal desktop host pool will be set to automatic assignment. To change the assignment type or any other property for the host pool, run the Set-RdsHostPool cmdlet.
Example 3: Create a validation host pool
PS C:\> New-RdsHostPool -TenantName "contoso" -Name "contosoValidation" -ValidationEnv $true
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoValidation
FriendlyName :
Description :
Persistent : False
CustomRdpProperty :
MaxSessionLimit : 999999
LoadBalancerType : Persistent
ValidationEnv : True
Ring :
AssignmentType : Automatic
This command creates a new pooled, validation host pool in the specified tenant. The validation host pool will receive service updates at a faster cadence, allowing you to test any service changes before they are deployed broadly in production. To change the host pool so it is no longer a validation host pool, run the Set-RdsHostPool cmdlet.
Parameters
-AssignmentType
The assignment type for the personal desktop host pool:
- Automatic, meaning users will be automatically assigned a session host on their first connection to the host pool.
- Direct, meaning users must be directly assigned to a session host in the pool before they can connect.
Parameter properties
| Type: | PersonalDesktopAssignmentType |
| Default value: | None |
| Accepted values: | Automatic, Direct |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Description
A 512 character string that describes the HostPool to help administrators. Any character is allowed.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FriendlyName
A 256 character string that is intended for display to end users. Any character is allowed.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| 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 host pool, which must be unique in the tenant.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | HostPoolName |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Persistent
A switch indicating to mark the host pool as persistent.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| 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 |
-ValidationEnv
A boolean indicating if the host pool should be treated as a validation host pool. Validation host pools receive service updates at a faster cadence than non-validation host pools, allowing you to test service changes before they are deployed broadly to production.
Parameter properties
| Type: | String |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| 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.