Unregister-Event
Avbryter en händelseprenumeration.
Syntax
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Unregister-Event
[-SubscriptionId] <Int32>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Cmdleten Unregister-Event
avbryter en händelseprenumeration som skapades med hjälp av cmdleten Register-EngineEvent
, Register-ObjectEvent
eller Register-WmiEvent
.
När en händelseprenumeration avbryts tas händelseprenumeranten bort från sessionen och de prenumererade händelserna läggs inte längre till i händelsekön. När du avbryter en prenumeration på en händelse som skapats med hjälp av cmdleten New-Event
tas även den nya händelsen bort från sessionen.
Unregister-Event
tar inte bort händelser från händelsekön. Om du vill ta bort händelser använder du cmdleten Remove-Event
.
Exempel
Exempel 1: Avbryt en händelseprenumeration efter källidentifierare
PS C:\> Unregister-Event -SourceIdentifier "ProcessStarted"
Det här kommandot avbryter händelseprenumerationen som har en källidentifierare för ProcessStarted.
Använd cmdleten för att hitta källidentifieraren för Get-Event
en händelse. Använd cmdleten Get-EventSubscriber
för att hitta källidentifieraren för en händelseprenumeration.
Exempel 2: Avbryta en händelseprenumeration efter prenumerationsidentifierare
PS C:\> Unregister-Event -SubscriptionId 2
Det här kommandot avbryter händelseprenumerationen som har en prenumerationsidentifierare på 2.
Använd cmdleten Get-EventSubscriber
för att hitta prenumerationsidentifieraren för en händelseprenumeration.
Exempel 3: Avbryt alla händelseprenumerationer
PS C:\> Get-EventSubscriber -Force | Unregister-Event -Force
Det här kommandot avbryter alla händelseprenumerationer i sessionen.
Kommandot använder cmdleten Get-EventSubscriber
för att hämta alla händelseprenumerantobjekt i sessionen, inklusive prenumeranter som är dolda med hjälp av parametern SupportEvent i cmdletarna för händelseregistrering.
Den använder en pipelineoperator (|
) för att skicka prenumerantobjekten till Unregister-Event
, som tar bort dem från sessionen. För att slutföra uppgiften krävs även force-parametern på Unregister-Event
.
Parametrar
-Confirm
Uppmanar dig att bekräfta innan du kör cmdleten.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Avbryter alla händelseprenumerationer, inklusive prenumerationer som har dolts med hjälp av parametern SupportEvent för Register-ObjectEvent
, Register-WmiEvent
och Register-EngineEvent
.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SourceIdentifier
Anger en källidentifierare som den här cmdleten avbryter händelseprenumerationer.
En SourceIdentifier - eller SubscriptionId-parameter måste ingå i varje kommando.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionId
Anger ett källidentifierar-ID som den här cmdleten avbryter händelseprenumerationer.
En SourceIdentifier - eller SubscriptionId-parameter måste ingå i varje kommando.
Type: | Int32 |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indata
Du kan skicka utdata från Get-EventSubscriber
till Unregister-Event
.
Utdata
None
Den här cmdleten returnerar inga utdata.
Kommentarer
Inga händelsekällor är tillgängliga på Linux- eller macOS-plattformarna.
Händelser, händelseprenumerationer och händelsekön finns bara i den aktuella sessionen. Om du stänger den aktuella sessionen ignoreras händelsekön och händelseprenumerationen avbryts.
Unregister-Event
det går inte att ta bort händelser som skapats med hjälp av cmdleten New-Event
såvida du inte har prenumererat på händelsen med hjälp av cmdleten Register-EngineEvent
. Om du vill ta bort en anpassad händelse från sessionen måste du ta bort den programmatiskt eller stänga sessionen.