Send-RdsUserSessionMessage

Envia uma mensagem do sistema para uma sessão de usuário.

Sintaxe

Default (Predefinição)

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

Description

O cmdlet Send-RdsUserSessionmessage envia uma mensagem do sistema para uma sessão de usuário especificada. Como o ID de sessão do usuário é exclusivo apenas no contexto de um host de sessão, um servidor de host de sessão diferente pode compartilhar o mesmo ID de sessão do usuário. O host da sessão e a ID da sessão que você especifica usando esse cmdlet identificam exclusivamente uma sessão dentro de um pool de hosts. Se o ID da sessão não estiver presente, a mensagem será transmitida para todas as sessões do usuário no host da sessão.

Exemplos

Exemplo 1: Enviar uma mensagem para uma sessão de usuário fornecendo todas as informações necessárias

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

Este comando envia uma mensagem para a sessão de usuário especificada. Este comando requer que você tenha pesquisado a sessão do usuário anteriormente para fornecer todas as informações necessárias. Ao executar o cmdlet Send-RdsUserSessionMessage sem a opção NoUserPrompt, você será solicitado a confirmar o envio da mensagem.

Exemplo 2: Enviar uma mensagem a um utilizador pesquisando a sua sessão de utilizador

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 o cmdlet Get-RdsUserSession para procurar a sessão do usuário específico e, em seguida, canaliza-o para o cmdlet Send-RdsUserSessionMessage para enviar uma mensagem à sessão do usuário. Ao executar o cmdlet Send-RdsUserSessionMessage com a opção NoUserPrompt, você não receberá nenhum prompt adicional para confirmar o envio da mensagem.

Parâmetros

-HostPoolName

O nome do pool de hosts.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:1
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-MessageBody

O corpo da mensagem que você deseja enviar para a sessão do usuário.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:5
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-MessageTitle

O título da mensagem que você deseja enviar para a sessão do usuário.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:4
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-NoUserPrompt

O interruptor indica que você gostaria de desconectar o usuário sem qualquer confirmação adicional.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-SessionHostName

O nome do host da sessão.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:2
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-SessionId

O ID da sessão correlacionado à sessão do usuário que receberá a mensagem.

Propriedades dos parâmetros

Tipo:Int32
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:3
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-TenantName

O nome do inquilino.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

System.String

System.Int32

Saídas

System.Object