Unregister-Event
Cancela uma assinatura de evento.
Sintaxe
BySource (Padrã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 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
Esse comando cancela a assinatura do evento que tem um identificador de origem do ProcessStarted.
Unregister-Event -SourceIdentifier "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
Esse comando cancela a assinatura do evento que tem um identificador de assinatura 2.
Unregister-Event -SubscriptionId 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
Este exemplo cancela todas as assinaturas de evento na sessão.
Get-EventSubscriber -Force | Unregister-Event -Force
O uso do parâmetro Force com Get-EventSubscriber obtém todos os objetos de assinante de evento na sessão, incluindo os assinantes ocultos. A saída é canalizada para Unregister-Event, que exclui os assinantes da sessão. O parâmetro Force é necessário no Unregister-Event para remover todos os assinantes ocultos.
Parâmetros
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | cf |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Force
Cancela todas as assinaturas de evento, incluindo assinaturas ocultas usando o parâmetro SupportEvent de Register-ObjectEvent, Register-WmiEvente Register-EngineEvent.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
BySource
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | 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.
Propriedades do parâmetro
| Tipo: | Int32 |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ById
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | wi |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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 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.
