获取事件订阅者 (Microsoft.PowerShell.Utility)

Get-EventSubscriber

获取当前会话中的事件订阅者。

句法

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

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

描述

Get-EventSubscriber cmdlet 获取当前会话中的事件订阅者。

当您使用注册事件 cmdlet 订阅事件时，事件订阅者将添加到您的 Windows PowerShell 会话中，并且您订阅的事件在引发时都会添加到事件队列中。要取消事件订阅，请使用 Unregister-Event cmdlet 删除事件订阅者。

示例

示例 1：获取计时器事件的事件订阅者

此示例使用 Get-EventSubscriber 命令获取计时器事件的事件订阅者。

第一个命令使用 New-Object cmdlet 创建计时器对象的实例。它将新的计时器对象保存在 $Timer 变量中。

第二个命令使用 Get-Member cmdlet 显示可用于计时器对象的事件。该命令使用 Get-Member cmdlet 的 Type 参数，其值为 Event。

$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

第三条命令使用 Register-ObjectEvent cmdlet 注册计时器对象上的 Elapsed 事件。

第四条命令使用 Get-EventSubscriber cmdlet 获取 Elapsed 事件的事件订阅者。

示例2：在事件订阅者的Action属性中使用PSEventJob中的动态模块

此示例演示如何使用事件订阅者的 Action 属性中的 PSEventJob 对象中的动态模块。

第一个命令使用 New-Object cmdlet 创建计时器对象。第二条命令将计时器的间隔设置为 500（毫秒）。

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

第三条命令使用 Register-ObjectEvent cmdlet 注册计时器对象的 Elapsed 事件。该命令包含处理事件的操作。每当计时器间隔过去时，就会引发一个事件并运行操作中的命令。在本例中，Get-Random cmdlet 生成 0 到 100 之间的随机数，并将其保存在 $Random 变量中。事件的源标识符是Timer.Random。

当您在 Register-ObjectEvent 命令中使用 Action 参数时，该命令将返回表示操作的 PSEventJob 对象。

第四条命令启用定时器。

第五个命令使用 Get-EventSubscriber cmdlet 获取 Timer.Random 事件的事件订阅者。它将事件订阅者对象保存在 $Subscriber 变量中。

第六个命令显示事件订阅者对象的 Action 属性包含一个 PSEventJob 对象。事实上，它包含与 Register-ObjectEvent 命令返回的相同的 PSEventJob 对象。

第七个命令使用 Format-List cmdlet 以列表的形式显示 Action 属性中 PSEventJob 对象的所有属性。结果表明，PSEventJob 对象具有一个 Module 属性，其中包含实现该操作的动态脚本模块。

其余命令使用调用运算符 (&) 来调用模块中的命令并显示 $Random 变量的值。您可以使用 call 运算符调用模块中的任何命令，包括未导出的命令。在这种情况下，命令显示发生 Elapsed 事件时生成的随机数。

有关模块的更多信息，请参阅 about_Modules。

示例 3：获取隐藏的事件订阅者

此示例注册 PowerShell.Exiting 事件的事件订阅者。订阅是使用 SupportEvent 参数注册的，该参数在 Get-EventSubscriber cmdlet 的默认输出中隐藏事件订阅者。您必须使用Force参数来获取所有事件订阅者，包括隐藏的订阅者。

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

参数

-Force

指示此 cmdlet 获取所有事件订阅者，包括使用 Register-ObjectEvent、Register-WmiEvent 的 SupportEvent 参数隐藏的事件订阅者和Register-EngineEvent。

SwitchParameter

1

None

False

False

False

-SourceIdentifier

指定仅获取事件订阅者的 SourceIdentifier 属性值。默认情况下，Get-EventSubscriber 获取会话中的所有事件订阅者。不允许使用通配符。该参数区分大小写。

String

0

None

False

True

False

-SubscriptionId

指定此 cmdlet 获取的订阅标识符。默认情况下，Get-EventSubscriber 获取会话中的所有事件订阅者。

整数32

Id

0

None

True

True

False

输入

无

您无法通过管道将对象传递到此 cmdlet。

输出

PSEventSubscriber

此 cmdlet 为每个事件订阅者返回一个 PSEventSubscriber 对象。

笔记

创建自定义事件的 New-Event cmdlet 不会生成订阅者。因此，Get-EventSubscriber cmdlet 将找不到这些事件的订阅者对象。但是，如果您使用 Register-EngineEvent cmdlet 订阅自定义事件（为了转发事件或指定操作），Get-EventSubscriber 将找到Register-EngineEvent 生成的订阅者。

事件、事件订阅和事件队列仅存在于当前会话中。如果关闭当前会话，事件队列将被丢弃，事件订阅也会被取消。