Remove-Event

  • 参考
模块:
Microsoft.PowerShell.Utility

从事件队列中删除事件。

语法

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

说明

Remove-Event cmdlet 从当前会话中的事件队列中删除事件。

此 cmdlet 仅删除当前位于队列中的事件。 若要取消事件注册或取消订阅，请使用 Unregister-Event cmdlet。

示例

示例 1：按来源标识符移除事件

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

此命令从事件队列中删除来源标识符为“Process Started”的事件。

示例 2：按事件标识符移除事件

PS C:\> Remove-Event -EventIdentifier 30

此命令从事件队列中删除事件 ID 为 30 的事件。

示例 3：移除所有事件

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

此命令从事件队列中删除所有事件。

参数

-Confirm

提示你在运行 cmdlet 之前进行确认。

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

-EventIdentifier

指定此 cmdlet 可为其删除的事件标识符。 EventIdentifier 或 SourceIdentifier 参数在每个命令中都是必需的。

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

-SourceIdentifier

指定此 cmdlet 将从中删除事件的来源标识符。 不允许使用通配符。 EventIdentifier 或 SourceIdentifier 参数在每个命令中都是必需的。

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

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

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

输入

PSEventArgs

可以通过管道将事件从 Get-Event 传递给此 cmdlet。

输出

None

此 cmdlet 不返回任何输出。

备注

Linux 或 macOS 平台上没有可用的事件源。

事件、事件订阅和事件队列仅存在于当前会话中。 如果关闭当前会话，将丢弃事件队列并取消事件订阅。