Send-RdsUserSessionMessage

Modul:

Microsoft.RDInfra.RDPowershell Module

Odešle systémovou zprávu relaci uživatele.

Syntaxe

Default (Výchozí)

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

Description

Rutina Send-RdsUserSessionmessage odešle systémovou zprávu do zadané uživatelské relace. Vzhledem k tomu, že ID uživatelské relace je jedinečné pouze v kontextu hostitele relace, může jiný server hostitele relace sdílet stejné ID uživatelské relace. Hostitel relace a ID relace, které zadáte pomocí této rutiny, jednoznačně identifikují relaci v rámci fondu hostitelů. Pokud ID relace není k dispozici, je zpráva odeslána do všech uživatelských relací na hostiteli relace.

Příklady

Příklad 1: Odeslání zprávy relaci uživatele poskytnutím všech požadovaných informací

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

Tento příkaz odešle zprávu na zadanou relaci uživatele. Tento příkaz vyžaduje, abyste již dříve vyhledali relaci uživatele a poskytli všechny požadované informace. Spuštěním rutiny Send-RdsUserSessionMessage bez přepínače NoUserPrompt budete požádáni o potvrzení odeslání zprávy.

Příklad 2: Odeslání zprávy uživateli vyhledáním jeho uživatelské relace

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

Tento příkaz pomocí rutiny Get-RdsUserSession vyhledá relaci konkrétního uživatele a poté ji předá do rutiny Send-RdsUserSessionMessage, aby odeslala zprávu do relace uživatele. Spuštěním rutiny Send-RdsUserSessionMessage s přepínačem NoUserPrompt se nezobrazí žádná další výzva k potvrzení odeslání zprávy.

Parametry

-HostPoolName

Název fondu hostitelů.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	1
Povinné:	True
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-MessageBody

Text zprávy, kterou chcete odeslat do uživatelské relace.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	5
Povinné:	True
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-MessageTitle

Název zprávy, kterou chcete odeslat do uživatelské relace.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	4
Povinné:	True
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-NoUserPrompt

Spínač označující, že chcete odpojit uživatele bez dalšího potvrzení.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-SessionHostName

Název hostitele relace.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	2
Povinné:	True
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-SessionId

ID relace korelující s uživatelskou relací, která obdrží zprávu.

Vlastnosti parametru

Typ:	Int32
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	3
Povinné:	True
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-TenantName

Název tenanta.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	0
Povinné:	True
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

System.String

System.Int32

Výstupy

System.Object