Unregister-Event
Cancela una suscripción de eventos.
Sintaxis
BySource (valor predeterminado)
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ById
Unregister-Event
[-SubscriptionId] <Int32>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
El cmdlet Unregister-Event cancela una suscripción de eventos que se creó mediante el cmdlet Register-EngineEvent, Register-ObjectEvent o 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 cmdlet New-Event, 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 cmdlet Remove-Event.
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 cmdlet Get-Event. 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
PS C:\> Unregister-Event -SubscriptionId 2
Este comando cancela la suscripción de eventos que tiene un identificador de suscripción de 2.
Para encontrar el identificador de suscripción de una suscripción de eventos, use el cmdlet Get-EventSubscriber .
Ejemplo 3: Cancelar todas las suscripciones de eventos
PS C:\> Get-EventSubscriber -Force | Unregister-Event -Force
Este comando cancela todas las suscripciones de eventos de la sesión.
El comando usa el cmdlet Get-EventSubscriber para obtener todos los objetos de suscriptor de eventos de la sesión, incluidos los suscriptores que están ocultos mediante el parámetro SupportEvent de los cmdlets de registro de eventos.
Utiliza 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, el parámetro Force también es necesario en Unregister-Event.
Parámetros
-Confirm
Le pide confirmación antes de ejecutar el cmdlet.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | cf |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Force
Cancela todas las suscripciones de eventos, incluidas las suscripciones que se ocultaron mediante el parámetro SupportEvent de Register-ObjectEvent, Register-WmiEvent y Register-EngineEvent.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-SourceIdentifier
Especifica un identificador de origen que este cmdlet cancela las suscripciones de eventos.
Se debe incluir un parámetro SourceIdentifier o SubscriptionId en cada comando.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
BySource
| Posición: | 0 |
| Obligatorio: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | True |
| Valor de los argumentos restantes: | False |
-SubscriptionId
Especifica un identificador de identificador de origen que este cmdlet cancela las suscripciones de eventos.
Se debe incluir un parámetro SourceIdentifier o SubscriptionId en cada comando.
Propiedades de parámetro
| Tipo: | Int32 |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
ById
| Posición: | 0 |
| Obligatorio: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | True |
| Valor de los argumentos restantes: | False |
-WhatIf
Muestra lo que sucedería si el cmdlet se ejecuta. El cmdlet no se ejecuta.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | Wi |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
CommonParameters
Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.
Entradas
PSEventSubscriber
Puede canalizar la salida de Get-EventSubscriber a Unregister-Event.
Salidas
None
Este cmdlet no genera resultados de ningún tipo.
Notas
Los eventos, las suscripciones de eventos y la cola de eventos solo existen en la sesión actual. Si se cierra la sesión actual, se descarta la fila de eventos y se cancela la suscripción al evento.
Unregister-Event no puede eliminar eventos creados mediante el cmdlet New-Event a menos que se haya suscrito al evento mediante el cmdlet Register-EngineEvent . Para eliminar un evento personalizado de la sesión, debe quitarlo mediante programación o cerrar la sesión.