Delen via

Get-EventSubscriber

  • Referentie
Module:
Microsoft.PowerShell.Utility

Haalt de gebeurtenisabonnees op in de huidige sessie.

Syntaxis

Get-EventSubscriber
   [[-SourceIdentifier] <String>]
   [-Force]
   [<CommonParameters>]
Get-EventSubscriber
   [-SubscriptionId] <Int32>
   [-Force]
   [<CommonParameters>]

Description

De Get-EventSubscriber cmdlet haalt de gebeurtenisabonnees op in de huidige sessie.

Wanneer u zich abonneert op een gebeurtenis met behulp van een cmdlet Gebeurtenis registreren, wordt een gebeurtenisabonnee toegevoegd aan uw Windows PowerShell-sessie en worden de gebeurtenissen waaraan u zich hebt geabonneerd, toegevoegd aan uw gebeurteniswachtrij wanneer ze worden gegenereerd. Als u een gebeurtenisabonnement wilt annuleren, verwijdert u de gebeurtenisabonnee met behulp van de Unregister-Event cmdlet.

Voorbeelden

Voorbeeld 1: De gebeurtenisabonnee voor een timer-gebeurtenis ophalen

In dit voorbeeld wordt een Get-EventSubscriber opdracht gebruikt om de gebeurtenisabonnee op te halen voor een timer-gebeurtenis.

De eerste opdracht gebruikt de New-Object cmdlet om een exemplaar van een timerobject te maken. Het nieuwe timerobject wordt opgeslagen in de $Timer variabele.

De tweede opdracht gebruikt de Get-Member cmdlet om de gebeurtenissen weer te geven die beschikbaar zijn voor timerobjecten. De opdracht gebruikt de parameter Type van de Get-Member cmdlet met de waarde Gebeurtenis.

$Timer = New-Object Timers.Timer
$Timer | Get-Member -Type Event

TypeName: System.Timers.Timer

Name     MemberType Definition
----     ---------- ----------
Disposed Event      System.EventHandler Disposed(System.Object, System.EventArgs)
Elapsed  Event      System.Timers.ElapsedEventHandler Elapsed(System.Object, System.Timers.ElapsedEventArgs)

Register-ObjectEvent -InputObject $Timer -EventName Elapsed -SourceIdentifier Timer.Elapsed
Get-EventSubscriber

SubscriptionId   : 4
SourceObject     : System.Timers.Timer
EventName        : Elapsed
SourceIdentifier : Timer.Elapsed
Action           :
HandlerDelegate  :
SupportEvent     : False
ForwardEvent     : False

De derde opdracht gebruikt de Register-ObjectEvent cmdlet om u te registreren voor de gebeurtenis Verstreken in het timerobject.

De vierde opdracht gebruikt de Get-EventSubscriber cmdlet om de gebeurtenisabonnee op te halen voor de verstreken gebeurtenis.

Voorbeeld 2: Gebruik de dynamische module in PSEventJob in de eigenschap Actie van de gebeurtenisabonnee

In dit voorbeeld ziet u hoe u de dynamische module gebruikt in het PSEventJob-object in de eigenschap Actie van de gebeurtenisabonnee.

De eerste opdracht gebruikt de New-Object cmdlet om een timerobject te maken. Met de tweede opdracht wordt het interval van de timer ingesteld op 500 (milliseconden).

$Timer = New-Object Timers.Timer
$Timer.Interval = 500
$params = @{
    InputObject = $Timer
    EventName = 'Elapsed'
    SourceIdentifier = 'Timer.Random'
    Action = { $Random = Get-Random -Min 0 -Max 100 }
}
Register-ObjectEvent @params

Id  Name           State      HasMoreData  Location  Command
--  ----           -----      -----------  --------  -------
3   Timer.Random   NotStarted False                  $Random = Get-Random ...

$Timer.Enabled = $True
$Subscriber = Get-EventSubscriber -SourceIdentifier Timer.Random
($Subscriber.action).gettype().fullname

System.Management.Automation.PSEventJob

$Subscriber.action | Format-List -Property *

State         : Running
Module        : __DynamicModule_6b5cbe82-d634-41d1-ae5e-ad7fe8d57fe0
StatusMessage :
HasMoreData   : True
Location      :
Command       : $random = Get-Random -Min 0 -Max 100
JobStateInfo  : Running
Finished      : System.Threading.ManualResetEvent
InstanceId    : 88944290-133d-4b44-8752-f901bd8012e2
Id            : 1
Name          : Timer.Random
ChildJobs     : {}
...

& $Subscriber.action.module {$Random}

