Unregister-Event

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Cancela uma assinatura para um evento.

Syntax

Unregister-Event
          [-SourceIdentifier] <String>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-Event
          [-SubscriptionId] <Int32>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Description

O Unregister-Event cmdlet cancela uma assinatura de evento que foi criada usando o Register-EngineEventcmdlet , Register-ObjectEventou Register-WmiEvent cmdlet.

Quando uma assinatura para um evento é cancelada, o assinante do evento é excluído da sessão e os eventos assinados deixam de ser adicionados à fila de eventos. Quando você cancela uma assinatura de um evento criado usando o New-Event cmdlet, o novo evento também é excluído da sessão.

Unregister-Event Não exclui eventos da fila de eventos. Para excluir eventos, use o Remove-Event cmdlet.

Exemplos

Exemplo 1: Cancelar uma assinatura de evento por identificador de origem

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

Esse comando cancela a assinatura de evento que tem um identificador de origem de ProcessStarted.

Para localizar o identificador de origem de um evento, use o Get-Event cmdlet. Para localizar o identificador de origem de uma assinatura de evento, use o Get-EventSubscriber cmdlet.

Exemplo 2: Cancelar uma assinatura de evento por identificador de assinatura

PS C:\> Unregister-Event -SubscriptionId 2

Este comando cancela a assinatura de evento que tem um identificador de assinatura igual a 2.

Para localizar o identificador de assinatura de uma assinatura de evento, use o Get-EventSubscriber cmdlet.

Exemplo 3: Cancelar todas as inscrições de eventos

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

Este comando cancela todas as assinaturas de evento presentes na sessão.

O comando usa o Get-EventSubscriber cmdlet para obter todos os objetos de assinante de evento na sessão, incluindo os assinantes que estão ocultos usando o parâmetro SupportEvent dos cmdlets de registro de evento.

Ele usa um operador de pipeline (|) para enviar os objetos do assinante para Unregister-Event, que os exclui da sessão. Para concluir a tarefa, o parâmetro Force também é necessário em Unregister-Event.

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

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

-Force

Cancela todas as assinaturas de eventos, incluindo assinaturas que estavam ocultas usando o parâmetro SupportEvent de Register-ObjectEvent, Register-WmiEvente Register-EngineEvent.

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

-SourceIdentifier

Especifica um identificador de origem que esse cmdlet cancela assinaturas de eventos.

Um parâmetro SourceIdentifier ou SubscriptionId deve ser incluído em cada comando.

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

-SubscriptionId

Especifica uma ID de identificador de origem que esse cmdlet cancela assinaturas de eventos.

Um parâmetro SourceIdentifier ou SubscriptionId deve ser incluído em cada comando.

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

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

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

Entradas

PSEventSubscriber

Você pode canalizar a saída de Get-EventSubscriber para este cmdlet.

Saídas

None

Esse cmdlet não retorna nenhuma saída.

Observações

Eventos, assinaturas de evento e a fila de eventos existem apenas na sessão atual. Se você fechar a sessão atual, a fila de eventos será descartada e a inscrição do evento será cancelada.

Unregister-Event Não é possível excluir eventos criados usando o cmdlet, a New-Event menos que você tenha se inscrito no evento usando o Register-EngineEvent cmdlet. Para excluir um evento personalizado da sessão, você deve removê-lo programaticamente ou fechar a sessão.