Disconnect-RdsUserSession

参考

模块:: WindowsVirtualDesktopPowershell

断开用户与其当前活动会话的连接。

语法

Disconnect-RdsUserSession
          [-TenantName] <String>
          [-HostPoolName] <String>
          [-SessionHostName] <String>
          [-SessionId] <Int32>
          [-NoUserPrompt]
          [<CommonParameters>]

说明

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
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

通过