Cancela uma assinatura de evento.

Sintaxe

Unregister-Event [-SubscriptionId] <int> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]

Unregister-Event [-SourceIdentifier] <string> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]

Descrição

O cmdlet Unregister-Event cancela uma assinatura de evento que foi criada com o cmdlet Register-EngineEvent, Register-ObjectEvent ou 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 de um evento criado usando o cmdlet New-Event, o novo evento também é excluído da sessão.

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

Parâmetros

-Force

Cancela todas as assinaturas de evento, inclusive assinaturas que foram ocultadas usando o parâmetro SupportEvent de Register-ObjectEvent, Register-WmiEvent e Register-EngineEvent.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-SourceIdentifier <string>

Cancela assinaturas de eventos que têm o identificador de origem especificado.

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

Necessário?

true

Posição?

1

Valor padrão

Aceitar entrada do pipeline?

true (ByPropertyName)

Aceitar caracteres curinga?

false

-SubscriptionId <int>

Cancela assinaturas de eventos que têm o identificador de assinatura especificado.

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

Necessário?

true

Posição?

1

Valor padrão

Aceitar entrada do pipeline?

true (ByPropertyName)

Aceitar caracteres curinga?

false

-Confirm

Solicita confirmação antes da execução do comando.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-WhatIf

Descreve o que aconteceria se você executasse o comando, sem executá-lo de fato.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.

Entradas e saídas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.

Entradas

System.Management.Automation.PSEventSubscriber

É possível canalizar a saída de Get-EventSubscriber para Unregister-Event.

Saídas

None

Este cmdlet não retorna nenhuma saída.

Observações

Eventos, assinaturas de eventos e a fila de eventos só existem na sessão atual. Se você fechar a sessão atual, a fila de eventos será descartada e a assinatura de 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.

Exemplo 1

C:\PS>unregister-event -sourceIdentifier ProcessStarted

Descrição
-----------
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 cmdlet Get-Event. Para localizar o identificador de origem de um evento de assinatura, use o cmdlet Get-EventSubscriber.






Exemplo 2

C:\PS>unregister-event -subscriptionId 2

Descrição
-----------
Esse comando cancela a assinatura de evento que tem um identificador de origem de 2.

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






Exemplo 3

C:\PS>get-eventsubscriber -force | unregister-event -force

Descrição
-----------
Esse comando cancela todas as assinaturas de eventos da sessão. 

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

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






See Also




Sumário