Invoke-RdsUserSessionLogoff

参考

模块:: WindowsVirtualDesktopPowershell

从当前活动会话中注销用户。

语法

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

指示要注销用户并从数据库中删除会话的开关，即使服务无法访问会话主机也是如此。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-HostPoolName

主机池的名称。

类型:	String
Position:	1
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-NoUserPrompt

该开关指示你希望注销用户，而无需进行任何其他确认。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SessionHostName

会话主机的名称。

类型:	String
Position:	2
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-SessionId

与要注销的用户关联的会话 ID。

类型:	Int32
Position:	3
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-TenantName

租户的名称。

类型:	String
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

输入

System.String

System.Int32

输出

System.Object

通过