Send-RdsUserSessionMessage

Module:

Microsoft.RDInfra.RDPowershell Module

Envoie un message système à une session utilisateur.

Syntaxe

Default (Par défaut)

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

Description

L’applet de commande Send-RdsUserSessionmessage envoie un message système à une session utilisateur spécifiée. Étant donné que l’ID de session utilisateur n’est unique que dans le contexte d’un hôte de session, un autre serveur hôte de session peut partager le même ID de session utilisateur. L’hôte de session et l’ID de session que vous spécifiez à l’aide de cette applet de commande identifient de manière unique une session au sein d’un pool d’hôtes. Si l’ID de session n’est pas présent, le message est diffusé à toutes les sessions utilisateur sur l’hôte de session.

Exemples

Exemple 1 : Envoyer un message à une session utilisateur en fournissant toutes les informations requises

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

Cette commande envoie un message à la session utilisateur spécifiée. Cette commande nécessite que vous ayez préalablement recherché la session utilisateur pour fournir toutes les informations requises. En exécutant l’applet de commande Send-RdsUserSessionMessage sans le commutateur NoUserPrompt, vous êtes invité à confirmer l’envoi du message.

Exemple 2 : Envoyer un message à un utilisateur en recherchant sa session utilisateur

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

Cette commande utilise l’applet de commande Get-RdsUserSession pour rechercher la session de l’utilisateur spécifique, puis la dirige vers l’applet de commande Send-RdsUserSessionMessage pour envoyer un message à la session utilisateur. En exécutant l’applet de commande Send-RdsUserSessionMessage avec le commutateur NoUserPrompt, vous ne recevrez aucune invite supplémentaire pour confirmer l’envoi du message.

Paramètres

-HostPoolName

Nom du pool d’hôtes.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	1
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	True
Valeur des arguments restants:	False

-MessageBody

Corps du message que vous souhaitez envoyer à la session utilisateur.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	5
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	True
Valeur des arguments restants:	False

-MessageTitle

Titre du message que vous souhaitez envoyer à la session utilisateur.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	4
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	True
Valeur des arguments restants:	False

-NoUserPrompt

Le commutateur indiquant que vous souhaitez déconnecter l’utilisateur sans aucune confirmation supplémentaire.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-SessionHostName

Nom de l’hôte de la session.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	2
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	True
Valeur des arguments restants:	False

-SessionId

ID de session correspondant à la session utilisateur qui recevra le message.

Propriétés du paramètre

Type:	Int32
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	3
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	True
Valeur des arguments restants:	False

-TenantName

Nom du client.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	0
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	True
Valeur des arguments restants:	False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

System.String

System.Int32

Sorties

System.Object