Send-RdsUserSessionMessage
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ändarsessions-ID:t bara är unikt inom kontexten 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 den här cmdleten identifierar unikt en session i en värdpool. Om sessions-ID:t inte finns sänds 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 tillhandahålla all nödvändig information. Genom att köra Send-RdsUserSessionMessage-cmdleten utan NoUserPrompt-växeln uppmanas du att bekräfta att meddelandet skickas.
Exempel 2: Skicka ett meddelande till en användare genom att söka efter användarsessionen
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 Send-RdsUserSessionMessage-cmdleten med NoUserPrompt-växeln får du ingen ytterligare uppmaning om att bekräfta att meddelandet ska skickas.
Parametrar
-HostPoolName
Namnet på värdpoolen.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-MessageBody
Brödtexten i det meddelande som du vill skicka till användarsessionen.
Type: | String |
Position: | 5 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-MessageTitle
Rubriken på det meddelande som du vill skicka till användarsessionen.
Type: | String |
Position: | 4 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NoUserPrompt
Växeln som anger att du vill koppla från användaren utan ytterligare bekräftelse.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SessionHostName
Namnet på sessionsvärden.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SessionId
Sessions-ID:t som korrelerar till användarsessionen som ska ta emot meddelandet.
Type: | Int32 |
Position: | 3 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TenantName
Namnet på klientorganisationen.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Indata
System.String
System.Int32
Utdata
System.Object