共用方式為

Send-RdsUserSessionMessage

模組:
Microsoft.RDInfra.RDPowershell Module

向使用者會話發送系統消息。

語法

Default (預設值) 

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

Description

Send-RdsUserSessionmessage cmdlet 將系統訊息發送到指定的用戶會話。 由於使用者會話 ID 僅在工作階段主機的上下文中是唯一的，因此不同的會話主機伺服器可以共用相同的用戶會話 ID。 使用此 cmdlet 指定的工作階段主機和工作階段 ID 唯一標識主機池中的會話。 如果會話 ID 不存在，則消息將廣播到會話主機上的所有用戶會話。

範例

範例 1：透過提供所有必需的資訊向使用者會話發送消息

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

此命令將消息發送到指定的用戶工作階段。 此命令要求您之前已查找用戶會話，以提供所有必需的資訊。 如果在沒有 NoUserPrompt 開關的情況下運行 Send-RdsUserSessionMessage cmdlet，系統將要求您確認是否發送消息。

範例 2：通過搜索使用者會話向用戶發送消息

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

此命令使用 Get-RdsUserSession cmdlet 搜尋特定使用者的會話，然後將其通過管道傳輸到 Send-RdsUserSessionMessage cmdlet 以向使用者會話發送消息。 通過使用 NoUserPrompt 開關運行 Send-RdsUserSessionMessage cmdlet，您將不會收到任何其他提示以確認發送郵件。

參數

-HostPoolName

主機池的名稱。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:1
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-MessageBody

要發送到用戶會話的消息的正文。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:5
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-MessageTitle

要發送到用戶會話的消息的標題。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:4
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-NoUserPrompt

指示您希望斷開用戶連接而無需任何其他確認的開關。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-SessionHostName

會話主機的名稱。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:2
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-SessionId

與將接收消息的用戶會話關聯的會話 ID。

參數屬性

類型:Int32
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:3
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-TenantName

租用戶的名稱。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:0
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

輸入

System.String

System.Int32

輸出

System.Object