Register-EngineEvent

Register-EngineEvent
    [-SourceIdentifier] <String>
    [[-Action] <ScriptBlock>]
    [-MessageData <PSObject>]
    [-SupportEvent]
    [-Forward]
    [-MaxTriggerCount <Int32>]
    [<CommonParameters>]

Register-EngineEvent cmdlet 订阅 PowerShell 引擎和 New-Event cmdlet 生成的事件。 使用 SourceIdentifier 参数指定事件。

可以使用此 cmdlet 订阅 OnIdle 或 Exiting 引擎事件和由 New-Event cmdlet 生成的事件。 这些事件会自动添加到会话中的事件队列，而无需订阅。 但是，订阅允许转发事件、指定响应事件的操作以及取消订阅。

当您订阅一个事件时，一个事件订阅者将被添加到您的当前会话中。 若要获取会话中的事件订阅者，请使用 Get-EventSubscriber cmdlet。 若要取消订阅，请使用 Unregister-Event cmdlet，从会话中删除事件订阅者。

当引发已订阅的事件时，它将添加到你的会话中的事件队列。 若要获取事件队列中的事件，请使用 Get-Event cmdlet。

此示例在两台远程计算机上注册 PowerShell 引擎事件。

$S = New-PSSession -ComputerName "Server01, Server02"
Invoke-Command -Session $S {
  Register-EngineEvent -SourceIdentifier ([System.Management.Automation.PSEngineEvent]::Exiting) -Forward
}

New-PSSession 在每个远程计算机上创建用户管理的会话（PSSession）。Invoke-Command cmdlet 在远程会话中运行 Register-EngineEvent 命令。 Register-EngineEvent 使用 SourceIdentifier 参数来标识事件。 Forward 参数告知引擎将事件从远程会话转发到本地会话。

此示例演示如何在发生 Register-EngineEvent 事件时运行 以执行特定操作。

Register-EngineEvent -SourceIdentifier PowerShell.Exiting -SupportEvent -Action {
    Get-History | Export-Clixml $HOME\history.clixml
}

添加了 SupportEvent 参数以隐藏事件订阅。 PowerShell 退出时，在这种情况下，退出会话中的命令历史记录将导出用户 $HOME 目录中的 XML 文件。

此示例用于为源 MyEventSource的事件创建一个订阅。 这是一个我们将用于监控工作进度的随机来源。 Register-EngineEvent 用于创建订阅。 Action 参数的脚本块将事件数据记录到文本文件中。

Register-EngineEvent -SourceIdentifier MyEventSource -Action {
    "Event: {0}" -f $Event.MessageData | Out-File C:\temp\MyEvents.txt -Append
}

Start-Job -Name TestJob -ScriptBlock {
    while ($true) {
        Register-EngineEvent -SourceIdentifier MyEventSource -Forward
        Start-Sleep -Seconds 2
        "Doing some work..."
        $newEventSplat = @{
            SourceIdentifier = 'MyEventSource'
            MessageData      = ("{0} -  Work done..." -f (Get-Date))
        }
        New-Event @newEventSplat
    }
}
Start-Sleep -Seconds 4
Get-EventSubscriber
Get-Job

SubscriptionId   : 12
SourceObject     :
EventName        :
SourceIdentifier : MyEventSource
Action           : System.Management.Automation.PSEventJob
HandlerDelegate  :
SupportEvent     : False
ForwardEvent     : False

Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
18     MyEventSource                   Running       True                                 …
19     TestJob         BackgroundJob   Running       True            localhost            …

Register-EngineEvent 创建了作业 ID 18。 Start-Job 已创建作业 ID 为 19。 在示例 #4 中，我们删除事件订阅和作业，然后检查日志文件。

这是示例 3 的延续。 在此示例中，我们等待 10 秒，让多个事件发生。 然后，我们注销事件订阅。

PS> Start-Sleep -Seconds 10
PS> Get-EventSubscriber | Unregister-Event
PS> Get-Job

Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
18     MyEventSource                   Stopped       False                                …
19     TestJob         BackgroundJob   Running       True            localhost            …

PS> Stop-Job -Id 19
PS> Get-Job | Remove-Job
PS> Get-Content C:\temp\MyEvents.txt
Event: 2/18/2020 2:36:19 PM -  Work done...
Event: 2/18/2020 2:36:21 PM -  Work done...
Event: 2/18/2020 2:36:23 PM -  Work done...
Event: 2/18/2020 2:36:25 PM -  Work done...
Event: 2/18/2020 2:36:27 PM -  Work done...
Event: 2/18/2020 2:36:29 PM -  Work done...
Event: 2/18/2020 2:36:31 PM -  Work done...

Unregister-Event cmdlet 将停止与事件订阅关联的作业（作业 ID 18）。 作业 ID 19 仍在运行并创建新事件。 我们使用 作业 命令行小程序来停止作业并删除不需要的作业对象。 Get-Content 显示日志文件的内容。

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

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

默认情况下，此 cmdlet 不返回任何输出。

使用 Action 参数时，此 cmdlet 将返回 PSEventJob 对象。

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

订阅 Exiting 事件时，Action 参数可执行的 cmdlet 仅限于 Microsoft.PowerShell.Core 和 Microsoft.PowerShell.Utility 模块中的 cmdlet。 仅当会话在 PowerShell 的控制下退出会话时，才会触发 Exiting 事件。 当主机应用程序或终端窗口关闭时，不会触发该事件。

如果引擎未运行管道，则被视为处于空闲状态。 当 PowerShell 空闲达到 300 毫秒 (ms) 时，将触发 OnIdle 事件。