Unregister-Event
Cancela uma assinatura de evento.
Sintaxe
BySource (Predefinição)
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ById
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 inscritos 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.
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"
Este comando cancela a subscrição do evento que tem o 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 Get-EventSubscriber cmdlet.
Exemplo 2: Cancelar uma assinatura de evento por identificador de assinatura
PS C:\> Unregister-Event -SubscriptionId 2
Este comando cancela a subscrição de eventos que tem um identificador de subscrição de 2.
Para localizar o identificador de assinatura de uma assinatura de evento, use o cmdlet Get-EventSubscriber.
Exemplo 3: Cancelar todas as subscrições de eventos
PS C:\> Get-EventSubscriber -Force | Unregister-Event -Force
Este comando cancela todas as subscrições de eventos 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 eventos.
Ele usa um operador de pipeline (|) para enviar os objetos do assinante para Unregister-Evento , 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 confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Cf. |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-SourceIdentifier
Especifica um identificador de origem que o cmdlet utiliza para cancelar assinaturas de eventos.
Cada comando deve incluir um parâmetro SourceIdentifier ou SubscriptionId.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
BySource
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-SubscriptionId
Especifica uma ID de identificador de origem que esse cmdlet cancela assinaturas de eventos.
Cada comando deve incluir um parâmetro SourceIdentifier ou SubscriptionId.
Propriedades dos parâmetros
| Tipo: | Int32 |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
ById
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Wi |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
PSEventSubscriber
Você pode canalizar a saída de Get-EventSubscriber para Unregister-Event.
Saídas
None
Este cmdlet não retorna nenhuma saída.
Notas
Não há fontes de eventos disponíveis nas plataformas Linux ou macOS.
Eventos, assinaturas de eventos e a fila de eventos existem somente 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 se inscrito no evento usando o cmdlet Register-EngineEvent. Para excluir um evento personalizado da sessão, você deve removê-lo programaticamente ou fechar a sessão.