Send-RdsUserSessionMessage

Модуль:

Microsoft.RDInfra.RDPowershell

Отправляет системное сообщение в сеанс пользователя.

Синтаксис

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

Описание

Командлет Send-RdsUserSessionmessage отправляет системное сообщение указанному сеансу пользователя. Поскольку идентификатор сеанса пользователя уникален только в контексте узла сеансов, другой сервер узла сеансов может использовать один и тот же идентификатор сеанса пользователя. Узел сеанса и идентификатор сеанса, указанные с помощью этого командлета, однозначно идентифицируют сеанс в пуле узлов. Если идентификатор сеанса отсутствует, сообщение передается всем сеансам пользователей на узле сеанса.

Примеры

Пример 1: Отправка сообщения сеансу пользователя, предоставив всю необходимую информацию

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

Эта команда отправляет сообщение указанному сеансу пользователя. Эта команда требует, чтобы вы ранее выполнили поиск пользовательского сеанса, чтобы предоставить всю необходимую информацию. При выполнении командлета Send-RdsUserSessionMessage без переключателя NoUserPrompt вам будет предложено подтвердить отправку сообщения.

Пример 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 для поиска сеанса конкретного пользователя, а затем передает его в командлет Send-RdsUserSessionMessage для отправки сообщения сеансу пользователя. Запустив командлет Send-RdsUserSessionMessage с параметром NoUserPrompt, вы не получите никаких дополнительных запросов на подтверждение отправки сообщения.

Параметры

-HostPoolName

Имя пула узлов.

Тип:	String
Position:	1
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-MessageBody

Текст сообщения, которое вы хотите отправить сеансу пользователя.

Тип:	String
Position:	5
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-MessageTitle

Заголовок сообщения, которое вы хотите отправить сеансу пользователя.

Тип:	String
Position:	4
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-NoUserPrompt

Переключатель указывает на то, что вы хотите отключить пользователя без какого-либо дополнительного подтверждения.

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-SessionHostName

Имя узла сеанса.

Тип:	String
Position:	2
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-SessionId

Идентификатор сеанса, соответствующий сеансу пользователя, который получит сообщение.

Тип:	Int32
Position:	3
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-TenantName

Имя клиента.

Тип:	String
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

Входные данные

System.String

System.Int32

Выходные данные

System.Object