Remove-Event

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

イベントをイベント キューから削除します。

構文

Remove-Event
      [-SourceIdentifier] <String>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-Event
      [-EventIdentifier] <Int32>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

コマンドレットは Remove-Event 、現在のセッションのイベント キューからイベントを削除します。

このコマンドレットは、現在キューにあるイベントのみを削除します。 イベントの登録を取り消したり、登録を解除したりするには、コマンドレットを Unregister-Event 使用します。

例

例 1: ソース識別子によるイベントの削除

PS C:\> Remove-Event -SourceIdentifier "ProcessStarted"

このコマンドは、プロセス開始のソース識別子を持つイベントをイベント キューから削除します。

例 2: イベント識別子によるイベントの削除

PS C:\> Remove-Event -EventIdentifier 30

このコマンドは、イベント ID が 30 のイベントをイベント キューから削除します。

例 3: すべてのイベントを削除する

PS C:\> Get-Event | Remove-Event

このコマンドは、イベント キューからすべてのイベントを削除します。

パラメーター

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventIdentifier

コマンドレットが削除するイベント識別子を指定します。 すべてのコマンドで EventIdentifier または SourceIdentifier パラメーターが必要です。

Type:Int32
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SourceIdentifier

このコマンドレットがイベントを削除するソース識別子を指定します。 ワイルドカードは使用できません。 すべてのコマンドで EventIdentifier または SourceIdentifier パラメーターが必要です。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

PSEventArgs

このコマンドレットに Get-Event イベントをパイプできます。

出力

None

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

メモ

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

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