Unregister-Event

[アーティクル]
10/30/2009

イベントサブスクリプションをキャンセルします。

構文

Unregister-Event [-SubscriptionId] <int> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]

Unregister-Event [-SourceIdentifier] <string> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]

説明

Unregister-Event コマンドレットは、Register-EngineEvent コマンドレット、Register-ObjectEvent コマンドレット、または Register-WmiEvent コマンドレットを使用して作成されたイベントサブスクリプションをキャンセルします。

イベントサブスクリプションをキャンセルした場合、イベントサブスクライバーはセッションから削除され、サブスクライブされたイベントはイベントキューに追加されなくなります。New-Event コマンドレットを使用して作成されたイベントへのサブスクリプションをキャンセルした場合は、新しいイベントもセッションから削除されます。

Unregister-Event では、イベントキューからイベントが削除されません。イベントを削除するには、Remove-Event コマンドレットを使用します。

パラメーター

-Force

Register-ObjectEvent、Register-WmiEvent、および Register-EngineEvent の SupportEvent パラメーターを使用して非表示にしたサブスクリプションなど、すべてのイベントサブスクリプションをキャンセルします。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-SourceIdentifier <string>

指定したソース識別子があるイベントサブスクリプションをキャンセルします。

SourceIdentifier パラメーターまたは SubscriptionId パラメーターはすべてのコマンドに含まれている必要があります。

必須	true
位置	1
既定値
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-SubscriptionId <int>

指定したサブスクリプション識別子があるイベントサブスクリプションをキャンセルします。

SourceIdentifier パラメーターまたは SubscriptionId パラメーターはすべてのコマンドに含まれている必要があります。

必須	true
位置	1
既定値
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-Confirm

コマンドを実行する前に確認メッセージを表示します。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-WhatIf

実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.

入力と出力

入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。

入力

System.Management.Automation.PSEventSubscriber

Get-EventSubscriber からの出力を Unregister-Event にパイプ処理できます。

出力

なし

このコマンドレットによる戻り値はありません。

注

イベント、イベントサブスクリプション、およびイベントキューは、現在のセッションにのみ存在します。現在のセッションを閉じた場合、イベントキューが破棄され、イベントサブスクリプションが取り消されます。

Register-EngineEvent コマンドレットを使用してイベントにサブスクライブしていなければ、New-Event コマンドレットを使用して作成されたイベントを Unregister-Event で削除することはできません。セッションからカスタムイベントを削除するには、プログラムによって削除するか、セッションを閉じる必要があります。

例 1

C:\PS>unregister-event -sourceIdentifier ProcessStarted

説明
-----------
このコマンドは、ソース識別子が "ProcessStarted" であるイベント サブスクリプションをキャンセルします。

イベントのソース識別子を検索するには、Get-Event コマンドレットを使用します。イベント サブスクリプションのソース識別子を検索するには、Get-EventSubscriber コマンドレットを使用します。

例 2

C:\PS>unregister-event -subscriptionId 2

説明
-----------
このコマンドは、サブスクリプション識別子が 2 であるイベント サブスクリプションをキャンセルします。

イベント サブスクリプションのサブスクリプション識別子を検索するには、Get-EventSubscriber コマンドレットを使用します。

例 3

C:\PS>get-eventsubscriber -force | unregister-event -force

説明
-----------
このコマンドは、セッション内のすべてのイベント サブスクリプションをキャンセルします。

このコマンドは Get-EventSubscriber コマンドレットを使用して、セッション内のイベント サブスクライバー オブジェクトをすべて取得します。これには、イベント登録コマンドレットの SupportEvent パラメーターを使用して非表示にしているサブスクライバーも含まれます。

パイプライン演算子 (|) を使用して、サブスクライバー オブジェクトを Unregister-Event に渡します。このコマンドレットは、セッションからサブスクライバー オブジェクトを削除します。タスクを完了するには、Force パラメーターも Unregister-Event で必須です。

次の方法で共有