次の方法で共有


Unregister-Event

イベント サブスクリプションを取り消します。

構文

Unregister-Event
          [-SourceIdentifier] <String>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-Event
          [-SubscriptionId] <Int32>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

説明

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

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

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

例 1: ソース識別子によるイベント サブスクリプションの取り消し

このコマンドは、ProcessStarted のソース識別子を持つイベント サブスクリプションを取り消します。

Unregister-Event -SourceIdentifier "ProcessStarted"

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

例 2: サブスクリプション識別子によるイベント サブスクリプションの取り消し

このコマンドは、サブスクリプション識別子が 2 のイベント サブスクリプションを取り消します。

Unregister-Event -SubscriptionId 2

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

例 3: すべてのイベント サブスクリプションを取り消す

この例では、セッション内のすべてのイベント サブスクリプションを取り消します。

Get-EventSubscriber -Force | Unregister-Event -Force

Get-EventSubscriberForce パラメーターを使用すると、セッション内のすべてのイベント サブスクライバー オブジェクト (非表示になっているサブスクライバーを含む) が取得されます。 出力は、セッションからサブスクライバーを削除する Unregister-Eventにパイプされます。 非表示のサブスクライバーを削除するには、Unregister-EventForce パラメーターが必要です。

パラメーター

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Force

Register-ObjectEventRegister-WmiEvent、および Register-EngineEventSupportEvent パラメーターを使用して非表示にされたサブスクリプションを含め、すべてのイベント サブスクリプションを取り消します。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-SourceIdentifier

このコマンドレットがイベント サブスクリプションを取り消すソース識別子を指定します。

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

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-SubscriptionId

このコマンドレットがイベント サブスクリプションを取り消すソース識別子 ID を指定します。

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

型:Int32
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

PSEventSubscriber

Get-EventSubscriber からこのコマンドレットに出力をパイプできます。

出力

None

このコマンドレットは出力を返しません。

メモ

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

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