Get-EventSubscriber

Get-EventSubscriber コマンドレットは、現在のセッションのイベント サブスクライバーを取得します。

Register イベント コマンドレットを使用してイベントをサブスクライブすると、イベント サブスクライバーが Windows PowerShell セッションに追加され、サブスクライブしたイベントが発生するたびにイベント キューに追加されます。 イベント サブスクリプションを取り消すには、Unregister-Event コマンドレットを使用してイベント サブスクライバーを削除します。

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 コマンドレットを使用して、タイマー オブジェクトのインスタンスを作成します。 新しいタイマー オブジェクトを $Timer 変数に保存します。

2 番目のコマンドでは、Get-Member コマンドレットを使用して、タイマー オブジェクトで使用できるイベントを表示します。 このコマンドでは、 Get-Member コマンドレットの Type パラメーターと Event の値を使用します。

3 番目のコマンドでは、Register-ObjectEvent コマンドレットを使用して、タイマー オブジェクトの Elapsed イベントに登録します。

4 番目のコマンドでは、 Get-EventSubscriber コマンドレットを使用して、Elapsed イベントのイベント サブスクライバーを取得します。

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

3 番目のコマンドでは、Register-ObjectEvent コマンドレットを使用して、タイマー オブジェクトの Elapsed イベントを登録します。 このコマンドには、イベントを処理するアクションが含まれています。 タイマー間隔が経過するたびに、イベントが発生し、アクション内のコマンドが実行されます。 この場合、Get-Random コマンドレットは 0 から 100 までの乱数を生成し、それを $Random 変数に保存します。 イベントのソース識別子は Timer.Random です。

コマンドで Action パラメーターを Register-ObjectEvent 使用すると、コマンドはアクションを表す PSEventJob オブジェクトを返します。

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

5 番目のコマンドでは、 Get-EventSubscriber コマンドレットを使用して、Timer.Random イベントのイベント サブスクライバーを取得します。 イベント・サブスクライバー・オブジェクトを$Subscriber変数に保存します。

6 番目のコマンドは、イベント サブスクライバー オブジェクトの Action プロパティに PSEventJob オブジェクトが含まれていることを示しています。 実際、これには Register-ObjectEvent コマンドが返したのと同じ PSEventJob オブジェクトが含まれています。

7 番目のコマンドでは、Format-List コマンドレットを使用して、リスト内の Action プロパティに PSEventJob オブジェクトのすべてのプロパティを表示します。 その結果、PSEventJob オブジェクトに、アクションを実装する動的スクリプト モジュールを含む Module プロパティが含まれていることが明らかになります。

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

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

None

このコマンドレットに入力をパイプすることはできません。

PSEventSubscriber

Get-EventSubscriber は、各イベント サブスクライバーを表すオブジェクトを返します。

• カスタム イベントを作成する New-Event コマンドレットでは、サブスクライバーは生成されません。 したがって、 Get-EventSubscriber コマンドレットは、これらのイベントのサブスクライバー オブジェクトを見つけられません。 ただし、Register-EngineEvent コマンドレットを使用してカスタム イベントをサブスクライブする場合 (イベントの転送またはアクションの指定のため)、 Get-EventSubscriber は Register-EngineEvent が生成するサブスクライバーを検索します。

  イベント、イベント サブスクリプション、およびイベント キューは、現在のセッションにのみ存在します。 現在のセッションを閉じると、イベント キューは破棄され、イベント サブスクリプションは取り消されます。