Unregister-Event

Module:
Microsoft.PowerShell.Utility Module

Hiermee annuleert u een gebeurtenisabonnement.

Syntax

BySource (Standaard) 

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

ById 

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

Description

De Unregister-Event cmdlet annuleert een gebeurtenisabonnement dat is gemaakt met behulp van de Register-EngineEvent, Register-ObjectEventof Register-WmiEvent cmdlet.

Wanneer een gebeurtenisabonnement wordt geannuleerd, wordt de gebeurtenisabonnee verwijderd uit de sessie en worden de geabonneerde gebeurtenissen niet meer toegevoegd aan de gebeurteniswachtrij. Wanneer u een abonnement opzegt op een gebeurtenis die is gemaakt met behulp van de cmdlet New-Event, wordt de nieuwe gebeurtenis ook uit de sessie verwijderd.

Unregister-Event verwijdert geen gebeurtenissen uit de gebeurteniswachtrij. Gebruik de cmdlet Remove-Event om gebeurtenissen te verwijderen.

Voorbeelden

Voorbeeld 1: Een gebeurtenisabonnement opzeggen op bron-id

PS C:\> Unregister-Event -SourceIdentifier "ProcessStarted"

Met deze opdracht wordt het gebeurtenisabonnement met een bron-id van ProcessStarted geannuleerd.

Gebruik de cmdlet Get-Event om de bron-id van een gebeurtenis te vinden. Gebruik de Get-EventSubscriber cmdlet om de bron-id van een gebeurtenisabonnement te vinden.

Voorbeeld 2: Een gebeurtenisabonnement opzeggen op abonnements-id

PS C:\> Unregister-Event -SubscriptionId 2

Met deze opdracht wordt het gebeurtenisabonnement met een abonnements-id van 2 geannuleerd.

Gebruik de cmdlet Get-EventSubscriber om de abonnements-id van een gebeurtenisabonnement te vinden.

Voorbeeld 3: Alle gebeurtenisabonnementen annuleren

PS C:\> Get-EventSubscriber -Force | Unregister-Event -Force

Met deze opdracht worden alle gebeurtenisabonnementen in de sessie geannuleerd.

De opdracht maakt gebruik van de Get-EventSubscriber cmdlet om alle objecten van gebeurtenisabonnees in de sessie op te halen, inclusief de abonnees die zijn verborgen met behulp van de parameter SupportEvent van de cmdlets voor gebeurtenisregistratie.

Het maakt gebruik van een pijplijnoperator (|) om de abonneeobjecten naar Unregister-Eventte verzenden, waardoor ze uit de sessie worden verwijderd. Om de taak te voltooien, is de parameter Force ook vereist op Unregister-Event.

Parameters

-Confirm

Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Cf

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Force

Annuleert alle gebeurtenisabonnementen, inclusief abonnementen die zijn verborgen met behulp van de parameter SupportEvent van Register-ObjectEvent, Register-WmiEventen Register-EngineEvent.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-SourceIdentifier

Hiermee geeft u een bron-id op die door deze cmdlet gebeurtenisabonnementen worden geannuleerd.

Een SourceIdentifier- of parameter SubscriptionId moet worden opgenomen in elke opdracht.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

BySource
Position:0
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-SubscriptionId

Hiermee geeft u een bron-id op die door deze cmdlet gebeurtenisabonnementen worden geannuleerd.

Een SourceIdentifier- of parameter SubscriptionId moet worden opgenomen in elke opdracht.

Parametereigenschappen

Type:Int32
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ById
Position:0
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-WhatIf

Toont wat er zou gebeuren wanneer de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Wi

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

PSEventSubscriber

U kunt de uitvoer doorsturen van Get-EventSubscriber naar .Unregister-Event

Uitvoerwaarden

None

Deze cmdlet retourneert geen uitvoer.

Notities

Er zijn geen gebeurtenisbronnen beschikbaar op de Linux- of macOS-platforms.

Gebeurtenissen, gebeurtenisabonnementen en de gebeurteniswachtrij bestaan alleen in de huidige sessie. Als u de huidige sessie sluit, wordt de gebeurteniswachtrij verwijderd en wordt het gebeurtenisabonnement geannuleerd.

Unregister-Event kan gebeurtenissen die zijn gemaakt met behulp van de cmdlet New-Event niet verwijderen, tenzij u zich hebt geabonneerd op de gebeurtenis met behulp van de Register-EngineEvent-cmdlet. Als u een aangepaste gebeurtenis uit de sessie wilt verwijderen, moet u deze programmatisch verwijderen of de sessie sluiten.