Send-RdsUserSessionMessage

Modul:
Microsoft.RDInfra.RDPowershell Module

Rendszerüzenetet küld egy felhasználói munkamenetnek.

Syntax

Default (Alapértelmezett) 

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

Description

A Send-RdsUserSessionmessage parancsmag rendszerüzenetet küld egy megadott felhasználói munkamenetnek. Mivel a felhasználói munkamenet-azonosító csak a munkamenetgazda környezetében egyedi, egy másik munkamenetgazda-kiszolgáló is megoszthatja ugyanazt a felhasználói munkamenet-azonosítót. A parancsmag használatával megadott munkamenetgazda és munkamenet-azonosító egyedileg azonosítja a munkamenetet a gazdagépkészleten belül. Ha a munkamenet-azonosító nincs jelen, akkor az üzenet a munkamenetgazda összes felhasználói munkamenetére megjelenik.

Példák

1. példa: Üzenet küldése felhasználói munkamenetnek az összes szükséges információ megadásával

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

Ez a parancs üzenetet küld a megadott felhasználói munkamenetnek. Ehhez a parancshoz előzőleg meg kell keresnie a felhasználói munkamenetet, hogy megadja az összes szükséges információt. Ha a Send-RdsUserSessionMessage parancsmagot a NoUserPrompt kapcsoló nélkül futtatja, a rendszer megkéri, hogy erősítse meg az üzenet elküldését.

2. példa: Üzenet küldése egy felhasználónak a felhasználói munkamenet keresésével

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

Ez a parancs a Get-RdsUserSession parancsmaggal keresi meg az adott felhasználó munkamenetét, majd átirányítja a Send-RdsUserSessionMessage parancsmagba, hogy üzenetet küldjön a felhasználói munkamenetnek. Ha a Send-RdsUserSessionMessage parancsmagot a NoUserPrompt kapcsolóval futtatja, nem kap további kérést az üzenet elküldésének megerősítésére.

Paraméterek

-HostPoolName

A gazdagépkészlet neve.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:1
Kötelező:True
Folyamatból származó érték:True
Folyamatból származó érték tulajdonságnév alapján:True
Fennmaradó argumentumokból származó érték:False

-MessageBody

A felhasználói munkamenetnek elküldeni kívánt üzenet törzse.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:5
Kötelező:True
Folyamatból származó érték:True
Folyamatból származó érték tulajdonságnév alapján:True
Fennmaradó argumentumokból származó érték:False

-MessageTitle

A felhasználói munkamenetnek küldeni kívánt üzenet címe.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:4
Kötelező:True
Folyamatból származó érték:True
Folyamatból származó érték tulajdonságnév alapján:True
Fennmaradó argumentumokból származó érték:False

-NoUserPrompt

A kapcsoló, amely jelzi, hogy további megerősítés nélkül le szeretné választani a felhasználót.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-SessionHostName

A munkamenetgazda neve.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:2
Kötelező:True
Folyamatból származó érték:True
Folyamatból származó érték tulajdonságnév alapján:True
Fennmaradó argumentumokból származó érték:False

-SessionId

Az üzenetet fogadó felhasználói munkamenethez kapcsolódó munkamenet-azonosító.

Paramétertulajdonságok

Típus:Int32
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:3
Kötelező:True
Folyamatból származó érték:True
Folyamatból származó érték tulajdonságnév alapján:True
Fennmaradó argumentumokból származó érték:False

-TenantName

A bérlő neve.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:0
Kötelező:True
Folyamatból származó érték:True
Folyamatból származó érték tulajdonságnév alapján:True
Fennmaradó argumentumokból származó érték:False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Bevitelek

System.String

System.Int32

Kimenetek

System.Object