Unregister-Event
Cancela una suscripción de eventos.
Sintaxis
BySource (Es el 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-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 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
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 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
Este comando cancela la suscripción de eventos que tiene un identificador de suscripción de 2.
Unregister-Event -SubscriptionId 2
Para buscar el identificador de suscripción de una suscripción de eventos, use el cmdlet Get-EventSubscriber.
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
Con el parámetro Force con Get-EventSubscriber obtiene todos los objetos de suscriptor de eventos de la sesión, incluidos los suscriptores que están 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 pide confirmación antes de ejecutar el cmdlet.
Propiedades del parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | cf |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Mandatory: | 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 ocultas mediante el parámetro supportEvent de Register-ObjectEvent, Register-WmiEventy Register-EngineEvent.
Propiedades del parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Mandatory: | 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 del parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
BySource
| Posición: | 0 |
| Mandatory: | 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 del parámetro
| Tipo: | Int32 |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
ById
| Posición: | 0 |
| Mandatory: | 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 del parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | Wi |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Mandatory: | 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 este cmdlet.
Salidas
None
Este cmdlet no devuelve ninguna salida.
Notas
No hay orígenes de eventos disponibles en las plataformas Linux o macOS.
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.
