Cancela una suscripción de eventos.
Sintaxis
Unregister-Event [-SubscriptionId] <int> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>] Unregister-Event [-SourceIdentifier] <string> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
Descripción
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 se elimina de la sesión y los eventos objeto de la suscripción ya no se agregan a la cola de eventos. Cuando se cancela una suscripción a un evento que se creó mediante el cmdlet New-Event, también se elimina el nuevo evento de la sesión.
Unregister-Event no elimina los eventos de la cola de eventos. Para eliminarlos, utilice el cmdlet Remove-Event.
Parámetros
-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.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-SourceIdentifier <string>
Cancela las suscripciones de eventos con el identificador de origen especificado.
Cada comando debe incluir un parámetro SourceIdentifier o SubscriptionId.
|
¿Requerido? |
true |
|
¿Posición? |
1 |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
true (ByPropertyName) |
|
¿Aceptar caracteres comodín? |
false |
-SubscriptionId <int>
Cancela las suscripciones de eventos con el identificador de suscripción especificado.
Cada comando debe incluir un parámetro SourceIdentifier o SubscriptionId.
|
¿Requerido? |
true |
|
¿Posición? |
1 |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
true (ByPropertyName) |
|
¿Aceptar caracteres comodín? |
false |
-Confirm
Solicita confirmación antes de ejecutar el comando.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-WhatIf
Describe lo que ocurriría si ejecutara el comando sin ejecutarlo realmente.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, vea about_Commonparameters.
Entradas y salidas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet. El tipo devuelto es el tipo de los objetos que el cmdlet devuelve.
|
Entradas |
System.Management.Automation.PSEventSubscriber El resultado se puede canalizar de Get-EventSubscriber a Unregister-Event. |
|
Salidas |
Ninguno Este cmdlet no devuelve resultados. |
Notas
Los eventos, las suscripciones de eventos y la cola de eventos solo existen en la sesión actual. Si cierra la sesión actual, se descartará la cola de eventos y se cancelará la suscripción de eventos.
Unregister-Event no puede eliminar los 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.
Ejemplo 1
C:\PS>unregister-event -sourceIdentifier ProcessStarted Descripción ----------- Este comando cancela la suscripción de eventos con el identificador de origen "ProcessStarted". Para obtener el identificador de origen de un evento, utilice el cmdlet Get-Event. Para obtener el identificador de origen de una suscripción de eventos, utilice el cmdlet Get-EventSubscriber.
Ejemplo 2
C:\PS>unregister-event -subscriptionId 2 Descripción ----------- Este comando cancela la suscripción de eventos con el identificador de suscripción 2. Para obtener el identificador de una suscripción de eventos, utilice el cmdlet Get-EventSubscriber.
Ejemplo 3
C:\PS>get-eventsubscriber -force | unregister-event -force Descripción ----------- Este comando cancela todas las suscripciones de eventos en la sesión. El comando utiliza el cmdlet Get-EventSubscriber para obtener todos los objetos de suscriptor de eventos de la sesión, incluidos los suscriptores que se ocultan 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 poder completar la tarea, también se requiere el parámetro Force en Unregister-Event.
Vea también