Remove-Event
イベントをイベント キューから削除します。
構文
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
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-EventIdentifier
コマンドレットが削除するイベント識別子を指定します。 EventIdentifier または SourceIdentifier パラメーターは、すべてのコマンドで必要です。
型: | Int32 |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-SourceIdentifier
このコマンドレットがイベントを削除するソース識別子を指定します。 ワイルドカードは使用できません。 EventIdentifier または SourceIdentifier パラメーターは、すべてのコマンドで必要です。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
Get-Event
からこのコマンドレットにイベントをパイプできます。
出力
None
このコマンドレットは、出力を返しません。
メモ
Linux または macOS プラットフォームで使用できるイベント ソースはありません。
イベント、イベント サブスクリプション、およびイベント キューは、現在のセッションにのみ存在します。 現在のセッションを閉じた場合、イベント キューが破棄され、イベント サブスクリプションが取り消されます。
関連リンク
PowerShell