Bagikan melalui


Unregister-Event

Membatalkan langganan peristiwa.

Sintaks

Unregister-Event
          [-SourceIdentifier] <String>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-Event
          [-SubscriptionId] <Int32>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Deskripsi

Cmdlet Unregister-Event membatalkan langganan peristiwa yang dibuat dengan menggunakan cmdlet Register-EngineEvent, 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 cmdlet New-Event, peristiwa baru juga dihapus dari sesi.

Unregister-Event tidak menghapus peristiwa dari antrean peristiwa. Untuk menghapus peristiwa, gunakan cmdlet Remove-Event.

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 cmdlet Get-Event. Untuk menemukan pengidentifikasi sumber langganan peristiwa, gunakan cmdlet Get-EventSubscriber

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 cmdlet Get-EventSubscriber.

Contoh 3: Membatalkan semua langganan peristiwa

Contoh ini membatalkan semua langganan peristiwa dalam sesi.

Get-EventSubscriber -Force | Unregister-Event -Force

Menggunakan parameter Force 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 pada Unregister-Event untuk menghapus pelanggan tersembunyi.

Parameter

-Confirm

Meminta konfirmasi sebelum menjalankan cmdlet.

Jenis:SwitchParameter
Alias:cf
Position:Named
Nilai default:False
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Force

Membatalkan semua langganan peristiwa, termasuk langganan yang disembunyikan dengan menggunakan parameter SupportEventRegister-ObjectEvent, Register-WmiEvent, dan Register-EngineEvent.

Jenis:SwitchParameter
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard: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
Terima input alur:True
Terima karakter wildcard: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
Terima input alur:True
Terima karakter wildcard:False

-WhatIf

Menunjukkan apa yang akan terjadi jika cmdlet berjalan. Cmdlet tidak dijalankan.

Jenis:SwitchParameter
Alias:wi
Position:Named
Nilai default:False
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

Input

PSEventSubscriber

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 cmdlet New-Event kecuali Anda telah berlangganan acara dengan menggunakan cmdlet Register-EngineEvent. Untuk menghapus peristiwa kustom dari sesi, Anda harus menghapusnya secara terprogram atau menutup sesi.