Get-EventSubscriber
取得目前會話中的事件訂閱者。
語法
BySource (預設值)
Get-EventSubscriber
[[-SourceIdentifier] <String>]
[-Force]
[<CommonParameters>]
ById
Get-EventSubscriber
[-SubscriptionId] <Int32>
[-Force]
[<CommonParameters>]
Description
Cmdlet 會 Get-EventSubscriber 取得目前會話中的事件訂閱者。
當您使用 Register 事件 Cmdlet 訂閱事件時，事件訂閱者會新增至您的 Windows PowerShell 會話，而您訂閱的事件會在引發事件佇列時新增至事件佇列。 若要取消事件訂閱，請使用 Unregister-Event Cmdlet 刪除事件訂閱者。
範例
範例 1：取得定時器事件的事件訂閱者
這個範例會使用 Get-EventSubscriber 命令來取得定時器事件的事件訂閱者。
第一個命令會 New-Object 使用 Cmdlet 來建立定時器對象的實例。 它會將新的定時器物件儲存在變數中 $Timer 。
第二個命令會 Get-Member 使用 Cmdlet 來顯示定時器物件可用的事件。 此命令會使用 Cmdlet 的 Get-Member Type 參數搭配 Event 值。
$Timer = New-Object Timers.Timer
$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)
Register-ObjectEvent -InputObject $Timer -EventName Elapsed -SourceIdentifier Timer.Elapsed
Get-EventSubscriber
SubscriptionId : 4
SourceObject : System.Timers.Timer
EventName : Elapsed
SourceIdentifier : Timer.Elapsed
Action :
HandlerDelegate :
SupportEvent : False
ForwardEvent : False
第三個命令會 Register-ObjectEvent 使用 Cmdlet 在定時器對象上註冊 Elapsed 事件。
第四個命令會 Get-EventSubscriber 使用 Cmdlet 來取得 Elapsed 事件的事件訂閱者。
範例 2：在事件訂閱者的 Action 屬性中使用 PSEventJob 中的動態模組
這個範例示範如何在事件訂閱者的 Action 屬性的 PSEventJob 物件中使用動態模組。
第一個命令會 New-Object 使用 Cmdlet 來建立定時器物件。 第二個命令會將定時器間隔設定為 500 （毫秒）。
$Timer = New-Object Timers.Timer
$Timer.Interval = 500
$params = @{
InputObject = $Timer
EventName = 'Elapsed'
SourceIdentifier = 'Timer.Random'
Action = { $Random = Get-Random -Min 0 -Max 100 }
}
Register-ObjectEvent @params
Id Name State HasMoreData Location Command
-- ---- ----- ----------- -------- -------
3 Timer.Random NotStarted False $Random = Get-Random ...
$Timer.Enabled = $True
$Subscriber = Get-EventSubscriber -SourceIdentifier Timer.Random
($Subscriber.action).gettype().fullname
System.Management.Automation.PSEventJob
$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 : {}
...
& $Subscriber.action.module {$Random}
第三個命令會 Register-ObjectEvent 使用 Cmdlet 來註冊定時器物件的 Elapsed 事件。 命令包含處理事件的動作。 每當定時器間隔經過時，就會引發事件，並在動作中執行命令。 在此情況下，Get-Random Cmdlet 會產生介於 0 到 100 之間的隨機數位，並將它儲存在 $Random 變數中。 事件的來源標識碼為 Timer.Random。
當您在命令中使用 Register-ObjectEvent 參數時，命令會傳回代表動作的 PSEventJob 物件。
第四個命令會啟用定時器。
第五個命令會 Get-EventSubscriber 使用 Cmdlet 來取得 Timer.Random 事件的事件訂閱者。 它會將事件訂閱者物件儲存在變數中 $Subscriber 。
第六個命令顯示事件訂閱者物件的 Action 屬性包含 PSEventJob 物件。 事實上，它包含命令傳回的相同 PSEventJob 物件 Register-ObjectEvent 。
第七個命令會 Format-List 使用 Cmdlet，在清單中的 Action 屬性中顯示 PSEventJob 物件的所有屬性。 結果顯示 PSEventJob 物件具有Module屬性，其中包含實作動作的動態腳本模組。
其餘命令會使用呼叫運算符 （&） 在模組中叫用 命令，並顯示$Random變數的值。 您可以使用呼叫運算符來叫用模組中的任何命令，包括未導出的命令。 在此情況下，命令會顯示在發生 Elapsed 事件時產生的隨機數。
如需模組的詳細資訊，請參閱 about_Modules。
參數
-Force
表示這個 Cmdlet 會取得所有事件訂閱者，包括使用、 和 Register-ObjectEventRegister-WmiEvent 參數Register-EngineEvent隱藏之事件的訂閱者。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-SourceIdentifier
指定只取得事件訂閱者的 SourceIdentifier 屬性值。 根據預設， Get-EventSubscriber 取得會話中的所有事件訂閱者。 不允許通配符。 此參數區分大小寫。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
BySource
| Position: | 0 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-SubscriptionId
指定這個 Cmdlet 取得的訂用帳戶標識碼。 根據預設， Get-EventSubscriber 取得會話中的所有事件訂閱者。
參數屬性
| 類型: | Int32 |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 身份識別碼 |
參數集
ById
| Position: | 0 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。
輸入
None
您無法使用管線將輸入傳送至此 Cmdlet。
輸出
PSEventSubscriber
Get-EventSubscriber 返回一個表示每個事件訂閱者的物件。
備註
建立 New-Event 自定義事件的 Cmdlet 不會產生訂閱者。 因此， Get-EventSubscriber Cmdlet 找不到這些事件的訂閱者物件。 不過，如果您使用 Register-EngineEvent Cmdlet 訂閱自定義事件（若要轉送事件或指定動作）， Get-EventSubscriber 將會尋找產生的訂閱者 Register-EngineEvent 。
事件、事件訂閱和事件佇列只存在於當前會話中。 如果您關閉當前的會話，事件佇列將被丟棄，事件訂閱將被取消。