Invoke-RdsUserSessionLogoff
語法
Default (預設值)
Invoke-RdsUserSessionLogoff
[-TenantName] <String>
[-HostPoolName] <String>
[-SessionHostName] <String>
[-SessionId] <Int32>
[-NoUserPrompt]
[-Force]
[<CommonParameters>]
Description
Invoke-RdsUserSessionLogoff 註銷使用者當前在指定工作階段主機上運行的活動工作階段。 由於使用者已註銷，因此所有應用程式都將被終止，如果使用者或應用程式未保存打開的檔，則可能會丟失資料。
範例
示例 1：通過提供所有必需的資訊註銷使用者
PS C:\> Invoke-RdsUserSessionLogoff -TenantName "contoso" -HostPoolName "contosoHostPool" -SessionHostName "sh1.contoso.com" -SessionId 1
此命令註銷與提供的會話 ID 關聯的指定會話主機上的使用者。 此命令要求您之前已查找用戶會話，以提供所有必需的資訊。 如果在沒有 NoUserPrompt 開關的情況下運行 Invoke-RdsUserSessionLogoff cmdlet，系統將要求您確認註銷使用者。
範例 2：通過搜索使用者會話來註銷使用者
PS C:\> Get-RdsUserSession -TenantName "contoso" -HostPoolName "contosoHostPool" | where { $_.UserPrincipalName -eq "contoso\user1" } | Invoke-RdsUserSessionLogoff -NoUserPrompt
此命令使用 Get-RdsUserSession cmdlet 搜尋特定使用者的工作階段，然後將其通過管道傳輸到 Invoke-RdsUserSessionLogoff cmdlet 以註銷使用者。 通過使用 NoUserPrompt 開關運行 Invoke-RdsUserSessionLogoff cmdlet，您將不會收到任何其他提示以確認註銷使用者。
參數
-Force
指示您希望註銷使用者並從資料庫中刪除會話的開關，即使服務無法訪問會話主機。
參數屬性
| 類型: | SwitchParameter
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-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。
System.String
System.Int32
輸出
System.Object