Sdílet prostřednictvím

Unregister-Event

  • Reference
Modul:
Microsoft.PowerShell.Utility

Zruší odběr události.

Syntax

Unregister-Event
          [-SourceIdentifier] <String>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
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 rutiny.

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í New-Event rutiny, 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 zdrojový identifikátor 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 odběru odběru události, použijte rutinu 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

Použití parametru Force s Get-EventSubscriber získá všechny objekty odběratele událostí v relaci, včetně odběratelů, které jsou skryté. Výstup se předá Unregister-Eventdo kanálu , který odstraní odběratele z relace. Parametr Force se vyžaduje Unregister-Event k odebrání skrytých odběratelů.

Parametry

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

Typ:SwitchParameter
Aliases:cf
Position:Named
výchozí hodnota:False
Vyžadováno:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Zruší všechna předplatná událostí, včetně předplatných, která byla skrytá, pomocí parametru SupportEvent parametru Register-ObjectEvent, Register-WmiEventa Register-EngineEvent.

Typ:SwitchParameter
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:False
Accept wildcard characters:False

-SourceIdentifier

Určuje identifikátor zdroje, který tato rutina zruší odběry událostí.

Parametr SourceIdentifier nebo SubscriptionId musí být součástí každého příkazu.

Typ:String
Position:0
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionId

Určuje ID identifikátoru zdroje, které tato rutina zruší odběry událostí.

Parametr SourceIdentifier nebo SubscriptionId musí být součástí každého příkazu.

Typ:Int32
Position:0
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.

Typ:SwitchParameter
Aliases:wi
Position:Named
výchozí hodnota:False
Vyžadováno:False
Accept pipeline input:False
Accept wildcard characters:False

Vstupy

PSEventSubscriber

Výstup můžete převést do Get-EventSubscriber této rutiny.

Výstupy

None

Tato rutina nevrátí žádný výstup.

Poznámky

Na platformách Linux nebo macOS nejsou dostupné žádné zdroje událostí.

Události, odběry událostí a fronta událostí existují pouze v aktuální relaci. Pokud zavřete aktuální relaci, fronta událostí se zahodí a odběr události se zruší.

Unregister-Event Aplikace nemůže odstranit události vytvořené pomocí New-Event rutiny, pokud jste se k odběru 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.