Unregister-Event
イベントのサブスクリプションを取り消します。
構文
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Unregister-Event
[-SubscriptionId] <Int32>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
コマンドレットはUnregister-Event
、または Register-WmiEvent
コマンドレットを使用して作成されたイベント サブスクリプションをRegister-EngineEvent
Register-ObjectEvent
取り消します。
イベント サブスクリプションが取り消されると、セッションからイベント サブスクライバーが削除され、サブスクライブされたイベントはイベント キューに追加されません。 コマンドレットを使用 New-Event
して作成されたイベントのサブスクリプションを取り消すと、新しいイベントもセッションから削除されます。
Unregister-Event
はイベント キューからイベントを削除しません。 イベントを削除するには、 コマンドレットを使用します Remove-Event
。
例
例 1: ソース識別子でイベント サブスクリプションを取り消す
PS C:\> Unregister-Event -SourceIdentifier "ProcessStarted"
このコマンドは、ProcessStarted のソース識別子を持つイベント サブスクリプションを取り消します。
イベントのソース識別子を検索するには、 コマンドレットを使用します Get-Event
。 イベント サブスクリプションのソース識別子を検索するには、 コマンドレットを使用します Get-EventSubscriber
。
例 2: サブスクリプション識別子でイベント サブスクリプションを取り消す
PS C:\> Unregister-Event -SubscriptionId 2
このコマンドは、サブスクリプション識別子が 2 のイベント サブスクリプションを取り消します。
イベント サブスクリプションのサブスクリプション識別子を検索するには、 コマンドレットを Get-EventSubscriber
使用します。
例 3: すべてのイベント サブスクリプションを取り消す
PS C:\> Get-EventSubscriber -Force | Unregister-Event -Force
このコマンドは、セッション内のすべてのイベント サブスクリプションを取り消します。
コマンドは、 コマンドレットを Get-EventSubscriber
使用して、イベント登録コマンドレットの SupportEvent パラメーターを使用して非表示になっているサブスクライバーを含め、セッション内のすべてのイベント サブスクライバー オブジェクトを取得します。
パイプライン演算子 (|
) を使用してサブスクライバー オブジェクトを に Unregister-Event
送信し、セッションから削除します。 タスクを完了するには、 で Force パラメーターも必要 Unregister-Event
です。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
、、および の SupportEvent パラメーターRegister-ObjectEvent
Register-WmiEvent
を使用して非表示にされたサブスクリプションを含め、すべてのイベント サブスクリプションを取り消しますRegister-EngineEvent
。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SourceIdentifier
このコマンドレットがイベント サブスクリプションを取り消すソース識別子を指定します。
SourceIdentifier または SubscriptionId パラメーターは、すべてのコマンドに含まれている必要があります。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionId
このコマンドレットがイベント サブスクリプションを取り消すソース識別子 ID を指定します。
SourceIdentifier または SubscriptionId パラメーターは、すべてのコマンドに含まれている必要があります。
Type: | Int32 |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
から にUnregister-Event
出力Get-EventSubscriber
をパイプできます。
出力
None
このコマンドレットによる戻り値はありません。
メモ
Linux または macOS プラットフォームで使用できるイベント ソースはありません。
イベント、イベント サブスクリプション、およびイベント キューは、現在のセッションにのみ存在します。 現在のセッションを閉じた場合、イベント キューが破棄され、イベント サブスクリプションが取り消されます。
Unregister-Event
コマンドレットを使用してイベントを New-Event
サブスクライブしていない限り、 コマンドレットを使用して作成されたイベントを Register-EngineEvent
削除することはできません。 セッションからカスタム イベントを削除するには、プログラムを使用してそれを削除するか、セッションを閉じる必要があります。