Send-RdsUserSessionMessage

Moduł:

Microsoft.RDInfra.RDPowershell Module

Wysyła komunikat systemowy do sesji użytkownika.

Składnia

Default (Domyślna)

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

Opis

Polecenie cmdlet Send-RdsUserSessionmessage wysyła komunikat systemowy do określonej sesji użytkownika. Ponieważ identyfikator sesji użytkownika jest unikatowy tylko w kontekście hosta sesji, inny serwer hosta sesji może współużytkować ten sam identyfikator sesji użytkownika. Host sesji i identyfikator sesji określone za pomocą tego polecenia cmdlet jednoznacznie identyfikują sesję w puli hostów. Jeśli identyfikator sesji nie jest obecny, wiadomość jest emitowana do wszystkich sesji użytkowników na hoście sesji.

Przykłady

Przykład 1: Wysyłanie komunikatu do sesji użytkownika przez podanie wszystkich wymaganych informacji

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

To polecenie wysyła komunikat do określonej sesji użytkownika. To polecenie wymaga wcześniejszego sprawdzenia sesji użytkownika, aby podać wszystkie wymagane informacje. Uruchamiając polecenie cmdlet Send-RdsUserSessionMessage bez przełącznika NoUserPrompt, zostanie wyświetlony monit o potwierdzenie wysłania komunikatu.

Przykład 2: Wysyłanie wiadomości do użytkownika przez wyszukanie jego sesji użytkownika

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

To polecenie używa polecenia cmdlet Get-RdsUserSession do wyszukania sesji określonego użytkownika, a następnie przesyła je do polecenia cmdlet Send-RdsUserSessionMessage w celu wysłania komunikatu do sesji użytkownika. Uruchamiając polecenie cmdlet Send-RdsUserSessionMessage z przełącznikiem NoUserPrompt, nie otrzymasz żadnego dodatkowego monitu o potwierdzenie wysłania komunikatu.

Parametry

-HostPoolName

Nazwa puli hostów.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	1
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-MessageBody

Treść wiadomości, którą chcesz wysłać do sesji użytkownika.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	5
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-MessageTitle

Tytuł wiadomości, którą chcesz wysłać do sesji użytkownika.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	4
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-NoUserPrompt

Przełącznik wskazujący, że chcesz odłączyć użytkownika bez dodatkowego potwierdzenia.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-SessionHostName

Nazwa hosta sesji.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	2
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-SessionId

Identyfikator sesji odpowiadający sesji użytkownika, która otrzyma komunikat.

Właściwości parametru

Typ:	Int32
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	3
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-TenantName

Nazwa dzierżawy.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	0
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

System.String

System.Int32

Dane wyjściowe

System.Object