Invoke-RdsUserSessionLogoff

Log keluar pengguna dari sesi aktif mereka saat ini.

Sintaks

Invoke-RdsUserSessionLogoff
      [-TenantName] <String>
      [-HostPoolName] <String>
      [-SessionHostName] <String>
      [-SessionId] <Int32>
      [-NoUserPrompt]
      [-Force]
      [<CommonParameters>]

Deskripsi

Invoke-RdsUserSessionLogoff mengeluarkan pengguna dari sesi aktif mereka saat ini yang berjalan pada host sesi yang ditentukan. Karena pengguna masuk, semua aplikasi akan dihentikan dan ada potensi data hilang jika pengguna atau aplikasi belum menyimpan file yang dibuka.

Contoh

Contoh 1: Keluar dari pengguna dengan memberikan semua informasi yang diperlukan

PS C:\> Invoke-RdsUserSessionLogoff -TenantName "contoso" -HostPoolName "contosoHostPool" -SessionHostName "sh1.contoso.com" -SessionId 1

Perintah ini mencatat pengguna pada host sesi yang ditentukan yang terkait dengan ID sesi yang disediakan. Perintah ini mengharuskan Anda mencari sesi pengguna sebelumnya untuk memberikan semua informasi yang diperlukan. Dengan menjalankan cmdlet Invoke-RdsUserSessionLogoff tanpa sakelar NoUserPrompt, Anda akan diminta untuk mengonfirmasi untuk keluar dari pengguna.

Contoh 2: Keluar dari pengguna dengan mencari sesi pengguna mereka

PS C:\> Get-RdsUserSession -TenantName "contoso" -HostPoolName "contosoHostPool" | where { $_.UserPrincipalName -eq "contoso\user1" } | Invoke-RdsUserSessionLogoff -NoUserPrompt

Perintah ini menggunakan cmdlet Get-RdsUserSession untuk mencari sesi pengguna tertentu, lalu menyalurkannya ke cmdlet Invoke-RdsUserSessionLogoff untuk keluar dari pengguna. Dengan menjalankan cmdlet Invoke-RdsUserSessionLogoff dengan sakelar NoUserPrompt, Anda tidak akan menerima perintah tambahan untuk mengonfirmasi untuk keluar dari pengguna.

Parameter

-Force

Tombol yang menunjukkan bahwa Anda ingin keluar dari pengguna dan menghapus sesi dari database, bahkan jika layanan tidak dapat mencapai host sesi.

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

-HostPoolName

Nama kumpulan host.

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

-NoUserPrompt

Sakelar yang menunjukkan bahwa Anda ingin keluar dari pengguna tanpa konfirmasi tambahan.

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

-SessionHostName

Nama host sesi.

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

-SessionId

ID sesi yang berkorelasi dengan pengguna yang ingin Anda keluarkan.

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

-TenantName

Nama penyewa.

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

Input

System.String

System.Int32

Output

System.Object