Invoke-RdsUserSessionLogoff
从用户的当前活动会话中注销用户。
语法
Invoke-RdsUserSessionLogoff
[-TenantName] <String>
[-HostPoolName] <String>
[-SessionHostName] <String>
[-SessionId] <Int32>
[-NoUserPrompt]
[-Force]
[<CommonParameters>]
说明
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
指示要注销用户并从数据库中删除会话的开关,即使服务无法访问会话主机也是如此。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HostPoolName
主机池的名称。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NoUserPrompt
开关指示你希望在不进行任何其他确认的情况下注销用户。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SessionHostName
会话主机的名称。
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SessionId
与要注销的用户相关的会话 ID。
Type: | Int32 |
Position: | 3 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TenantName
租户的名称。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
输入
System.String
System.Int32
输出
System.Object