Disconnect-RdsUserSession
斷開使用者與其當前活動會話的連接。
語法
Default (預設值)
Disconnect-RdsUserSession
[-TenantName] <String>
[-HostPoolName] <String>
[-SessionHostName] <String>
[-SessionId] <Int32>
[-NoUserPrompt]
[<CommonParameters>]
Description
Disconnect-RdsUserSession cmdlet 斷開使用者與在指定工作階段主機上運行的當前活動作業階段的連接。 使用者未註銷，因此所有應用程式將繼續運行。 用戶可以通過在遠端桌面用戶端中再次啟動連接來重新連接到其會話。
範例
範例 1：透過提供所有必需的資訊斷開用戶連接
PS C:\> Disconnect-RdsUserSession -TenantName "contoso" -HostPoolName "contosoHostPool" -SessionHostName "sh1.contoso.com" -SessionId 1
此命令將斷開與提供的會話 ID 關聯的指定工作階段主機上的用戶連接。 此命令要求您之前已查找用戶會話，以提供所有必需的資訊。 如果在沒有 NoUserPrompt 開關的情況下運行 Disconnect-RdsUserSession cmdlet，系統將要求您確認斷開用戶連接。
範例 2：通過搜索使用者會話來斷開用戶連接
PS C:\> Get-RdsUserSession -TenantName "contoso" -HostPoolName "contosoHostPool" | where { $_.UserPrincipalName -eq "contoso\user1" } | Disconnect-RdsUserSession -NoUserPrompt
此命令使用 Get-RdsUserSession cmdlet 搜尋特定使用者的工作階段，然後將其通過管道傳輸到 Disconnect-RdsUserSession cmdlet 以斷開用戶連接。 通過使用 NoUserPrompt 開關運行 Disconnect-RdsUserSession cmdlet，您將不會收到任何其他提示以確認斷開用戶連接。
參數
-HostPoolName
主機池的名稱。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-NoUserPrompt
指示您希望斷開用戶連接而無需任何其他確認的開關。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-SessionHostName
會話主機的名稱。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 2 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-SessionId
與要斷開連接的使用者關聯的會話ID。
參數屬性
| 類型: | Int32 |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 3 |
| 必要: | 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。