Remove-Event
イベント キューからイベントを削除します。
構文
BySource (既定)
Remove-Event
[-SourceIdentifier] <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByIdentifier
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 |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-EventIdentifier
コマンドレットが削除するイベント識別子を指定します。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByIdentifier
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-SourceIdentifier
このコマンドレットがイベントを削除するソース識別子を指定します。 ワイルドカードは使用できません。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
BySource
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
PSEventArgs
Get-Event からこのコマンドレットにイベントをパイプできます。
出力
None
このコマンドレットは出力を返しません。
メモ
Linux または macOS プラットフォームで使用できるイベント ソースはありません。
イベント、イベント サブスクリプション、およびイベント キューは、現在のセッションにのみ存在します。 現在のセッションを閉じると、イベント キューは破棄され、イベント サブスクリプションは取り消されます。
