Unregister-Event
Anuluje subskrypcję zdarzeń.
Składnia
BySource (Domyślna)
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ById
Unregister-Event
[-SubscriptionId] <Int32>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Opis
Polecenie cmdlet Unregister-Event anuluje subskrypcję zdarzeń utworzoną przy użyciu polecenia cmdlet Register-EngineEvent, 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 przy użyciu polecenia cmdlet New-Event nowe zdarzenie zostanie również usunięte z sesji.
Unregister-Event nie usuwa zdarzeń z kolejki zdarzeń. Aby usunąć zdarzenia, użyj polecenia cmdlet Remove-Event.
Przykłady
Przykład 1. Anulowanie subskrypcji na zdarzenie według identyfikatora źródłowego
To polecenie anuluje subskrypcję zdarzeń, która ma identyfikator źródłowy ProcessStarted.
Unregister-Event -SourceIdentifier "ProcessStarted"
Aby znaleźć identyfikator źródła zdarzenia, użyj polecenia cmdlet Get-Event. Aby znaleźć identyfikator źródłowy subskrypcji zdarzeń, użyj polecenia cmdlet Get-EventSubscriber
Przykład 2. Anulowanie subskrypcji zdarzenia według identyfikatora subskrypcji
To polecenie anuluje subskrypcję zdarzeń, która ma identyfikator subskrypcji 2.
Unregister-Event -SubscriptionId 2
Aby znaleźć identyfikator subskrypcji wydarzenia, użyj polecenia cmdlet Get-EventSubscriber.
Przykład 3. Anulowanie wszystkich subskrypcji zdarzeń
W tym przykładzie wszystkie subskrypcje zdarzeń są anulowane w sesji.
Get-EventSubscriber -Force | Unregister-Event -Force
Użycie parametru Force z Get-EventSubscriber pobiera wszystkie obiekty subskrybentów zdarzeń w sesji, w tym subskrybentów, którzy są ukryci. Dane wyjściowe są kierowane do Unregister-Event, który usuwa subskrybentów z sesji. Parametr Force jest wymagany w Unregister-Event, aby usunąć wszystkich ukrytych subskrybentów.
Parametry
-Confirm
Prosi o potwierdzenie przed uruchomieniem cmdletu.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
| Aliasy: | por |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Force
Anuluje wszystkie subskrypcje zdarzeń, w tym także subskrypcje, które zostały ukryte przy użyciu parametru SupportEvent, Register-ObjectEvent, Register-WmiEventi Register-EngineEvent.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-SourceIdentifier
Określa identyfikator źródła, dla którego to polecenie cmdlet anuluje subskrypcje zdarzeń.
W każdym poleceniu musi zostać uwzględniony parametr SourceIdentifier lub SubscriptionId.
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
BySource
| Position: | 0 |
| Obowiązkowy: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | True |
| Wartość z pozostałych argumentów: | False |
-SubscriptionId
Polecenie cmdlet anulujące subskrypcje zdarzeń określa identyfikator źródła.
W każdym poleceniu musi zostać uwzględniony parametr SourceIdentifier lub SubscriptionId.
Właściwości parametru
| Typ: | Int32 |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
ById
| Position: | 0 |
| Obowiązkowy: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | True |
| Wartość z pozostałych argumentów: | False |
-WhatIf
Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie jest uruchomiony.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
| Aliasy: | Wi |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
CommonParameters
To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.
Dane wejściowe
PSEventSubscriber
Możesz przekierować dane wyjściowe z Get-EventSubscriber do tego polecenia.
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 usunięta, a subskrypcja zostanie anulowana.
Unregister-Event nie można usunąć zdarzeń utworzonych przy użyciu polecenia cmdlet New-Event, chyba że zasubskrybujesz zdarzenie przy użyciu polecenia cmdlet Register-EngineEvent. Aby usunąć zdarzenie niestandardowe z sesji, należy usunąć je programowo lub zamknąć sesję.
