Unregister-Event

  • Odwołanie
Moduł:
Microsoft.PowerShell.Utility

Anuluje subskrypcję zdarzeń.

Składnia

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

Opis

Polecenie Unregister-Event cmdlet anuluje subskrypcję zdarzeń utworzoną przy użyciu Register-EngineEventpolecenia cmdlet , Register-ObjectEventlub Register-WmiEvent .

Po anulowaniu subskrypcji zdarzeń subskrybent zdarzenia jest usuwany z sesji, a subskrybowane zdarzenia nie są już dodawane do kolejki zdarzeń. Po anulowaniu subskrypcji do zdarzenia utworzonego New-Event przy użyciu polecenia cmdlet nowe zdarzenie zostanie również usunięte z sesji.

Unregister-Event nie usuwa zdarzeń z kolejki zdarzeń. Aby usunąć zdarzenia, użyj Remove-Event polecenia cmdlet .

Przykłady

Przykład 1. Anulowanie subskrypcji zdarzeń według identyfikatora źródłowego

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

To polecenie anuluje subskrypcję zdarzeń, która ma identyfikator źródłowy ProcessStarted.

Aby znaleźć identyfikator źródłowy zdarzenia, użyj Get-Event polecenia cmdlet . Aby znaleźć identyfikator źródłowy subskrypcji zdarzeń, użyj Get-EventSubscriber polecenia cmdlet .

Przykład 2. Anulowanie subskrypcji zdarzeń według identyfikatora subskrypcji

PS C:\> Unregister-Event -SubscriptionId 2

To polecenie anuluje subskrypcję zdarzeń, która ma identyfikator subskrypcji 2.

Aby znaleźć identyfikator subskrypcji zdarzeń, użyj Get-EventSubscriber polecenia cmdlet .

Przykład 3. Anulowanie wszystkich subskrypcji zdarzeń

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

To polecenie anuluje wszystkie subskrypcje zdarzeń w sesji.

Polecenie używa Get-EventSubscriber polecenia cmdlet , aby pobrać wszystkie obiekty subskrybenta zdarzeń w sesji, w tym subskrybentów, którzy są ukryte przy użyciu parametru SupportEvent poleceń cmdlet rejestracji zdarzeń.

Używa operatora potoku (|) do wysyłania obiektów subskrybenta do Unregister-Event, który usuwa je z sesji. Aby ukończyć zadanie, parametr Force jest również wymagany w pliku Unregister-Event.

Parametry

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

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

-Force

Anuluje wszystkie subskrypcje zdarzeń, w tym subskrypcje, które zostały ukryte przy użyciu parametru SupportEvent parametru Register-ObjectEvent, Register-WmiEventi Register-EngineEvent.

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

-SourceIdentifier

Określa identyfikator źródła, który to polecenie cmdlet anuluje subskrypcje zdarzeń.

Parametr SourceIdentifier lub SubscriptionId musi być uwzględniony w każdym poleceniu.

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

-SubscriptionId

Określa identyfikator źródła, który to polecenie cmdlet anuluje subskrypcje zdarzeń.

Parametr SourceIdentifier lub SubscriptionId musi być uwzględniony w każdym poleceniu.

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

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

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

Dane wejściowe

PSEventSubscriber

Możesz przekazać dane wyjściowe z Get-EventSubscriber do tego polecenia cmdlet.

Dane wyjściowe

None

To polecenie cmdlet nie zwraca żadnych danych wyjściowych.

Uwagi

Brak źródeł zdarzeń dostępnych na platformach Linux lub macOS.

Zdarzenia, subskrypcje zdarzeń i kolejka zdarzeń istnieją tylko w bieżącej sesji. Jeśli zamkniesz bieżącą sesję, kolejka zdarzeń zostanie odrzucona i subskrypcja zdarzeń zostanie anulowana.

Unregister-Event program nie może usunąć zdarzeń utworzonych przy użyciu New-Event polecenia cmdlet , chyba że zasubskrybujesz zdarzenie za pomocą Register-EngineEvent polecenia cmdlet . Aby usunąć zdarzenie niestandardowe z sesji, należy usunąć je programowo lub zamknąć sesję.