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

主机池的名称。

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

通过