Get-EventSubscriber

参考

模块:: Microsoft.PowerShell.Utility

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

语法

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

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

说明

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

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

示例

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

PS C:\> $Timer = New-Object Timers.Timer
PS C:\> $Timer | Get-Member -Type Event
PS C:\> Register-ObjectEvent -InputObject $Timer -EventName Elapsed -SourceIdentifier Timer.Elapsed
PS C:\> Get-EventSubscriber
PS C:\> $Timer = New-Object Timers.Timer
PS C:\> $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) PS C:\> Register-ObjectEvent -InputObject $Timer -EventName Elapsed -SourceIdentifier Timer.Elapsed
PS C:\> Get-EventSubscriber
SubscriptionId   : 4
SourceObject     : System.Timers.Timer
EventName        : Elapsed
SourceIdentifier : Timer.Elapsed
Action           :
HandlerDelegate  :
SupportEvent     : False
ForwardEvent     : False

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

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

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

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

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

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

PS C:\> $Timer = New-Object Timers.Timer
PS C:\> $Timer.Interval = 500
PS C:\> Register-ObjectEvent -InputObject $Timer -EventName Elapsed -SourceIdentifier Timer.Random -Action { $Random = Get-Random -Min 0 -Max 100 }

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

PS C:\> $Timer.Enabled = $True
PS C:\> $Subscriber = Get-EventSubscriber -SourceIdentifier Timer.Random
PS C:\> ($Subscriber.action).gettype().fullname
System.Management.Automation.PSEventJob
PS C:\> $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     : {}
...

PS C:\> & $Subscriber.action.module {$Random}
96
PS C:\> & $Subscriber.action.module {$Random}
23

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

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

第三个命令使用 Register-ObjectEvent cmdlet 注册计时器对象的已用事件。该命令包括处理事件的操作。每当计时器间隔过时，将引发事件并运行操作中的命令。在这种情况下，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变量的值。可以使用调用运算符调用模块中的任何命令，包括未导出的命令。在这种情况下，这些命令显示发生经过事件时生成的随机数。

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

参数

-Force

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

类型:	SwitchParameter
Position:	1
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SourceIdentifier

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

类型:	String
Position:	0
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-SubscriptionId

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

类型:	Int32
别名:	Id
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

输入

None

不能通过管道将输入传递给此 cmdlet。

输出

PSEventSubscriber

Get-EventSubscriber 返回表示每个事件订阅服务器的对象。

备注

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

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

通过