Send-RdsUserSessionMessage

  • Odwołanie
Moduł:
WindowsVirtualDesktopPowershell

Wysyła komunikat systemowy do sesji użytkownika.

Składnia

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. Identyfikator hosta sesji i sesji określony przy użyciu tego polecenia cmdlet jednoznacznie identyfikuje sesję w puli hostów. Jeśli identyfikator sesji nie jest obecny, komunikat jest emitowany do wszystkich sesji użytkownika na hoście sesji 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 wyszukania 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 wiadomości.

Przykład 2. Wysyłanie wiadomości do użytkownika przez wyszukanie 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 wyszukiwania sesji określonego użytkownika, a następnie potokuje 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.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MessageBody

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

Type:String
Position:5
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MessageTitle

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

Type:String
Position:4
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NoUserPrompt

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SessionHostName

Nazwa hosta sesji.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SessionId

Identyfikator sesji korelujący z sesją użytkownika, która otrzyma komunikat.

Type:Int32
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TenantName

Nazwa dzierżawy.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Dane wejściowe

System.String

System.Int32

Dane wyjściowe

System.Object