Set-RdsHostPool
語法
HP4 (預設值)
Set-RdsHostPool
[-TenantName] <String>
[-Name] <String>
[-FriendlyName <String>]
[-Description <String>]
[-MaxSessionLimit <Int32>]
[-ValidationEnv <bool>]
[<CommonParameters>]
HP5
Set-RdsHostPool
[-TenantName] <String>
[-Name] <String>
[-BreadthFirstLoadBalancer]
[-MaxSessionLimit <Int32>]
[-ValidationEnv <bool>]
[<CommonParameters>]
HP6
Set-RdsHostPool
[-TenantName] <String>
[-Name] <String>
-MaxSessionLimit <Int32>
[-DepthFirstLoadBalancer]
[-ValidationEnv <bool>]
[<CommonParameters>]
HP3
Set-RdsHostPool
[-TenantName] <String>
[-Name] <String>
[-CustomRdpProperty <String>]
[-ValidationEnv <bool>]
[<CommonParameters>]
HP7
Set-RdsHostPool
[-TenantName] <String>
[-Name] <String>
[-ValidationEnv <bool>]
[-Ring <int>]
[<CommonParameters>]
Description
Set-RdsHostPool cmdlet 設置指定主機池的屬性。 此 cmdlet 存在三個參數集。 First 用於禁用使用者配置檔磁碟。 第二個用於啟用使用者配置檔磁碟。 第三個選項用於設置主機池的所有其他屬性。
範例
示例 1：將主機池設置為使用深度優先負載均衡
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoHostPool" -DepthFirstLoadBalancer -MaxSessionLimit 10
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoHostPool
FriendlyName :
Description :
Persistent : False
CustomRdpProperty :
MaxSessionLimit : 10
LoadBalancerType : DepthFirst
ValidationEnv : False
Ring :
AssignmentType :
此命令將主機池設置為使用深度優先負載均衡，以便所有傳入使用者都將被定向到特定會話主機，直到達到 MaxSessionLimit（在此示例中指定為 10）。 在設置深度優先負載均衡時，需要 MaxSessionLimit 參數，因為在第一個會話主機上達到此會話限制之前，連接不會分發到後續會話主機。
示例 2：將主機池設置為使用廣度優先負載均衡
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoHostPool" -BreadthFirstLoadBalancer
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoHostPool
FriendlyName :
Description :
Persistent : False
CustomRdpProperty :
MaxSessionLimit : 10
LoadBalancerType : BreadthFirst
ValidationEnv : False
Ring :
AssignmentType :
此命令將主機池設置為使用廣度優先負載均衡，以便傳入使用者將在主機池中的會話主機之間均勻定向。 MaxSessionLimit 參數是可選的，因為廣度優先模式下的負載均衡比深度優先模式下的負載均衡限制更少。
範例 3：將主機池設置為驗證環境
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoHostPool" -ValidationEnv $true
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoHostPool
FriendlyName :
Description :
Persistent : False
CustomRdpProperty : use multimon:i:0;
MaxSessionLimit : 10
LoadBalancerType : BreadthFirst
ValidationEnv : True
Ring :
AssignmentType :
此命令將主機池設置為驗證主機池。 驗證主機池將以更快的節奏接收服務更新，從而允許您在將任何服務更改廣泛部署到生產環境中之前對其進行測試。
範例 4：將主機池設置為使用直接分配
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoPersonalDesktops" -AssignmentType Direct
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoPersonalDesktops
FriendlyName :
Description :
Persistent : True
CustomRdpProperty :
MaxSessionLimit : 999999
LoadBalancerType : Persistent
ValidationEnv : False
Ring :
AssignmentType : Direct
此命令將主機池設置為使用直接分配來確定要分配用戶的個人桌面會話主機。 使用直接分配時，必須先將使用者分配到會話主機，然後才能連接到主機池。
範例 5：將主機池設置為使用自動分配
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoPersonalDesktops" -AssignmentType Automatic
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoPersonalDesktops
FriendlyName :
Description :
Persistent : True
CustomRdpProperty :
MaxSessionLimit : 999999
LoadBalancerType : Persistent
ValidationEnv : False
Ring :
AssignmentType : Automatic
此命令將主機池設置為使用自動分配來確定要分配用戶的個人桌面會話主機。 使用自動分配時，無需在連接到主機池之前將使用者分配到會話主機。
範例 4：將主機池設置為使用直接分配
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoPersonalDesktops" -AssignmentType Direct
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoPersonalDesktops
FriendlyName :
Description :
Persistent : True
CustomRdpProperty :
MaxSessionLimit : 999999
LoadBalancerType : Persistent
ValidationEnv : False
Ring :
AssignmentType : Direct
此命令將主機池設置為使用直接分配來確定要分配用戶的個人桌面會話主機。 使用直接分配時，必須先將使用者分配到會話主機，然後才能連接到主機池。
範例 5：將主機池設置為使用自動分配
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoPersonalDesktops" -AssignmentType Automatic
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoPersonalDesktops
FriendlyName :
Description :
Persistent : True
CustomRdpProperty :
MaxSessionLimit : 999999
LoadBalancerType : Persistent
ValidationEnv : False
Ring :
AssignmentType : Automatic
此命令將主機池設置為使用自動分配來確定要分配用戶的個人桌面會話主機。 使用自動分配時，無需在連接到主機池之前將使用者分配到會話主機。
參數
-AssignmentType
個人桌面主機池的分配類型：
- Automatic，這意味著使用者將在首次連接到主機池時自動分配會話主機。
- Direct，這意味著必須先將使用者直接分配到池中的會話主機，然後才能進行連接。
參數屬性
| 類型: | PersonalDesktopAssignmentType
|
| 預設值: | None |
| 接受的值: | Automatic, Direct |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-BreadthFirstLoadBalancer
切換以啟用主機池的廣度優先負載均衡。 Breadth-first 表示新用戶會話被定向到用戶會話數最少的會話主機。
參數屬性
| 類型: | SwitchParameter
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
HP5
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-CustomRdpProperty
指定要包含在此集合中發佈的所有 RemoteApp 程式和遠端桌面的 .rdp 檔案中的遠端桌面協定 （RDP） 設置。 有關更多資訊，請參閱 支援的遠端桌面 RDP 檔設置 。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
HP3
| Position: | Named |
| 必要: | False |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-DepthFirstLoadBalancer
切換以啟用主機池的深度優先負載均衡。 Depth-first 表示新用戶會話將定向到具有最高用戶會話數但尚未達到其最大會話限制的會話主機。
參數屬性
| 類型: | SwitchParameter
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
HP6
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Description
主機池的描述。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
HP4
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-FriendlyName
要顯示的主機池的友好名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
HP4
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-MaxSessionLimit
主機池中每個會話主機允許的最大會話數。 當為負載均衡設置深度優先模式時，此值用於確定何時停止將用戶負載均衡到一台主機，並開始將用戶發送到下一台主機。
參數屬性
| 類型: | Int32
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
HP4
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
HP5
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
主機池的名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | HostPool名稱 |
參數集
(All)
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-TenantName
租用戶的名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 0 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-ValidationEnv
一個布爾值，指示是否應將主機池視為驗證主機池。 驗證主機池以比非驗證主機池更快的節奏接收服務更新，從而允許您在將服務更改廣泛部署到生產環境之前對其進行測試。
參數屬性
| 類型: | String
|
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。
System.String
輸出
Microsoft.RDInfra.RDManagementData.RdMgmtHostPool