Compartir a través de

Unregister-Event

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Cancela una suscripción de eventos.

Syntax

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

Description

El Unregister-Event cmdlet cancela una suscripción de eventos creada mediante el Register-EngineEventcmdlet , Register-ObjectEvento Register-WmiEvent .

Cuando se cancela una suscripción de eventos, el suscriptor de eventos se elimina de la sesión y los eventos suscritos ya no se agregan a la cola de eventos. Al cancelar una suscripción a un evento creado mediante el New-Event cmdlet , el nuevo evento también se elimina de la sesión.

Unregister-Event no elimina eventos de la cola de eventos. Para eliminar eventos, use el Remove-Event cmdlet .

Ejemplos

Ejemplo 1: Cancelar una suscripción de eventos por identificador de origen

Este comando cancela la suscripción de eventos que tiene un identificador de origen de ProcessStarted.

Unregister-Event -SourceIdentifier "ProcessStarted"

Para buscar el identificador de origen de un evento, use el Get-Event cmdlet . Para buscar el identificador de origen de una suscripción de eventos, use el cmdlet .Get-EventSubscriber

Ejemplo 2: Cancelar una suscripción de eventos por identificador de suscripción

Este comando cancela la suscripción de eventos que tiene un identificador de origen "2".

Unregister-Event -SubscriptionId 2

Para buscar el identificador de suscripción de una suscripción de eventos, use el Get-EventSubscriber cmdlet .

Ejemplo 3: Cancelar todas las suscripciones de eventos

En este ejemplo se cancelan todas las suscripciones de eventos de la sesión.

Get-EventSubscriber -Force | Unregister-Event -Force

El uso del parámetro Force con Get-EventSubscriber obtiene todos los objetos de suscriptor de eventos de la sesión, incluidos los suscriptores ocultos. La salida se canaliza a Unregister-Event, que elimina los suscriptores de la sesión. El parámetro Force es necesario en Unregister-Event para quitar los suscriptores ocultos.

Parámetros

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
valor predeterminado:False
Requerido:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Cancela todas las suscripciones de eventos, incluidas las suscripciones ocultas mediante el parámetro SupportEvent de Register-ObjectEvent, Register-WmiEventy Register-EngineEvent.

Tipo:SwitchParameter
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:False
Accept wildcard characters:False

-SourceIdentifier

Especifica un identificador de origen que este cmdlet cancela las suscripciones de eventos.

Un parámetro SourceIdentifier o SubscriptionId debe incluirse en todos los comandos.

Tipo:String
Position:0
valor predeterminado:None
Requerido:True
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionId

Especifica un identificador de identificador de origen que este cmdlet cancela las suscripciones de eventos.

Un parámetro SourceIdentifier o SubscriptionId debe incluirse en todos los comandos.

Tipo:Int32
Position:0
valor predeterminado:None
Requerido:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

Tipo:SwitchParameter
Aliases:wi
Position:Named
valor predeterminado:False
Requerido:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

PSEventSubscriber

Puede canalizar la salida de Get-EventSubscriber a este cmdlet.

Salidas

None

Este cmdlet no devuelve ningún resultado.

Notas

No hay orígenes de eventos disponibles en las plataformas Linux o macOS.

La cola de eventos, las suscripciones de eventos y los eventos solo existen en la sesión actual. Si la cierra, la cola de eventos se descartará y la suscripción al evento se cancelará.

Unregister-Event no puede eliminar eventos creados mediante el New-Event cmdlet a menos que se haya suscrito al evento mediante el Register-EngineEvent cmdlet . Para eliminar un evento personalizado de la sesión, se debe quitar mediante programación o cerrar la sesión.