Send-RdsUserSessionMessage

Modul:: Microsoft.RDInfra.RDPowershell

Skickar ett systemmeddelande till en användarsession.

Syntax

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

Description

Cmdleten Send-RdsUserSessionmessage skickar ett systemmeddelande till en angiven användarsession. Eftersom användarens sessions-ID endast är unikt inom ramen för en sessionsvärd kan en annan sessionsvärdserver dela samma användarsessions-ID. Sessionsvärden och sessions-ID:t som du anger med hjälp av den här cmdleten identifierar unikt en session i en värdpool. Om sessions-ID:t inte finns skickas meddelandet till alla användarsessioner på sessionsvärden.

Exempel

Exempel 1: Skicka ett meddelande till en användarsession genom att ange all nödvändig information

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

Det här kommandot skickar ett meddelande till den angivna användarsessionen. Det här kommandot kräver att du har letat upp användarsessionen tidigare för att ange all nödvändig information. Genom att köra cmdleten Send-RdsUserSessionMessage utan växeln NoUserPrompt uppmanas du att bekräfta att du vill skicka meddelandet.

Exempel 2: Skicka ett meddelande till en användare genom att söka efter deras användarsession

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

Det här kommandot använder cmdleten Get-RdsUserSession för att söka efter den specifika användarens session och skickar den sedan till cmdleten Send-RdsUserSessionMessage för att skicka ett meddelande till användarsessionen. Genom att köra cmdleten Send-RdsUserSessionMessage med växeln NoUserPrompt får du ingen ytterligare uppmaning om att bekräfta att meddelandet ska skickas.

Parametrar

-HostPoolName

Namnet på värdpoolen.

Typ:	String
Position:	1
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-MessageBody

Brödtexten i det meddelande som du vill skicka till användarsessionen.

Typ:	String
Position:	5
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-MessageTitle

Titeln på det meddelande som du vill skicka till användarsessionen.

Typ:	String
Position:	4
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-NoUserPrompt

Omkopplaren som anger att du vill koppla bort användaren utan ytterligare bekräftelse.

Typ:	SwitchParameter
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-SessionHostName

Namnet på sessionsvärden.

Typ:	String
Position:	2
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-SessionId

Sessions-ID:t som korrelerar med användarsessionen som ska ta emot meddelandet.

Typ:	Int32
Position:	3
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-TenantName

Namnet på hyresgästen.

Typ:	String
Position:	0
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

Indata

System.String

System.Int32

Utdata

System.Object

Dela via