Unregister-Event

Referenz

Modul:: Microsoft.PowerShell.Utility

Bricht ein Ereignisabonnement ab.

Syntax

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

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

Beschreibung

Das Cmdlet Unregister-Event bricht ein Ereignisabonnement ab, das mithilfe des Cmdlets Register-EngineEvent, Register-ObjectEventoder Register-WmiEvent erstellt wurde.

Wenn ein Ereignisabonnement abgebrochen wird, wird der Ereignisabonnent aus der Sitzung gelöscht, und die abonnierten Ereignisse werden der Ereigniswarteschlange nicht mehr hinzugefügt. Wenn Sie ein Abonnement für ein Ereignis kündigen, das mit dem Cmdlet New-Event erstellt wurde, wird das neue Ereignis auch aus der Sitzung gelöscht.

Unregister-Event löscht keine Ereignisse aus der Ereigniswarteschlange. Verwenden Sie zum Löschen von Ereignissen das Cmdlet Remove-Event.

Beispiele

Beispiel 1: Kündigen eines Ereignisabonnements nach Quellbezeichner

Dieser Befehl bricht das Ereignisabonnement ab, das über einen Quellbezeichner von ProcessStarted verfügt.

Unregister-Event -SourceIdentifier "ProcessStarted"

Verwenden Sie das Cmdlet Get-Event, um den Quellbezeichner eines Ereignisses zu finden. Um den Quellbezeichner eines Ereignisabonnements zu finden, verwenden Sie das Cmdlet Get-EventSubscriber

Beispiel 2: Kündigen eines Ereignisabonnements nach Abonnementbezeichner

Dieser Befehl bricht das Ereignisabonnement ab, das über einen Abonnementbezeichner von 2 verfügt.

Unregister-Event -SubscriptionId 2

Verwenden Sie das Cmdlet Get-EventSubscriber, um den Abonnementbezeichner eines Ereignisabonnements zu finden.

Beispiel 3: Kündigen aller Ereignisabonnements

In diesem Beispiel werden alle Ereignisabonnements in der Sitzung abgebrochen.

Get-EventSubscriber -Force | Unregister-Event -Force

Wenn Sie den Parameter Force mit Get-EventSubscriber verwenden, werden alle Ereignisabonnentobjekte in der Sitzung abgerufen, einschließlich der Abonnenten, die ausgeblendet sind. Die Ausgabe wird an Unregister-Eventweitergeleitet, wodurch die Abonnenten aus der Sitzung gelöscht werden. Der parameter Force ist für Unregister-Event erforderlich, um ausgeblendete Abonnenten zu entfernen.

Parameter

-Confirm

Fordert Sie vor dem Ausführen des Cmdlets zur Bestätigung auf.

Typ:	SwitchParameter
Aliase:	cf
Position:	Named
Standardwert:	False
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Force

Bricht alle Ereignisabonnements ab, einschließlich Abonnements, die mithilfe des SupportEvent--Parameters von Register-ObjectEvent, Register-WmiEventund Register-EngineEventausgeblendet wurden.

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-SourceIdentifier

Gibt einen Quellbezeichner an, mit dem dieses Cmdlet Ereignisabonnements abbricht.

Ein SourceIdentifier oder SubscriptionId Parameter muss in jedem Befehl enthalten sein.

Typ:	String
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-SubscriptionId

Gibt eine Quell-ID an, mit der dieses Cmdlet Ereignisabonnements abbricht.

Ein SourceIdentifier oder SubscriptionId Parameter muss in jedem Befehl enthalten sein.

Typ:	Int32
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:	SwitchParameter
Aliase:	wi
Position:	Named
Standardwert:	False
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

Eingaben

PSEventSubscriber

Sie können die Ausgabe von Get-EventSubscriber an dieses Cmdlet weiterleiten.

Ausgaben

None

Dieses Cmdlet gibt keine Ausgabe zurück.

Hinweise

Auf den Linux- oder macOS-Plattformen sind keine Ereignisquellen verfügbar.

Ereignisse, Ereignisabonnements und die Ereigniswarteschlange sind nur in der aktuellen Sitzung vorhanden. Wenn Sie die aktuelle Sitzung schließen, wird die Ereigniswarteschlange verworfen, und das Ereignisabonnement wird abgebrochen.

Unregister-Event können ereignisse, die mit dem Cmdlet New-Event erstellt wurden, nicht löschen, es sei denn, Sie haben das Ereignis mithilfe des Cmdlets Register-EngineEvent abonniert. Um ein benutzerdefiniertes Ereignis aus der Sitzung zu löschen, müssen Sie es programmgesteuert entfernen oder die Sitzung schließen.