Send-RdsUserSessionMessage

参考

模块:: WindowsVirtualDesktopPowershell

将系统消息发送到用户会话。

语法

Send-RdsUserSessionMessage
    [-TenantName] <String>
    [-HostPoolName] <String>
    [-SessionHostName] <String>
    [-SessionId] <Int32>
    [-MessageTitle] <String>
    [-MessageBody] <String>
    [-NoUserPrompt]
    [<CommonParameters>]

说明

Send-RdsUserSessionmessage cmdlet 将系统消息发送到指定的用户会话。由于用户会话 ID 仅在会话主机的上下文中是唯一的，因此不同的会话主机服务器可以共享相同的用户会话 ID。使用此 cmdlet 指定的会话主机和会话 ID 唯一标识主机池中的会话。如果会话 ID 不存在，则会将消息广播到会话主机上的所有用户会话。

示例

示例 1：通过提供所有必需信息将消息发送到用户会话

PS C:\> Send-RdsUserSessionMessage -TenantName "contoso" -HostPoolName "contosoHostPool" -SessionHostName "sh1.contoso.com" -SessionId 1 -MessageTitle "Test announcement" -MessageBody "Test message."

此命令将消息发送到指定的用户会话。此命令要求你之前已查找用户会话，以提供所有必需的信息。通过在不使用 NoUserPrompt 开关的情况下运行 Send-RdsUserSessionMessage cmdlet，系统会要求确认是否发送消息。

示例 2：通过搜索用户会话向用户发送消息

PS C:\> Get-RdsUserSession -TenantName "contoso" -HostPoolName "contosoHostPool" | where { $_.UserPrincipalName -eq "contoso\user1" } | Send-RdsUserSessionMessage -MessageTitle "Test announcement" -MessageBody "Test message." -NoUserPrompt

此命令使用 Get-RdsUserSession cmdlet 搜索特定用户的会话，然后将其管道传递到 Send-RdsUserSessionMessage cmdlet，以便向用户会话发送消息。使用 NoUserPrompt 开关运行 Send-RdsUserSessionMessage cmdlet 时，不会收到确认发送消息的任何其他提示。

参数

-HostPoolName

主机池的名称。

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-MessageBody

要发送到用户会话的消息的正文。

Type:	String
Position:	5
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-MessageTitle

要发送到用户会话的消息的标题。

Type:	String
Position:	4
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

通过