Share via

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：获取计时器事件的事件订阅服务器

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

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

第二个命令使用 Get-Member cmdlet 来显示可用于计时器对象的事件。 该命令将 Get-Member cmdlet 的 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)

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 注册计时器对象上的已用时间事件。

第四个命令使用 Get-EventSubscriber 获取已用时间事件的事件订阅服务器。

示例 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 注册计时器对象的已用时间事件。 该命令包含处理事件的操作。 每当计时器时间间隔过后，将引发一个事件，而且运行操作中的命令。 在这种情况下，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 参数隐藏的事件的订阅服务器。

Type:SwitchParameter
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SourceIdentifier

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

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionId

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

Type:Int32
Aliases:Id
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

输入

None

不能通过管道将对象传递给此 cmdlet。

输出

PSEventSubscriber

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

备注

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

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