Remove-RdsSessionHost
從主機池中刪除會話主機。
語法
Default (預設值)
Remove-RdsSessionHost
[-TenantName] <String>
[-HostPoolName] <String>
[-Name] <String>
[-Force]
[<CommonParameters>]
Description
Remove-RdsSessionHost cmdlet 從主機池中刪除已註冊的會話主機。 要將會話主機重新註冊到主機池，必須使用該主機池的有效註冊資訊重新安裝代理。
如果會話主機具有活動用戶會話，則此命令將失敗。 若要完成會話主機的刪除，必須首先使用 Invoke-RdsUserSessionLogoff cmdlet 從會話主機註銷所有使用者，或使用 Force 參數重新運行 Remove-RdsSessionHost cmdlet。
運行此命令以從持久主機池中刪除會話主機時，使用者分配也會被刪除。 這是將使用者重新分配到持久主機池中的新會話主機的唯一方法。
範例
範例 1：刪除沒有活動工作階段的工作階段主機
PS C:\> Remove-RdsSessionhost -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "sh1.contoso.com"
此命令從主機池中刪除會話主機。 通過運行不帶 Force 開關的 Remove-RdsSessionHost cmdlet，僅當指定的會話主機上沒有活動會話時，它才會成功。 若要強制用戶註銷會話主機，可以運行 Invoke-RdsUserSessionLogoff cmdlet。
範例 2：使用強制開關刪除工作階段主機
PS C:\> Remove-RdsSessionhost -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "sh1.contoso.com" -Force
此命令從主機池中刪除會話主機。 通過使用 Force 開關運行 Remove-RdsSessionHost cmdlet，會話主機將立即從資料庫中刪除，同時還會刪除使用者會話資訊。 這不會自動註銷使用者，如果在執行註銷之前意外斷開了與會話的連接，則可能會導致使用者丟失其會話狀態。
參數
-Force
強制刪除會話主機，即使會話主機中包含用戶會話物件。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-HostPoolName
HostPool 名稱。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Name
SessionHost 名稱。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | SessionHostName |
參數集
(All)
| Position: | 2 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-TenantName
租戶名稱。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 0 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。