Register-ObjectEvent

Register-ObjectEvent [-InputObject] <psobject> [-EventName] <string> [[-SourceIdentifier] <string>] [[-Action] <scriptblock>] [-Forward] [-MessageData <psobject>] [-SupportEvent] [<CommonParameters>]

C:\PS>$query = New-Object System.Management.WqlEventQuery "__InstanceCreationEvent", (New-Object TimeSpan 0,0,1), "TargetInstance isa 'Win32_Process'" 

C:\PS> $processWatcher = New-Object System.Management.ManagementEventWatcher $query 

C:\PS> register-objectEvent -inputObject $processWatcher -eventName "EventArrived"

描述
-----------
這個範例會訂閱當新處理序啟動時產生的事件。

這個範例中的命令會使用 ManagementEventWatcher 物件取得 EventArrived 事件。查詢物件會指定事件是 Win32_Process 類別的執行個體建立事件。

C:\PS>$query = New-Object System.Management.WqlEventQuery "__InstanceCreationEvent", (New-Object TimeSpan 0,0,1), "TargetInstance isa 'Win32_Process'" 

C:\PS> $processWatcher = New-Object System.Management.ManagementEventWatcher $query 

C:\PS> $action = { New-Event "PowerShell.ProcessCreated" -Sender $sender -EventArguments $SourceEventArgs.NewEvent.TargetInstance } 

C:\PS> register-objectEvent -inputObject $processWatcher -eventName "EventArrived" -action $action

Id    Name            State      HasMoreData     Location             Command
--    ----            -----      -----------     --------             -------
2     422cfe5a-65e... Running    True                                 New-Event "PowerShe...

描述
-----------
這個範例示範如何指定要回應事件的動作。指定動作時，所引發的事件不會新增至事件佇列。不過，該動作會回應事件。

在這個範例中，引發執行個體建立事件，表示新的處理啟動而引發新的 ProcessCreated 事件。

該動作會使用僅針對事件動作填入的 $Sender 和 $SourceEventArgs 自動變數。

Register-ObjectEvent 命令會傳回代表動作的工作物件，它會以背景工作的方式執行。您可以使用 Job Cmdlet (例如 Get-Job 和 Receive-Job) 管理背景工作。

如需詳細資訊，請參閱 about_Jobs。

C:\PS>$s = new-pssession -computername Server01, Server02

C:\PS> invoke-command -session $s -filepath ProcessCreationEvent.ps1

C:\PS> invoke-command -session $s { get-event }

# ProcessCreationEvent.ps1

function Enable-ProcessCreationEvent 
{ 
   $query = New-Object System.Management.WqlEventQuery "__InstanceCreationEvent", ` 
       (New-Object TimeSpan 0,0,1), ` 
       "TargetInstance isa 'Win32_Process'" 
   $processWatcher = New-Object System.Management.ManagementEventWatcher $query 

   $identifier = "WMI.ProcessCreated" 
   Register-ObjectEvent -input $processWatcher -eventName "EventArrived" `
      -sourceIdentifier $identifier -messageData "Test" -forward 
   } 
} 

EnableProcessCreationEvent

描述
-----------
這個範例示範在遠端電腦上訂閱物件事件。

第一個命令會在兩台遠端電腦上建立 PSSessions，然後將它們儲存到 $s 變數。

第二個命令會使用 Invoke-Command Cmdlet 的 FilePath 參數，在 $s 的每個 PSSession 內執行 ProcessCreationEvent.ps1 指令碼。

此指令碼內含的 Register-ObjectEvent 命令會透過 ManagementEventWatcher 物件及其 EventArrived 事件，訂閱 Win32_Process 物件上的執行個體建立事件。

C:\PS>$timer  = New-Object Timers.Timer

C:\PS> $timer.Interval = 500

C:\PS> $job = Register-ObjectEvent -inputObject $timer -eventName Elapsed -sourceIdentifier Timer.Random -Action {$random = Get-Random -Min 0 -Max 100}

C:\PS> $job.gettype().fullname
System.Management.Automation.PSEventJob

C:\PS> $job | 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     : {}
...

C:\PS> $timer.Enabled = $true

C:\PS> & $job.module {$random}
60

C:\PS> & $job.module {$random}
47

描述
-----------
這個範例會示範如何將動態模組用於您在事件註冊中包含 Action 時所建立的 PSEventJob 物件中。

第一個命令會使用 New-Object Cmdlet 來建立計時器物件。第二個命令會將計時器的間隔設定為 500 (毫秒)。

第三個命令會使用 Register-ObjectEvent Cmdlet 來註冊計時器物件的 Elapsed 事件。該命令包含處理事件的動作。每當經過計時器間隔時，就會引發事件並且執行動作中的命令。在這個範例中，Get-Random Cmdlet 會產生介於 0 與 100 之間的亂數並將它儲存在 $random 變數中。

當您在 Register-ObjectEvent 命令中使用 Action 參數時，該命令就會傳回代表動作的 PSEventJob 物件，再將工作物件儲存在 $job 變數中。

Register-ObjectEvent Cmdlet 所傳回的 PSEventJob 物件也可以用於事件訂閱者的 Action 屬性中。如需詳細資訊，請參閱 Get-EventSubscriber。

第四個命令會顯示 $job 變數包含 PSEventJob 物件。第五個命令會使用 Format-List Cmdlet，以清單顯示 PSEventJob 物件的所有屬性。

PSEventJob 具有 Module 屬性，其中包含實作動作的動態指令碼模組。

第六個命令會啟用計時器。

其他命令則使用呼叫運算子 (&) 來叫用模組中的命令並且顯示 $random 變數的值。您可以使用呼叫運算子來叫用模組中的任何命令，包括尚未匯出的命令。在這個範例中，這些命令會顯示發生 Elapsed 事件時所產生的亂數。

如需模組的詳細資訊，請參閱 about_Modules。