< Back
Set-RdsHostPool
Post
NAME Set-RdsHostPool
SYNTAX
Set-RdsHostPool [-TenantName] <string> [-Name] <string> [-FriendlyName <string>] [-Description <string>]
[-MaxSessionLimit <int>] [-ValidationEnv <bool>] [-AssignmentType {Automatic | Direct}] [<CommonParameters>]
Set-RdsHostPool [-TenantName] <string> [-Name] <string> [-BreadthFirstLoadBalancer] [-MaxSessionLimit <int>]
[-ValidationEnv <bool>] [-AssignmentType {Automatic | Direct}] [<CommonParameters>]
Set-RdsHostPool [-TenantName] <string> [-Name] <string> -DepthFirstLoadBalancer -MaxSessionLimit <int>
[-ValidationEnv <bool>] [-AssignmentType {Automatic | Direct}] [<CommonParameters>]
Set-RdsHostPool [-TenantName] <string> [-Name] <string> [-CustomRdpProperty <string>] [-ValidationEnv <bool>]
[-AssignmentType {Automatic | Direct}] [<CommonParameters>]
Set-RdsHostPool [-TenantName] <string> [-Name] <string> [-ValidationEnv <bool>] [-Ring <int>] [-AssignmentType
{Automatic | Direct}] [<CommonParameters>]
PARAMETERS
-AssignmentType <PersonalDesktopAssignmentType>
AssignmentType to set.
Required? false
Position? Named
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
-BreadthFirstLoadBalancer
Uses breadth first load balancer.
Required? false
Position? Named
Accept pipeline input? false
Parameter set name HP5
Aliases None
Dynamic? false
-CustomRdpProperty <string>
Create CustomRdpProperty. Types: i (integer) s (string) b (byte array). Must be in the form of:
name:type:value. NOTE: Sending a plain empty string will clear all CustomRdpProperties from the host pool.
Required? false
Position? Named
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name HP3
Aliases None
Dynamic? false
-DepthFirstLoadBalancer
Uses depth first load balancer.
Required? true
Position? Named
Accept pipeline input? false
Parameter set name HP6
Aliases None
Dynamic? false
-Description <string>
Description of HostPool.
Required? false
Position? Named
Accept pipeline input? false
Parameter set name HP4
Aliases None
Dynamic? false
-FriendlyName <string>
FriendlyName of HostPool.
Required? false
Position? Named
Accept pipeline input? false
Parameter set name HP4
Aliases None
Dynamic? false
-MaxSessionLimit <int>
MaxSessionLimit value.
Required? false
Position? Named
Accept pipeline input? false
Parameter set name HP4, HP5, HP6
Aliases None
Dynamic? false
-Name <string>
Name of HostPool.
Required? true
Position? 1
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases HostPoolName
Dynamic? false
-Ring <int>
Ring to set.
Required? false
Position? Named
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name HP8
Aliases None
Dynamic? false
-TenantName <string>
Name of Tenant.
Required? true
Position? 0
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
-ValidationEnv <bool>
Whether the environment is a validation environment or not.
Required? false
Position? Named
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
System.Nullable`1[[Microsoft.RDInfra.Shared.Common.Enums.PersonalDesktopAssignmentType,
Microsoft.RDInfra.Shared.Common.Enums, Version=1.0.1535.0, Culture=neutral, PublicKeyToken=99498ce06f56ba9d]]
OUTPUTS
Microsoft.RDInfra.RDManagementData.RdMgmtHostPool
ALIASES
None
REMARKS
None
SYNTAX
Set-RdsHostPool [-TenantName] <string> [-Name] <string> [-FriendlyName <string>] [-Description <string>]
[-MaxSessionLimit <int>] [-ValidationEnv <bool>] [-AssignmentType {Automatic | Direct}] [<CommonParameters>]
Set-RdsHostPool [-TenantName] <string> [-Name] <string> [-BreadthFirstLoadBalancer] [-MaxSessionLimit <int>]
[-ValidationEnv <bool>] [-AssignmentType {Automatic | Direct}] [<CommonParameters>]
Set-RdsHostPool [-TenantName] <string> [-Name] <string> -DepthFirstLoadBalancer -MaxSessionLimit <int>
[-ValidationEnv <bool>] [-AssignmentType {Automatic | Direct}] [<CommonParameters>]
Set-RdsHostPool [-TenantName] <string> [-Name] <string> [-CustomRdpProperty <string>] [-ValidationEnv <bool>]
[-AssignmentType {Automatic | Direct}] [<CommonParameters>]
Set-RdsHostPool [-TenantName] <string> [-Name] <string> [-ValidationEnv <bool>] [-Ring <int>] [-AssignmentType
{Automatic | Direct}] [<CommonParameters>]
PARAMETERS
-AssignmentType <PersonalDesktopAssignmentType>
AssignmentType to set.
Required? false
Position? Named
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
-BreadthFirstLoadBalancer
Uses breadth first load balancer.
Required? false
Position? Named
Accept pipeline input? false
Parameter set name HP5
Aliases None
Dynamic? false
-CustomRdpProperty <string>
Create CustomRdpProperty. Types: i (integer) s (string) b (byte array). Must be in the form of:
name:type:value. NOTE: Sending a plain empty string will clear all CustomRdpProperties from the host pool.
Required? false
Position? Named
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name HP3
Aliases None
Dynamic? false
-DepthFirstLoadBalancer
Uses depth first load balancer.
Required? true
Position? Named
Accept pipeline input? false
Parameter set name HP6
Aliases None
Dynamic? false
-Description <string>
Description of HostPool.
Required? false
Position? Named
Accept pipeline input? false
Parameter set name HP4
Aliases None
Dynamic? false
-FriendlyName <string>
FriendlyName of HostPool.
Required? false
Position? Named
Accept pipeline input? false
Parameter set name HP4
Aliases None
Dynamic? false
-MaxSessionLimit <int>
MaxSessionLimit value.
Required? false
Position? Named
Accept pipeline input? false
Parameter set name HP4, HP5, HP6
Aliases None
Dynamic? false
-Name <string>
Name of HostPool.
Required? true
Position? 1
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases HostPoolName
Dynamic? false
-Ring <int>
Ring to set.
Required? false
Position? Named
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name HP8
Aliases None
Dynamic? false
-TenantName <string>
Name of Tenant.
Required? true
Position? 0
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
-ValidationEnv <bool>
Whether the environment is a validation environment or not.
Required? false
Position? Named
Accept pipeline input? true (ByValue, ByPropertyName)
Parameter set name (All)
Aliases None
Dynamic? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
System.Nullable`1[[Microsoft.RDInfra.Shared.Common.Enums.PersonalDesktopAssignmentType,
Microsoft.RDInfra.Shared.Common.Enums, Version=1.0.1535.0, Culture=neutral, PublicKeyToken=99498ce06f56ba9d]]
OUTPUTS
Microsoft.RDInfra.RDManagementData.RdMgmtHostPool
ALIASES
None
REMARKS
None