Unregister-Event
Zruší odběr události.
Syntax
BySource (Výchozí)
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ById
Unregister-Event
[-SubscriptionId] <Int32>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Rutina Unregister-Event zruší odběr událostí vytvořený pomocí rutiny Register-EngineEvent, Register-ObjectEventnebo Register-WmiEvent.
Po zrušení odběru událostí se odběratel události odstraní z relace a odebírané události se už nepřidají do fronty událostí. Když zrušíte odběr události vytvořené pomocí rutiny New-Event, nová událost se také odstraní z relace.
Unregister-Event neodstraní události z fronty událostí. K odstranění událostí použijte rutinu Remove-Event.
Příklady
Příklad 1: Zrušení odběru událostí podle identifikátoru zdroje
Tento příkaz zruší odběr událostí, který má zdrojový identifikátor ProcessStarted.
Unregister-Event -SourceIdentifier "ProcessStarted"
Pokud chcete najít identifikátor zdroje události, použijte rutinu Get-Event. Pokud chcete najít zdrojový identifikátor odběru událostí, použijte rutinu Get-EventSubscriber.
Příklad 2: Zrušení odběru událostí podle identifikátoru předplatného
Tento příkaz zruší odběr událostí, který má identifikátor odběru 2.
Unregister-Event -SubscriptionId 2
Pokud chcete najít identifikátor předplatného události, použijte příkaz Get-EventSubscriber.
Příklad 3: Zrušení všech odběrů událostí
Tento příklad zruší všechna odběry událostí v relaci.
Get-EventSubscriber -Force | Unregister-Event -Force
Při použití parametru Force s Get-EventSubscriber se získají všechny objekty odběratelů událostí v relaci, včetně skrytých odběratelů. Výstup se předává do Unregister-Event, který následně odstraní předplatitele z relace. Parametr Vynucení je vyžadován na Unregister-Event, aby se odebrali všechna skrytá odběratele.
Parametry
-Confirm
Před spuštěním cmdletu vás vyzve k potvrzení.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | viz |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Force
Zruší všechny přihlášky k odběru událostí, včetně těch, které byly skryté použitím parametru SupportEvent v Register-ObjectEvent, Register-WmiEventa Register-EngineEvent.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-SourceIdentifier
Určuje identifikátor zdroje, který tato rutina zruší odběry událostí.
Do každého příkazu musí být zahrnut parametr SourceIdentifier nebo SubscriptionId.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
BySource
| Position: | 0 |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-SubscriptionId
Určuje ID identifikátoru zdroje, na základě kterého tato rutina ruší odběry událostí.
Do každého příkazu musí být zahrnut parametr SourceIdentifier nebo SubscriptionId.
Vlastnosti parametru
| Typ: | Int32 |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
ById
| Position: | 0 |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-WhatIf
Ukazuje, co se stane, když se příkaz spustí. Příkazový modul nebyl spuštěn.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | Wi |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.
Vstupy
PSEventSubscriber
Výstup z Get-EventSubscriber můžete přesměrovat do této rutiny cmdlet.
Výstupy
None
Tento cmdlet nevrátí žádný výstup.
Poznámky
Události, odběry událostí a fronta událostí existují pouze v aktuální relaci. Pokud zavřete aktuální sezení, fronta událostí se vyprázdní a odběr události se zruší.
Unregister-Event nelze odstranit události vytvořené pomocí rutiny New-Event, pokud jste se k události neodhlásili pomocí rutiny Register-EngineEvent. Pokud chcete odstranit vlastní událost z relace, musíte ji odebrat programově nebo relaci zavřít.
