Annule un abonnement aux événements.
Syntaxe
Unregister-Event [-SubscriptionId] <int> [-Force] [-Confirmer] [-WhatIf] [<CommonParameters>] Unregister-Event [-SourceIdentifier] <string> [-Force] [-Confirmer] [-WhatIf] [<CommonParameters>]
Description
L'applet de commande Unregister-Event annule un abonnement aux événements créé à l'aide de l'applet de commande Register-EngineEvent, Register-ObjectEvent ou Register-WmiEvent.
Lorsqu'un abonnement aux événements est annulé, l'abonné est supprimé de la session et les événements ne sont plus ajoutés à la file d'attente d'événements. Lorsque vous annulez un abonnement à un événement créé à l'aide de l'applet de commande New-Event, le nouvel événement est également supprimé de la session.
Unregister-Event ne supprime pas d'événements de la file d'attente d'événements. Pour supprimer des événements, utilisez l'applet de commande Remove-Event.
Paramètres
-Force
Annule tous les abonnements aux événements, notamment les abonnements cachés à l'aide du paramètre SupportEvent de Register-ObjectEvent, Register-WmiEvent et Register-EngineEvent.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-SourceIdentifier <string>
Annule les abonnements aux événements possédant l'identificateur source spécifié.
Un paramètre SourceIdentifier ou SubscriptionId doit être inclus dans chaque commande.
|
Obligatoire ? |
true |
|
Position ? |
1 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-SubscriptionId <int>
Annule les abonnements aux événements possédant l'identificateur d'abonnement spécifié.
Un paramètre SourceIdentifier ou SubscriptionId doit être inclus dans chaque commande.
|
Obligatoire ? |
true |
|
Position ? |
1 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-Confirmer
Vous invite à confirmer l'exécution de la commande.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-WhatIf
Décrit le résultat que vous obtiendriez en exécutant la commande, sans réellement l'exécuter.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
|
Entrées |
System.Management.Automation.PSEventSubscriber Vous pouvez diriger la sortie de Get-EventSubscriber vers Unregister-Event. |
|
Sorties |
Aucun Cette applet de commande ne retourne aucune sortie. |
Remarques
Les événements, les abonnements aux événements et la file d'attente d'événements existent uniquement dans la session active. Si vous fermez cette session, la file d'attente d'événements est ignorée et l'abonnement aux événements est annulé.
Unregister-Event ne peut pas supprimer les événements créés à l'aide de l'applet de commande New-Event, à moins que vous ne vous soyez abonné à ces événements par l'intermédiaire de l'applet de commande Register-EngineEvent. Pour supprimer un événement personnalisé de la session, vous devez le supprimer par programmation ou fermer la session.
Exemple 1
C:\PS>unregister-event -sourceIdentifier ProcessStarted Description ----------- Cette commande annule l'abonnement aux événements possédant l'identificateur source « ProcessStarted ». Pour rechercher l'identificateur source d'un événement, utilisez l'applet de commande Get-Event. Pour rechercher l'identificateur source d'un abonnement aux événements, utilisez l'applet de commande Get-EventSubscriber.
Exemple 2
C:\PS>unregister-event -subscriptionId 2 Description ----------- Cette commande annule l'abonnement aux événements possédant l'identificateur d'abonnement 2. Pour rechercher l'identificateur d'un abonnement aux événements, utilisez l'applet de commande Get-EventSubscriber.
Exemple 3
C:\PS>get-eventsubscriber -force | unregister-event -force Description ----------- Cette commande annule tous les abonnements aux événements de la session. Elle utilise l'applet de commande Get-EventSubscriber pour obtenir tous les objets abonnés aux événements de la session, notamment les abonnés cachés à l'aide du paramètre SupportEvent des applets d'inscription à des événements. Elle utilise un opérateur de pipeline (|) pour envoyer les objets abonnés à Unregister-Event, qui les supprime de la session. Pour terminer la tâche, le paramètre Force est également obligatoire sur Unregister-Event.
Voir aussi