De derde opdracht gebruikt de Register-ObjectEvent cmdlet om de verstreken gebeurtenis van het timerobject te registreren. De opdracht bevat een actie waarmee de gebeurtenis wordt verwerkt. Wanneer het timerinterval is verstreken, wordt er een gebeurtenis gegenereerd en worden de opdrachten in de actieuitvoering uitgevoerd. In dit geval genereert de Get-Random cmdlet een willekeurig getal tussen 0 en 100 en slaat deze op in de $Random variabele. De bron-id van de gebeurtenis is Timer.Random.

Wanneer u een actieparameter in een Register-ObjectEvent opdracht gebruikt, retourneert de opdracht een PSEventJob-object dat de actie vertegenwoordigt.

Met de vierde opdracht wordt de timer ingeschakeld.

De vijfde opdracht gebruikt de Get-EventSubscriber cmdlet om de gebeurtenisabonnee van de timer.random-gebeurtenis op te halen. Het object gebeurtenisabonnee wordt opgeslagen in de $Subscriber variabele.

De zesde opdracht laat zien dat de eigenschap Action van het object gebeurtenisabonnee een PSEventJob-object bevat. Het bevat zelfs hetzelfde PSEventJob-object dat door de Register-ObjectEvent opdracht is geretourneerd.

De zevende opdracht gebruikt de Format-List cmdlet om alle eigenschappen van het PSEventJob-object weer te geven in de eigenschap Action in een lijst. Het resultaat laat zien dat het PSEventJob-object een moduleeigenschap bevat die een dynamische scriptmodule bevat waarmee de actie wordt geïmplementeerd.

De resterende opdrachten gebruiken de aanroepoperator (&) om de opdracht in de module aan te roepen en de waarde van de $Random variabele weer te geven. U kunt de aanroepoperator gebruiken om een opdracht in een module aan te roepen, inclusief opdrachten die niet worden geëxporteerd. In dit geval geven de opdrachten het willekeurige getal weer dat wordt gegenereerd wanneer de verstreken gebeurtenis plaatsvindt.

Zie about_Modules voor meer informatie over modules.

Voorbeeld 3: Verborgen gebeurtenisabonnees ophalen

In dit voorbeeld wordt een gebeurtenisabonnee geregistreerd voor de PowerShell.Exiting-gebeurtenis . Het abonnement wordt geregistreerd met de parameter SupportEvent , waardoor de gebeurtenisabonnee wordt verborgen in de standaarduitvoer van de Get-EventSubscriber cmdlet. U moet de parameter Force gebruiken om alle gebeurtenisabonnees op te halen, inclusief verborgen abonnees.

Register-EngineEvent -SourceIdentifier PowerShell.Exiting -SupportEvent -Action {
    Get-History | Export-Clixml d:\temp\history.clixml
}
Get-EventSubscriber  # No output - must use -Force
Get-EventSubscriber -Force

SubscriptionId   : 1
SourceObject     :
EventName        :
SourceIdentifier : PowerShell.Exiting
Action           : System.Management.Automation.PSEventJob
HandlerDelegate  :
SupportEvent     : True
ForwardEvent     : False

Parameters

-Force

Geeft aan dat met deze cmdlet alle gebeurtenisabonnees worden ophaalt, inclusief abonnees voor gebeurtenissen die zijn verborgen met behulp van de parameter SupportEvent van Register-ObjectEvent, Register-WmiEventen Register-EngineEvent.

Type:SwitchParameter
Position:1
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-SourceIdentifier

Hiermee geeft u de eigenschapswaarde SourceIdentifier op die alleen de gebeurtenisabonnees ontvangt. Haalt standaard Get-EventSubscriber alle gebeurtenisabonnees op in de sessie. Jokertekens zijn niet toegestaan. Deze parameter is hoofdlettergevoelig.

Type:String
Position:0
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-SubscriptionId

Hiermee geeft u de abonnements-id op die door deze cmdlet wordt opgehaald. Haalt standaard Get-EventSubscriber alle gebeurtenisabonnees op in de sessie.

Type:Int32
Aliassen:Id
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

Invoerwaarden

None

U kunt geen objecten doorsluisen naar deze cmdlet.

Uitvoerwaarden

PSEventSubscriber

Deze cmdlet retourneert een PSEventSubscriber-object voor elke gebeurtenisabonnee.

Notities

De New-Event cmdlet, waarmee een aangepaste gebeurtenis wordt gemaakt, genereert geen abonnee. Daarom vindt de Get-EventSubscriber cmdlet geen abonneeobject voor deze gebeurtenissen. Als u echter de Register-EngineEvent cmdlet gebruikt om u te abonneren op een aangepaste gebeurtenis (om de gebeurtenis door te sturen of een actie op te geven), Get-EventSubscriber wordt de abonnee gevonden die Register-EngineEvent wordt gegenereerd.

Gebeurtenissen, gebeurtenisabonnementen en de gebeurteniswachtrij bestaan alleen in de huidige sessie. Als u de huidige sessie sluit, wordt de gebeurteniswachtrij verwijderd en wordt het gebeurtenisabonnement geannuleerd.