Unregister-Event
Membatalkan langganan peristiwa.
Sintaks
BySource (Default)
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ById
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.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | Cf |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Force
Membatalkan semua langganan peristiwa, termasuk langganan yang disembunyikan dengan menggunakan parameter SupportEventRegister-ObjectEvent, Register-WmiEvent, dan Register-EngineEvent.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-SourceIdentifier
Menentukan pengidentifikasi sumber bahwa cmdlet ini membatalkan langganan peristiwa.
Parameter
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
BySource
| Position: | 0 |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | True |
| Nilai dari argumen yang tersisa: | False |
-SubscriptionId
Menentukan ID pengidentifikasi sumber yang cmdlet ini membatalkan langganan peristiwa.
Parameter
Properti parameter
| Jenis: | Int32 |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
ById
| Position: | 0 |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | True |
| Nilai dari argumen yang tersisa: | False |
-WhatIf
Menunjukkan apa yang akan terjadi ketika cmdlet dijalankan. Cmdlet tidak dijalankan.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | wi |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| 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
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, antrian peristiwa akan dibuang dan langganan peristiwa 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.
