Get-EventSubscriber

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

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

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

使用 Register 事件 cmdlet 订阅事件时，事件订阅者会添加到 Windows PowerShell 会话，并在引发事件队列时将订阅的事件添加到事件队列。 若要取消事件订阅，请使用 Unregister-Event cmdlet 删除事件订阅服务器。

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

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

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

$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

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

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

此示例演示如何在事件订阅服务器的 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 注册计时器对象的已用事件。 该命令包括处理事件的操作。 每当计时器间隔过时，将引发事件并运行操作中的命令。 在这种情况下，Get-Random cmdlet 将生成介于 0 和 100 之间的随机数，并将其保存在 $Random 变量中。 事件的源标识符为 Timer.Random。

在命令中使用 Register-ObjectEventAction 参数时，该命令返回表示作的 PSEventJob 对象。

第四个命令启用计时器。

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

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

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

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

有关模块的详细信息，请参阅 about_Modules。

此示例为 PowerShell.Exiting 事件注册事件订阅服务器。 订阅是使用 SupportEvent 参数注册的，该参数将事件订阅者从 cmdlet 的默认输出 Get-EventSubscriber 中隐藏。 必须使用 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

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

不能用管道将对象传送到此 cmdlet。

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

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

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