Unregister-Event
取消事件訂閱。
Syntax
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Unregister-Event
[-SubscriptionId] <Int32>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Cmdlet 會 Unregister-Event
取消使用 Register-EngineEvent
、 Register-ObjectEvent
或 Register-WmiEvent
Cmdlet 所建立的事件訂閱。
取消事件訂閱時,會從工作階段刪除事件訂閱者,也不會再將訂閱的事件新增至事件佇列。 當您取消使用 New-Event
Cmdlet 所建立事件的訂用帳戶時,也會從會話中刪除新的事件。
Unregister-Event
不會從事件佇列中刪除事件。 若要刪除事件,請使用 Remove-Event
Cmdlet。
範例
範例 1︰依來源識別碼取消事件訂閱
PS C:\> Unregister-Event -SourceIdentifier "ProcessStarted"
此命令會取消來源識別碼為 ProcessStarted 的事件訂閱。
若要尋找事件的來源標識碼,請使用 Get-Event
Cmdlet。 若要尋找事件訂閱的來源標識符,請使用 Get-EventSubscriber
Cmdlet。
範例 2︰依訂閱識別碼取消事件訂閱
PS C:\> Unregister-Event -SubscriptionId 2
此命令會取消訂閱識別碼為 2 的事件訂閱。
若要尋找事件訂閱的訂用帳戶標識碼,請使用 Get-EventSubscriber
Cmdlet。
範例 3︰取消所有事件訂閱
PS C:\> Get-EventSubscriber -Force | Unregister-Event -Force
此命令會取消工作階段中的所有事件訂閱。
此命令會 Get-EventSubscriber
使用 Cmdlet 來取得工作階段中的所有事件訂閱者物件,包括使用事件註冊 Cmdlet 的 SupportEvent 參數隱藏的訂閱者。
它會使用管線運算符 (|
) ,將訂閱者對象傳送至 Unregister-Event
,這會從會話中刪除它們。 若要完成工作,在 上Unregister-Event
也需要 Force 參數。
參數
-Confirm
在執行 Cmdlet 前提示您確認。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
取消所有事件訂閱,包括使用、 Register-WmiEvent
和 Register-EngineEvent
的 SupportEvent 參數隱藏的Register-ObjectEvent
訂用帳戶。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SourceIdentifier
指定此 Cmdlet 取消事件訂閱的來源識別碼。
每個命令中必須包含 SourceIdentifier 或 SubscriptionId 參數。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionId
指定此 Cmdlet 取消事件訂閱的來源識別碼 ID。
每個命令中必須包含 SourceIdentifier 或 SubscriptionId 參數。
Type: | Int32 |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
顯示執行 Cmdlet 後會發生的情況。 Cmdlet 並不會執行。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
輸入
您可以使用管線將輸出從 Get-EventSubscriber
傳送至 Unregister-Event
。
輸出
None
此 Cmdlet 不會傳回任何輸出。
備註
Linux 或macOS平台上沒有可用的事件來源。
事件、事件訂閱與事件佇列僅存在目前工作階段中。 若關閉目前工作階段,便會捨棄事件佇列,並取消事件訂閱。
Unregister-Event
除非您已使用 Cmdlet 訂閱事件,否則無法刪除使用 Register-EngineEvent
Cmdlet 建立New-Event
的事件。 若要從工作階段刪除自訂事件,您必須以程式設計方式將它移除,或關閉工作階段。