Unregister-Event

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Storniert ein Ereignisabonnement.

Syntax

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

Beschreibung

Das Unregister-Event Cmdlet bricht ein Ereignisabonnement ab, das mithilfe des Register-EngineEventCmdlets oder Register-WmiEventRegister-ObjectEventdes Cmdlets erstellt wurde.

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

Unregister-Event Ereignisse werden nicht aus der Ereigniswarteschlange gelöscht. Verwenden Sie das Remove-Event Cmdlet, um Ereignisse zu löschen.

Beispiele

Beispiel 1: Kündigen eines Ereignisabonnements nach Quellbezeichner

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

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

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

Beispiel 2: Kündigen eines Ereignisabonnements nach Abonnementbezeichner

PS C:\> Unregister-Event -SubscriptionId 2

Mit diesem Befehl wird das Ereignisabonnement gekündigt, das den Abonnementbezeichner „2“ aufweist.

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

Beispiel 3: Kündigen aller Ereignisabonnements

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

Mit diesem Befehl werden alle Ereignisabonnements in der Sitzung gekündigt.

Der Befehl verwendet das Get-EventSubscriber Cmdlet, um alle Ereignisabonnentobjekte in der Sitzung abzurufen, einschließlich der Abonnenten, die mithilfe des SupportEvent-Parameters der Ereignisregistrierungs-Cmdlets ausgeblendet sind.

Es verwendet einen Pipelineoperator (|), um die Abonnentenobjekte an , Unregister-Eventan die sie aus der Sitzung gelöscht werden. Um den Vorgang abzuschließen, ist auch der Parameter Force erforderlich für Unregister-Event.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

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

-Force

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

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

-SourceIdentifier

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

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

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

-SubscriptionId

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

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

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

-WhatIf

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

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

Eingaben

PSEventSubscriber

Sie können die Ausgabe an Get-EventSubscriber 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 Ereignisse, die mit dem New-Event Cmdlet erstellt wurden, können nicht gelöscht werden, es sei denn, Sie haben das Ereignis mithilfe des Register-EngineEvent Cmdlets abonniert. Um ein benutzerdefiniertes Ereignis aus der Sitzung zu löschen, müssen Sie es programmgesteuert entfernen oder die Sitzung schließen.