Unregister-Event

  • Referentie
Module:
Microsoft.PowerShell.Utility

Hiermee annuleert u een gebeurtenisabonnement.

Syntax

Unregister-Event
          [-SourceIdentifier] <String>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
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 voor een gebeurtenis die is gemaakt met behulp van de New-Event cmdlet, wordt de nieuwe gebeurtenis ook uit de sessie verwijderd.

Unregister-Event verwijdert geen gebeurtenissen uit de gebeurteniswachtrij. Gebruik de Remove-Event cmdlet 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 Get-Event cmdlet 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 Get-EventSubscriber cmdlet 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 gebruikt de Get-EventSubscriber cmdlet om alle objecten voor gebeurtenisabonnees in de sessie op te halen, inclusief de abonnees die zijn verborgen met behulp van de parameter SupportEvent van de cmdlets voor gebeurtenisregistratie.

Er wordt een pijplijnoperator (|) gebruikt om de abonneeobjecten naar Unregister-Eventte verzenden, waarmee ze uit de sessie worden verwijderd. Als u de taak wilt voltooien, is de parameter Force ook vereist voor Unregister-Event.

Parameters

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SourceIdentifier

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

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

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionId

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

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

Type:Int32
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Invoerwaarden

PSEventSubscriber

U kunt de uitvoer van Get-EventSubscriber naar deze cmdlet doorsluisen.

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 New-Event cmdlet 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.