Edit

Share via

Remove-Event

Module:
Microsoft.PowerShell.Utility Module

Deletes events from the event queue.

Syntax

BySource (Default) 

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

ByIdentifier 

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

Description

The Remove-Event cmdlet deletes events from the event queue in the current session.

This cmdlet deletes only the events currently in the queue. To cancel event registrations or unsubscribe, use the Unregister-Event cmdlet.

Examples

Example 1: Remove an event by source identifier

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

This command deletes events with a source identifier of Process Started from the event queue.

Example 2: Remove an event by event identifier

PS C:\> Remove-Event -EventIdentifier 30

This command deletes the event with an event ID of 30 from the event queue.

Example 3: Remove all events

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

This command deletes all events from the event queue.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EventIdentifier

Specifies the event identifier for which the cmdlet deletes. An EventIdentifier or SourceIdentifier parameter is required in every command.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIdentifier
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SourceIdentifier

Specifies the source identifier for which this cmdlet deletes events from. Wildcards are not permitted. An EventIdentifier or SourceIdentifier parameter is required in every command.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

BySource
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSEventArgs

You can pipe events from Get-Event to this cmdlet.

Outputs

None

This cmdlet returns no output.

Notes

No event sources available on the Linux or macOS platforms.

Events, event subscriptions, and the event queue exist only in the current session. If you close the current session, the event queue is discarded and the event subscription is canceled.