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

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

Este comando cancela la suscripción de eventos que tiene un identificador de origen de 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 Get-EventSubscriber cmdlet .

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

PS C:\> Unregister-Event -SubscriptionId 2

Este comando cancela la suscripción de eventos que tiene un identificador de origen "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

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

Este comando cancela todas las suscripciones de eventos en la sesión.

El comando usa el Get-EventSubscriber cmdlet para obtener todos los objetos de suscriptor de eventos de la sesión, incluidos los suscriptores ocultos mediante el parámetro SupportEvent de los cmdlets de registro de eventos.

Usa un operador de canalización (|) para enviar los objetos de suscriptor a Unregister-Event, que los elimina de la sesión. Para completar la tarea, también se requiere el parámetro Force en Unregister-Event.

Parámetros

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required: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.

Type:SwitchParameter
Position:Named
Default value:None
Required: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.

Type:String
Position:0
Default value:None
Required: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.

Type:Int32
Position:0
Default value:None
Required: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.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required: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.