Send-RdsUserSessionMessage

Modul:

Microsoft.RDInfra.RDPowershell Module

Mengirim pesan sistem ke sesi pengguna.

Sintaks

Default (Default)

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

Deskripsi

Cmdlet Send-RdsUserSessionmessage mengirimkan pesan sistem ke sesi pengguna tertentu. Karena ID sesi pengguna hanya unik dalam konteks host sesi, server host sesi yang berbeda dapat berbagi ID sesi pengguna yang sama. Host sesi dan ID sesi yang Anda tentukan dengan menggunakan cmdlet ini secara unik mengidentifikasi sesi dalam kumpulan host. Jika ID sesi tidak ada, pesan akan disiarkan ke semua sesi pengguna di host sesi.

Contoh

Contoh 1: Mengirim pesan ke sesi pengguna dengan memberikan semua informasi yang diperlukan

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

Perintah ini mengirimkan pesan ke sesi pengguna yang ditentukan. Perintah ini mengharuskan Anda mencari sesi pengguna sebelumnya untuk memberikan semua informasi yang diperlukan. Dengan menjalankan cmdlet Send-RdsUserSessionMessage tanpa sakelar NoUserPrompt, Anda akan diminta untuk mengonfirmasi untuk mengirim pesan.

Contoh 2: Mengirim pesan ke pengguna dengan menelusuri sesi pengguna mereka

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

Perintah ini menggunakan cmdlet Get-RdsUserSession untuk mencari sesi pengguna tertentu, lalu menyalurkannya ke cmdlet Send-RdsUserSessionMessage untuk mengirim pesan ke sesi pengguna. Dengan menjalankan cmdlet Send-RdsUserSessionMessage dengan sakelar NoUserPrompt, Anda tidak akan menerima perintah tambahan untuk mengonfirmasi pengiriman pesan.

Parameter

-HostPoolName

Nama kumpulan host.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	1
Wajib:	True
Nilai dari alur:	True
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-MessageBody

Isi pesan yang ingin Anda kirim ke sesi pengguna.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	5
Wajib:	True
Nilai dari alur:	True
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-MessageTitle

Judul pesan yang ingin Anda kirim ke sesi pengguna.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	4
Wajib:	True
Nilai dari alur:	True
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-NoUserPrompt

Sakelar yang menunjukkan bahwa Anda ingin memutuskan sambungan pengguna tanpa konfirmasi tambahan.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-SessionHostName

Nama host sesi.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	2
Wajib:	True
Nilai dari alur:	True
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-SessionId

ID sesi yang berkorelasi dengan sesi pengguna yang akan menerima pesan.

Properti parameter

Jenis:	Int32
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	3
Wajib:	True
Nilai dari alur:	True
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-TenantName

Nama penyewa.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	0
Wajib:	True
Nilai dari alur:	True
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

System.String

System.Int32

Output

System.Object