Windows PowerShell command on Get-command Unregister-Event
MyWebUniversity

Windows PowerShell command on Get-command Unregister-Event

NAME

Unregister-Event

SYNOPSIS

Cancels an event subscription.

SYNTAX

Unregister-Event [-SourceIdentifier] [-Confirm] [-Force] [-WhatIf] []

Unregister-Event [-SubscriptionId] [-Confirm] [-Force] [-WhatIf] []

DESCRIPTION

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.

PARAMETERS

-Confirm []

Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-Force []

Cancels all event subscriptions, including subscriptions that were hidden by using the SupportEvent parameter

of Register-ObjectEvent , Register-WmiEvent , and Register-EngineEvent .

Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-SourceIdentifier

Specifies a source identifier that this cmdlet cancels event subscriptions. A SourceIdentifier or SubscriptionId parameter must be included in every command. Required? true Position? 0 Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-SubscriptionId

Specifies a source identifier ID that this cmdlet cancels event subscriptions. A SourceIdentifier or SubscriptionId parameter must be included in every command. Required? true Position? 0 Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-WhatIf []

Shows what would happen if the cmdlet runs. The cmdlet is not run. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.Management.Automation.PSEventSubscriber

You can pipe the output from Get-EventSubscriber to Unregister-Event .

OUTPUTS

None This cmdlet does not return any output.

NOTES

* 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.

*

Example 1: Cancel an event subscription by source identifier

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

This command cancels the event subscription that has a source identifier of 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.

Example 2: Cancel an event subscription by subscription identifier

PS C:\>Unregister-Event -SubscriptionId 2

This command cancels the event subscription that has a subscription identifier of 2.

To find the subscription identifier of an event subscription, use the Get-EventSubscriber cmdlet.

Example 3: Cancel all event subscriptions

PS C:\>Get-EventSubscriber -Force | Unregister-Event -Force

This command cancels all event subscriptions in the session.

The command uses the Get-EventSubscriber cmdlet to get all event subscriber objects in the session, including the

subscribers that are hidden by using the SupportEvent parameter of the event registration cmdlets.

It uses a pipeline operator (|) to send the subscriber objects to Unregister-Event , which deletes them from the

session. To complete the task, the Force parameter is also required on Unregister-Event .

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=821868

Get-Event

Get-EventSubscriber

New-Event

Register-EngineEvent

Register-ObjectEvent

Remove-Event

Unregister-Event

Wait-Event



Contact us      |      About us      |      Term of use      |       Copyright © 2000-2019 OurUNIX.com ™