external help file | Locale | Module Name | ms.date | online version | schema | title |
---|---|---|---|---|---|---|
Microsoft.PowerShell.Commands.Utility.dll-Help.xml |
en-US |
Microsoft.PowerShell.Utility |
06/20/2024 |
2.0.0 |
Unregister-Event |
Cancels an event subscription.
Unregister-Event [-SourceIdentifier] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Unregister-Event [-SubscriptionId] <Int32> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
The Unregister-Event
cmdlet cancels an event subscription that was created by using the
Register-EngineEvent
, Register-ObjectEvent
, or Register-WmiEvent
cmdlet.
When an event subscription is canceled, the event subscriber is deleted from the session and the
subscribed events are no longer added to the event queue. When you cancel a subscription to an event
created by using the New-Event
cmdlet, the new event is also deleted from the session.
Unregister-Event
does not delete events from the event queue. To delete events, use the
Remove-Event
cmdlet.
This command cancels the event subscription that has a source identifier of ProcessStarted.
Unregister-Event -SourceIdentifier "ProcessStarted"
To find the source identifier of an event, use the Get-Event
cmdlet. To find the source identifier
of an event subscription, use the Get-EventSubscriber
cmdlet
This command cancels the event subscription that has a subscription identifier of 2.
Unregister-Event -SubscriptionId 2
To find the subscription identifier of an event subscription, use the Get-EventSubscriber
cmdlet.
This example cancels all event subscriptions in the session.
Get-EventSubscriber -Force | Unregister-Event -Force
Using the Force parameter with Get-EventSubscriber
gets all event subscriber objects in the
session, including the subscribers that are hidden. The output is piped to Unregister-Event
, which
deletes the subscribers from the session. The Force parameter is required on Unregister-Event
to remove any hidden subscribers.
Cancels all event subscriptions, including subscriptions that were hidden by using the
SupportEvent parameter of Register-ObjectEvent
, Register-WmiEvent
, and
Register-EngineEvent
.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a source identifier that this cmdlet cancels event subscriptions.
A SourceIdentifier or SubscriptionId parameter must be included in every command.
Type: System.String
Parameter Sets: BySource
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Specifies a source identifier ID that this cmdlet cancels event subscriptions.
A SourceIdentifier or SubscriptionId parameter must be included in every command.
Type: System.Int32
Parameter Sets: ById
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe the output from Get-EventSubscriber
to this cmdlet.
This cmdlet returns no output.
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.
Unregister-Event
cannot delete events created by using the New-Event
cmdlet unless you have
subscribed to the event by using the Register-EngineEvent
cmdlet. To delete a custom event from
the session, you must remove it programmatically or close the session.