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 コマンドは、バックグラウンド ジョブとして実行されるアクションを表すジョブ オブジェクトを返します。Get-Job や Receive-Job などの 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

説明
-----------
この例は、リモート コンピューターのオブジェクト イベントにサブスクライブする方法を示しています。

最初のコマンドは、2 台のリモート コンピューターに PSSession を作成し、それらを $s 変数に保存します。

2 番目のコマンドは、Invoke-Command コマンドレットの FilePath パラメーターを使用して、$s 内の各 PSSession で ProcessCreationEvent.ps1 スクリプトを実行します。

このスクリプトには、ManagementEventWatcher オブジェクトとその EventArrived イベントを介して Win32_Process オブジェクトのインスタンス作成イベントにサブスクライブする Register-ObjectEvent コマンドが含まれています。

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 コマンドレットを使用してタイマー オブジェクトを作成します。2 番目のコマンドは、タイマーの間隔を 500 (ミリ秒) に設定します。

3 番目のコマンドは、Register-ObjectEvent コマンドレットを使用して、タイマー オブジェクトの Elapsed イベントを登録します。このコマンドには、イベントを処理するアクションが指定されています。タイマーの間隔が経過するたびに、イベントが発生し、このアクションに指定されたコマンドが実行されます。ここでは、Get-Random コマンドレットによって、0 ～ 100 の乱数が生成されて、$random 変数に保存されます。

Register-ObjectEvent コマンドに Action パラメーターを指定すると、そのアクションを表す PSEventJob オブジェクトが返されます。このコマンドは、ジョブ オブジェクトを $job 変数に保存します。

Register-ObjectEvent コマンドレットが返す PSEventJob オブジェクトも、イベント サブスクライバーの Action プロパティで使用できます。詳細については、「Get-EventSubscriber」を参照してください。

4 番目のコマンドは、$job 変数に PSEventJob オブジェクトが格納されていることを示しています。5 番目のコマンドは、Format-List コマンドレットを使用して、PSEventJob オブジェクトのプロパティをすべて一覧表示します。

PSEventJob には Module プロパティが存在し、そのプロパティに、アクションを実装する動的スクリプト モジュールが含まれています。

6 番目のコマンドは、タイマーを有効にします。

残りのコマンドは、呼び出し演算子 (&) を使用し、モジュール内のコマンドを呼び出して、$random 変数の値を表示します。呼び出し演算子を使用すると、エクスポートされないコマンドを含め、モジュール内のコマンドを自由に呼び出すことができます。ここでは、Elapsed イベントの発生時に生成される乱数を表示しています。

モジュールの詳細については、「about_Modules」を参照してください。