Send-RdsUserSessionMessage

Módulo:
Microsoft.RDInfra.RDPowershell Module

Envía un mensaje del sistema a una sesión de usuario.

Sintaxis

Default (Es el valor predeterminado). 

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

Description

El cmdlet Send-RdsUserSessionmessage envía un mensaje del sistema a una sesión de usuario especificada. Dado que el ID de sesión de usuario solo es único en el contexto de un host de sesión, un servidor de host de sesión diferente puede compartir el mismo ID de sesión de usuario. El host de sesión y el identificador de sesión que especifique mediante este cmdlet identifican de forma única una sesión dentro de un grupo de hosts. Si el ID de sesión no está presente, el mensaje se transmite a todas las sesiones de usuario en el host de sesión.

Ejemplos

Ejemplo 1: Enviar un mensaje a una sesión de usuario proporcionando toda la información necesaria

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

Este comando envía un mensaje a la sesión de usuario especificada. Este comando requiere que haya buscado la sesión de usuario previamente para proporcionar toda la información requerida. Al ejecutar el cmdlet Send-RdsUserSessionMessage sin el modificador NoUserPrompt, se le pedirá que confirme el envío del mensaje.

Ejemplo 2: Enviar un mensaje a un usuario buscando su sesión de usuario

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

Este comando usa el cmdlet Get-RdsUserSession para buscar la sesión del usuario específico y, a continuación, lo canaliza al cmdlet Send-RdsUserSessionMessage para enviar un mensaje a la sesión de usuario. Al ejecutar el cmdlet Send-RdsUserSessionMessage con el modificador NoUserPrompt, no recibirá ningún mensaje adicional para confirmar el envío del mensaje.

Parámetros

-HostPoolName

Nombre del grupo de hosts.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:1
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-MessageBody

El cuerpo del mensaje que desea enviar a la sesión de usuario.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:5
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-MessageTitle

El título del mensaje que desea enviar a la sesión de usuario.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:4
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-NoUserPrompt

El interruptor que indica que desea desconectar al usuario sin ninguna confirmación adicional.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-SessionHostName

El nombre del host de la sesión.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:2
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-SessionId

El ID de sesión que se correlaciona con la sesión de usuario que recibirá el mensaje.

Propiedades del parámetro

Tipo:Int32
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:3
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-TenantName

El nombre del inquilino.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:0
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

System.String

System.Int32

Salidas

System.Object