Invoke-RdsUserSessionLogoff

Modul:

Microsoft.RDInfra.RDPowershell Module

Logout pengguna dari sesi aktif mereka saat ini.

Sintaks

Default (Default)

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

Deskripsi

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

Contoh

Contoh 1: Keluar pengguna dengan memberikan semua informasi yang diperlukan

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

Perintah ini menontonkan 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 agar keluar dari pengguna.

Parameter

-Force

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

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

-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

-NoUserPrompt

Sakelar yang menunjukkan bahwa Anda ingin keluar dari 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 berkorelasi dengan pengguna yang ingin Anda keluarkan.

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