Unregister-Event
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 mit dem Register-EngineEvent
Cmdlet , Register-ObjectEvent
oder Register-WmiEvent
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 auch das neue Ereignis aus der Sitzung gelöscht.
Unregister-Event
löscht keine Ereignisse aus der Ereigniswarteschlange. 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 den Quellbezeichner ProcessStarted verfügt.
Verwenden Sie das Cmdlet, um den Quellbezeichner eines Ereignisses Get-Event
zu ermitteln. Verwenden Sie das Cmdlet, um den Get-EventSubscriber
Quellbezeichner eines Ereignisabonnements zu ermitteln.
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 Cmdlet, um den Get-EventSubscriber
Abonnementbezeichner eines Ereignisabonnements zu ermitteln.
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 werden.
Es verwendet einen Pipelineoperator (|
), um die Abonnentenobjekte an zu Unregister-Event
senden, wodurch sie aus der Sitzung gelöscht werden. Zum Abschließen der Aufgabe ist auch der Force-Parameter für Unregister-Event
erforderlich.
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
Löscht alle Ereignisabonnements, einschließlich Abonnements, die mithilfe des SupportEvent-Parameters von Register-ObjectEvent
, Register-WmiEvent
und Register-EngineEvent
ausgeblendet wurden.
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 bricht.
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 Quellbezeichner-ID an, mit der dieses Cmdlet Ereignisabonnements bricht.
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
Sie können die Ausgabe von Get-EventSubscriber
an dieses Cmdlet übergeben.
Ausgaben
None
Dieses Cmdlet gibt keine Ausgabe zurück.
Hinweise
Auf 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 nur gelöscht werden, wenn Sie das Ereignis mithilfe des Register-EngineEvent
Cmdlets abonniert haben. Um ein benutzerdefiniertes Ereignis aus der Sitzung zu löschen, müssen Sie es programmgesteuert entfernen oder die Sitzung schließen.