Unregister-Event
Avbryter en händelseprenumeration.
Syntax
BySource (Standard)
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ById
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-ObjectEventeller 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
Det här kommandot avbryter händelseprenumerationen som har en källidentifierare för ProcessStarted.
Unregister-Event -SourceIdentifier "ProcessStarted"
Om du vill hitta källidentifieraren för en händelse använder du cmdleten Get-Event. Om du vill hitta källidentifieraren för en händelseprenumeration använder du cmdleten Get-EventSubscriber
Exempel 2: Avbryt en händelseprenumeration efter prenumerationsidentifierare
Det här kommandot avbryter händelseprenumerationen som har en prenumerationsidentifierare på 2.
Unregister-Event -SubscriptionId 2
Om du vill hitta prenumerationsidentifieraren för en händelseprenumeration använder du cmdleten Get-EventSubscriber.
Exempel 3: Avbryt alla händelseprenumerationer
I det här exemplet avbryts alla händelseprenumerationer i sessionen.
Get-EventSubscriber -Force | Unregister-Event -Force
Med parametern Force med Get-EventSubscriber hämtas alla händelseprenumerantobjekt i sessionen, inklusive de prenumeranter som är dolda. Utdata skickas till Unregister-Event, som tar bort prenumeranterna från sessionen. Parametern Force krävs på Unregister-Event för att ta bort dolda prenumeranter.
Parametrar
-Confirm
Uppmanar dig att bekräfta innan du kör cmdleten.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | jfr |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Force
Avbryter alla händelseprenumerationer, inklusive prenumerationer som har dolts med hjälp av parametern SupportEvent för Register-ObjectEvent, Register-WmiEventoch Register-EngineEvent.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-SourceIdentifier
Anger en källidentifierare som den här cmdleten avbryter händelseprenumerationer.
Parametern SourceIdentifier eller SubscriptionId måste ingå i varje kommando.
Parameteregenskaper
| Typ: | String |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
BySource
| Position: | 0 |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | True |
| Värde från återstående argument: | False |
-SubscriptionId
Anger ett källidentifierar-ID som den här cmdleten avbryter händelseprenumerationer.
Parametern SourceIdentifier eller SubscriptionId måste ingå i varje kommando.
Parameteregenskaper
| Typ: | Int32 |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
ById
| Position: | 0 |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | True |
| Värde från återstående argument: | False |
-WhatIf
Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | Wi |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.
Indata
PSEventSubscriber
Du kan skicka utdata från Get-EventSubscriber till den här cmdleten.
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 kan inte ta bort händelser som skapats med hjälp av cmdleten New-Event såvida du inte prenumererar 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.
