Get-EventSubscriber
取得目前工作階段中的事件訂閱者。
Syntax
Get-EventSubscriber
[[-SourceIdentifier] <String>]
[-Force]
[<CommonParameters>] Get-EventSubscriber
[-SubscriptionId] <Int32>
[-Force]
[<CommonParameters>] Description
Get-EventSubscriber Cmdlet 會取得目前會話中的事件訂閱者。
當您使用 Register 事件 Cmdlet 訂閱事件時，事件訂閱者會新增至您的 PowerShell 會話，而且每當引發事件時，您訂閱的事件就會新增至事件佇列。 若要取消事件訂閱，請使用 Unregister-Event Cmdlet 刪除事件訂閱者。
範例
範例 1：取得定時器事件的事件訂閱者
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 Cmdlet 建立一個計時器物件執行個體。 它會將新的定時器物件儲存在$Timer變數中。
第二個命令使用 Get-Member Cmdlet 顯示可供計時器物件使用的事件。 此命令會使用 Get-Member Cmdlet 的 Type 參數搭配 Event 值。
第三個命令使用 Register-ObjectEvent Cmdlet 登錄計時器物件的 Elapsed 事件。
第四個命令會使用 Get-EventSubscriber Cmdlet 來取得經過事件的事件訂閱者。
範例 2：在事件訂閱者的 Action 屬性中使用 PSEventJob 中的動態模組
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 Cmdlet 來建立計時器物件。 第二個命令將計時器的間隔設定為 500 (毫秒)。
第三個命令使用 Register-ObjectEvent Cmdlet 來登錄計時器物件的 Elapsed 事件。 此命令包含一個處理事件的動作。 每當計時器的間隔經過之後，就會引發事件，而動作中的命令也會執行。 在此情況下，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變數的值。 您可以使用呼叫運算子來叫用模組中的任何命令，包括未匯出的命令。 在此情況下，這些命令會顯示 Elapsed 事件發生時所產生的隨機數字。
如需模組的詳細資訊，請參閱 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。
輸出
Get-EventSubscriber 會傳回代表每個事件訂閱者的物件。
備註
New-Event Cmdlet 建立自訂事件，不會產生訂閱者。 因此， Get-EventSubscriber Cmdlet 找不到這些事件的訂閱者物件。 不過，如果您使用 Register-EngineEvent Cmdlet 來訂閱自定義事件 (，以便轉送事件或指定動作 ) ，Get-EventSubscriber 會尋找 Register-EngineEvent 產生的訂閱者。
事件、事件訂閱與事件佇列僅存在目前工作階段中。 若關閉目前工作階段，便會捨棄事件佇列，並取消事件訂閱。