Get-EventSubscriber

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

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

L’applet de commande Get-EventSubscriber obtient les abonnés aux événements dans la session active.

Lorsque vous vous abonnez à un événement à l’aide d’une applet de commande Inscrire un événement, un abonné aux événements est ajouté à votre session Windows PowerShell et les événements auxquels vous vous êtes abonné sont ajoutés à votre file d’attente d’événements chaque fois qu’ils sont déclenchés. Pour annuler un abonnement aux événements, supprimez l’abonné à l’événement à l’aide de l’applet de commande Unregister-Event.

Cet exemple utilise une commande Get-EventSubscriber pour obtenir l’abonné aux événements pour un événement de minuteur.

La première commande utilise l’applet de commande New-Object pour créer une instance d’un objet minuteur. Il enregistre le nouvel objet minuteur dans la variable $Timer.

La deuxième commande utilise l’applet de commande Get-Member pour afficher les événements disponibles pour les objets du minuteur. La commande utilise le paramètre Type de l’applet de commande Get-Member avec une valeur d’événement.

$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)

$params = @{
    InputObject = $Timer
    EventName = 'Elapsed'
    SourceIdentifier = 'Timer.Elapsed'
}
Register-ObjectEvent @params
Get-EventSubscriber

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

La troisième commande utilise l’applet de commande Register-ObjectEvent pour s’inscrire à l’événement de écoulé sur l’objet minuteur.

La quatrième commande utilise l’applet de commande Get-EventSubscriber pour obtenir l’abonné à l’événement Elapsed.

Cet exemple montre comment utiliser le module dynamique dans l’objet PSEventJob dans la propriété Action de l’abonné à l’événement.

La première commande utilise l’applet de commande New-Object pour créer un objet minuteur. La deuxième commande définit l’intervalle du minuteur sur 500 (millisecondes).

$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}

La troisième commande utilise l’applet de commande Register-ObjectEvent pour inscrire l’événement Écoulé de l’objet minuteur. La commande inclut une action qui gère l’événement. Chaque fois que l’intervalle du minuteur s’écoule, un événement est déclenché et les commandes de l’exécution de l’action. Dans ce cas, l’applet de commande Get-Random génère un nombre aléatoire compris entre 0 et 100 et l’enregistre dans la variable $Random. L’identificateur source de l’événement est Timer.Random.

Lorsque vous utilisez un paramètre Action dans une commande Register-ObjectEvent, la commande renvoie un objet PSEventJob qui représente l’action.

La quatrième commande active le minuteur.

La cinquième commande utilise l’applet de commande Get-EventSubscriber pour obtenir l’abonné à l’événement Timer.Random. Il enregistre l’objet abonné aux événements dans la variable $Subscriber.

La sixième commande indique que la propriété Action de l’objet abonné à l’événement contient un objet PSEventJob. En fait, il contient le même objet PSEventJob que la commande Register-ObjectEvent retournée.

La septième commande utilise l’applet de commande Format-List pour afficher toutes les propriétés de l’objet PSEventJob dans la propriété Action d’une liste. Le résultat révèle que l’objet PSEventJob a une propriété Module qui contient un module de script dynamique qui implémente l’action.

Les commandes restantes utilisent l’opérateur d’appel (&) pour appeler la commande dans le module et afficher la valeur de la variable $Random. Vous pouvez utiliser l’opérateur d’appel pour appeler n’importe quelle commande dans un module, y compris les commandes qui ne sont pas exportées. Dans ce cas, les commandes affichent le nombre aléatoire généré lorsque l’événement Écoulé se produit.

Pour plus d’informations sur les modules, consultez about_Modules.

Cet exemple inscrit un abonné d’événement pour l’événement PowerShell.Exiting. L’abonnement est inscrit à l’aide du paramètre SupportEvent, qui masque l’abonné à l’événement de la sortie par défaut de l’applet de commande Get-EventSubscriber. Vous devez utiliser le paramètre Forcer pour obtenir tous les abonnés aux événements, y compris les abonnés masqués.

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

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Vous ne pouvez pas diriger les objets vers cette applet de commande.

Cette applet de commande retourne un objet PSEventSubscriber pour chaque abonné aux événements.

L’applet de commande New-Event, qui crée un événement personnalisé, ne génère pas d’abonné. Par conséquent, l’applet de commande Get-EventSubscriber ne trouve pas d’objet abonné pour ces événements. Toutefois, si vous utilisez l’applet de commande Register-EngineEvent pour vous abonner à un événement personnalisé (afin de transférer l’événement ou de spécifier une action), Get-EventSubscriber recherche l’abonné généré par Register-EngineEvent.

Les événements, les abonnements aux événements et la file d’attente d’événements existent uniquement dans la session active. Si vous fermez la session active, la file d’attente d’événements est ignorée et l’abonnement à l’événement est annulé.