Compartilhar via

Unregister-Event

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

Cancela uma assinatura de evento.

Sintaxe

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

Description

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

Quando uma assinatura de evento é cancelada, o assinante do evento é excluído da sessão e os eventos assinados não são mais adicionados à fila de eventos. Quando você cancela uma assinatura para um evento criado usando o cmdlet New-Event, 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 cmdlet Remove-Event.

Exemplos

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

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

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

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

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

PS C:\> Unregister-Event -SubscriptionId 2

Esse comando cancela a assinatura do evento que tem um identificador de assinatura 2.

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

Exemplo 3: Cancelar todas as assinaturas de evento

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

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

O comando usa o cmdlet Get-EventSubscriber para obter todos os objetos de assinante de evento na sessão, incluindo os assinantes 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, o que os exclui da sessão. Para concluir a tarefa, o parâmetro Force também é necessário no Unregister-Event.

Parâmetros

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Force

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

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-SourceIdentifier

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

Um parâmetro SourceIdentifier ou SubscriptionId deve ser incluído em todos os comandos.

Tipo:String
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-SubscriptionId

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

Um parâmetro SourceIdentifier ou SubscriptionId deve ser incluído em todos os comandos.

Tipo:Int32
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-WhatIf

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

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga: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

Nenhuma fonte de evento disponível nas plataformas Linux ou macOS.

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 assinatura do evento será cancelada.

Unregister-Event não pode excluir eventos criados usando o cmdlet New-Event, a menos que você tenha assinado o evento usando o cmdlet Register-EngineEvent. Para excluir um evento personalizado da sessão, você deve removê-lo programaticamente ou fechar a sessão.