Send-RdsUserSessionMessage

Modul:

Microsoft.RDInfra.RDPowershell Module

Skickar ett systemmeddelande till en användarsession.

Syntax

Default (Standard)

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ändarens sessions-ID endast är unikt inom ramen 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 hjälp av den här cmdleten identifierar unikt en session i en värdpool. Om sessions-ID:t inte finns skickas 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 ange all nödvändig information. Genom att köra cmdleten Send-RdsUserSessionMessage utan växeln NoUserPrompt uppmanas du att bekräfta att du vill skicka meddelandet.

Exempel 2: Skicka ett meddelande till en användare genom att söka efter deras användarsession

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 cmdleten Send-RdsUserSessionMessage med växeln NoUserPrompt får du ingen ytterligare uppmaning om att bekräfta att meddelandet ska skickas.

Parametrar

-HostPoolName

Namnet på värdpoolen.

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	1
Obligatorisk:	True
Värde från pipeline:	True
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-MessageBody

Brödtexten i det meddelande som du vill skicka till användarsessionen.

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	5
Obligatorisk:	True
Värde från pipeline:	True
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-MessageTitle

Titeln på det meddelande som du vill skicka till användarsessionen.

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	4
Obligatorisk:	True
Värde från pipeline:	True
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-NoUserPrompt

Omkopplaren som anger att du vill koppla bort användaren utan ytterligare bekräftelse.

Parameteregenskaper

Typ:	SwitchParameter
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-SessionHostName

Namnet på sessionsvärden.

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	2
Obligatorisk:	True
Värde från pipeline:	True
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-SessionId

Sessions-ID:t som korrelerar med användarsessionen som ska ta emot meddelandet.

Parameteregenskaper

Typ:	Int32
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	3
Obligatorisk:	True
Värde från pipeline:	True
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-TenantName

Namnet på hyresgästen.

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	0
Obligatorisk:	True
Värde från pipeline:	True
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

System.String

System.Int32

Utdata

System.Object