Remove-Event
Deletes events from the event queue.
Синтаксис
BySource (по умолчанию)
Remove-Event
[-SourceIdentifier] <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByIdentifier
Remove-Event
[-EventIdentifier] <Int32>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Описание
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.
Примеры
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.
Параметры
-Confirm
Prompts you for confirmation before running the cmdlet.
Свойства параметра
Тип: | SwitchParameter |
Default value: | False |
Поддерживаются подстановочные знаки: | False |
DontShow: | False |
Aliases: | cf |
Наборы параметров
(All)
Position: | Named |
Обязательно: | False |
Значение из конвейера: | False |
Значение из конвейера по имени свойства: | False |
Значение из оставшихся аргументов: | False |
-EventIdentifier
Specifies the event identifier for which the cmdlet deletes. An EventIdentifier or SourceIdentifier parameter is required in every command.
Свойства параметра
Тип: | Int32 |
Default value: | None |
Поддерживаются подстановочные знаки: | False |
DontShow: | False |
Наборы параметров
ByIdentifier
Position: | 0 |
Обязательно: | True |
Значение из конвейера: | False |
Значение из конвейера по имени свойства: | True |
Значение из оставшихся аргументов: | 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.
Свойства параметра
Тип: | String |
Default value: | None |
Поддерживаются подстановочные знаки: | False |
DontShow: | False |
Наборы параметров
BySource
Position: | 0 |
Обязательно: | True |
Значение из конвейера: | False |
Значение из конвейера по имени свойства: | False |
Значение из оставшихся аргументов: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Свойства параметра
Тип: | SwitchParameter |
Default value: | False |
Поддерживаются подстановочные знаки: | False |
DontShow: | False |
Aliases: | wi |
Наборы параметров
(All)
Position: | Named |
Обязательно: | False |
Значение из конвейера: | False |
Значение из конвейера по имени свойства: | False |
Значение из оставшихся аргументов: | 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.
Входные данные
PSEventArgs
You can pipe events from Get-Event
to this cmdlet.
Выходные данные
None
This cmdlet returns no output.
Примечания
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.