Unregister-Event
Membatalkan langganan peristiwa.
Sintaks
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Unregister-Event
[-SubscriptionId] <Int32>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Deskripsi
Unregister-Event
Cmdlet membatalkan langganan peristiwa yang dibuat dengan menggunakan Register-EngineEvent
cmdlet , , Register-ObjectEvent
atau Register-WmiEvent
.
Saat langganan peristiwa dibatalkan, pelanggan peristiwa dihapus dari sesi dan peristiwa berlangganan tidak lagi ditambahkan ke antrean peristiwa. Saat Anda membatalkan langganan ke acara yang dibuat dengan menggunakan New-Event
cmdlet, peristiwa baru juga dihapus dari sesi.
Unregister-Event
tidak menghapus peristiwa dari antrean peristiwa. Untuk menghapus peristiwa, gunakan Remove-Event
cmdlet .
Contoh
Contoh 1: Membatalkan langganan peristiwa menurut pengidentifikasi sumber
Perintah ini membatalkan langganan peristiwa yang memiliki pengidentifikasi sumber ProcessStarted.
Unregister-Event -SourceIdentifier "ProcessStarted"
Untuk menemukan pengidentifikasi sumber suatu peristiwa, gunakan Get-Event
cmdlet . Untuk menemukan pengidentifikasi sumber langganan peristiwa, gunakan Get-EventSubscriber
cmdlet
Contoh 2: Membatalkan langganan peristiwa berdasarkan pengidentifikasi langganan
Perintah ini membatalkan langganan peristiwa yang memiliki pengidentifikasi langganan 2.
Unregister-Event -SubscriptionId 2
Untuk menemukan pengidentifikasi langganan peristiwa, gunakan Get-EventSubscriber
cmdlet .
Contoh 3: Membatalkan semua langganan peristiwa
Contoh ini membatalkan semua langganan peristiwa dalam sesi.
Get-EventSubscriber -Force | Unregister-Event -Force
Menggunakan parameter Paksa dengan Get-EventSubscriber
mendapatkan semua objek pelanggan peristiwa dalam sesi, termasuk pelanggan yang disembunyikan. Output disalurkan ke Unregister-Event
, yang menghapus pelanggan dari sesi. Parameter Force diperlukan untuk Unregister-Event
menghapus pelanggan tersembunyi.
Parameter
-Confirm
Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.
Jenis: | SwitchParameter |
Aliases: | cf |
Position: | Named |
nilai default: | False |
Diperlukan: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Membatalkan semua langganan peristiwa, termasuk langganan yang disembunyikan dengan menggunakan parameter SupportEvent dari Register-ObjectEvent
, Register-WmiEvent
, dan Register-EngineEvent
.
Jenis: | SwitchParameter |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SourceIdentifier
Menentukan pengidentifikasi sumber bahwa cmdlet ini membatalkan langganan peristiwa.
Parameter SourceIdentifier atau SubscriptionId harus disertakan dalam setiap perintah.
Jenis: | String |
Position: | 0 |
nilai default: | None |
Diperlukan: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionId
Menentukan ID pengidentifikasi sumber yang cmdlet ini membatalkan langganan peristiwa.
Parameter SourceIdentifier atau SubscriptionId harus disertakan dalam setiap perintah.
Jenis: | Int32 |
Position: | 0 |
nilai default: | None |
Diperlukan: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Menunjukkan apa yang akan terjadi jika cmdlet berjalan. Cmdlet tidak dijalankan.
Jenis: | SwitchParameter |
Aliases: | wi |
Position: | Named |
nilai default: | False |
Diperlukan: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Input
Anda dapat menyalurkan output dari Get-EventSubscriber
ke cmdlet ini.
Output
None
Cmdlet ini tidak mengembalikan output.
Catatan
Tidak ada sumber peristiwa yang tersedia di platform Linux atau macOS.
Peristiwa, langganan peristiwa, dan antrean peristiwa hanya ada di sesi saat ini. Jika Anda menutup sesi saat ini, antrean peristiwa akan dibuang dan langganan acara dibatalkan.
Unregister-Event
tidak dapat menghapus peristiwa yang dibuat dengan menggunakan New-Event
cmdlet kecuali Anda telah berlangganan acara dengan menggunakan Register-EngineEvent
cmdlet. Untuk menghapus peristiwa kustom dari sesi, Anda harus menghapusnya secara terprogram atau menutup sesi.