Unregister-Event
イベント サブスクリプションを取り消します。
構文
BySource (既定)
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ById
Unregister-Event
[-SubscriptionId] <Int32>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Unregister-Event コマンドレットは、Register-EngineEvent、Register-ObjectEvent、または Register-WmiEvent コマンドレットを使用して作成されたイベント サブスクリプションを取り消します。
イベント サブスクリプションが取り消されると、イベント サブスクライバーはセッションから削除され、サブスクライブされたイベントはイベント キューに追加されなくなります。 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 に送信し、セッションから削除されます。 タスクを完了するには、Unregister-Event で Force パラメーターも必要です。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
SupportEvent パラメーターの Register-ObjectEvent、Register-WmiEvent、および Register-EngineEvent を使用して非表示にされたサブスクリプションを含む、すべてのイベント サブスクリプションを取り消します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SourceIdentifier
このコマンドレットがイベント サブスクリプションを取り消すソース識別子を指定します。
SourceIdentifier または SubscriptionId パラメーターは、すべてのコマンドに含まれている必要があります。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
BySource
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-SubscriptionId
このコマンドレットがイベント サブスクリプションを取り消すソース識別子 ID を指定します。
SourceIdentifier または SubscriptionId パラメーターは、すべてのコマンドに含まれている必要があります。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ById
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
PSEventSubscriber
Get-EventSubscriber からの出力を Unregister-Event にパイプ処理できます。
出力
None
このコマンドレットによる戻り値はありません。
メモ
イベント、イベント サブスクリプション、およびイベント キューは、現在のセッションにのみ存在します。 現在のセッションを閉じると、イベント キューは破棄され、イベント サブスクリプションは取り消されます。
Unregister-Event は、 Register-EngineEvent コマンドレットを使用してイベントをサブスクライブしていない限り、New-Event コマンドレットを使用して作成されたイベントを削除できません。 セッションからカスタム イベントを削除するには、プログラムで削除するか、セッションを閉じる必要があります。