Unregister-Event

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

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

構文

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

説明

Unregister-Event コマンドレットは、Register-EngineEvent、Register-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-EventSubscriberで Force パラメーターを使用すると、セッション内のすべてのイベント サブスクライバー オブジェクト (非表示のサブスクライバーを含む) が取得されます。 出力は、セッションからサブスクライバーを削除する Unregister-Eventにパイプされます。 非表示のサブスクライバーを削除するには、Unregister-Eventで Force パラメーターが必要です。

パラメーター

-Confirm

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

型:SwitchParameter
Aliases:cf
Position:Named
既定値:False
必須:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

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

型:SwitchParameter
Position:Named
既定値:None
必須:False
Accept pipeline input:False
Accept wildcard characters:False

-SourceIdentifier

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

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

型:String
Position:0
既定値:None
必須:True
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionId

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

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

型:Int32
Position:0
既定値:None
必須:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
Position:Named
既定値:False
必須:False
Accept pipeline input:False
Accept wildcard characters:False

入力

PSEventSubscriber

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

出力

None

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

メモ

Linux または macOS プラットフォームで使用できるイベント ソースはありません。

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

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