Unregister-Event
Annule un abonnement aux événements.
Syntaxe
BySource (Par défaut)
Unregister-Event
[-SourceIdentifier] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ById
Unregister-Event
[-SubscriptionId] <Int32>
[-Force]
[-WhatIf]
[-Confirm]
[<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-ObjectEventou Register-WmiEvent.
Lorsqu’un abonnement à un événement est annulé, l’abonné à l’événement est supprimé de la session et les événements abonnés 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 les événements de la file d’attente d’événements. Pour supprimer des événements, utilisez l’applet de commande Remove-Event.
Exemples
Exemple 1 : Annuler un abonnement à un événement par identificateur source
PS C:\> Unregister-Event -SourceIdentifier "ProcessStarted"
Cette commande annule l’abonnement aux événements qui a un identificateur source de ProcessStarted.
Pour rechercher l’identificateur source d’un événement, utilisez l’applet de commande Get-Event. Pour trouver l’identificateur source d’un abonnement à un événement, utilisez l’applet de Get-EventSubscriber commande.
Exemple 2 : Annuler un abonnement à un événement par identificateur d’abonnement
PS C:\> Unregister-Event -SubscriptionId 2
Cette commande annule l’abonnement aux événements qui a un identificateur d’abonnement de 2.
Pour rechercher l’identificateur d’abonnement d’un abonnement à un événement, utilisez l’applet de commande Get-EventSubscriber.
Exemple 3 : Annuler tous les abonnements aux événements
PS C:\> Get-EventSubscriber -Force | Unregister-Event -Force
Cette commande annule tous les abonnements aux événements dans la session.
La commande utilise l’applet Get-EventSubscriber de commande pour obtenir tous les objets d’abonné d’événement dans la session, y compris les abonnés qui sont masqués à l’aide du paramètre SupportEvent des applets de commande d’inscription d’événement.
Il utilise un opérateur de pipeline (|) pour envoyer les objets d’abonné à Unregister-Event, qui les supprime de la session. Pour terminer la tâche, le paramètre Force est également requis sur Unregister-Event.
Paramètres
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | cf |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Force
Annule tous les abonnements aux événements, y compris les abonnements masqués à l’aide du paramètre supportEvent de Register-ObjectEvent, Register-WmiEventet Register-EngineEvent.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-SourceIdentifier
Spécifie un identificateur source que cette applet de commande annule les abonnements aux événements.
Un paramètre SourceIdentifier ou SubscriptionId doit être inclus dans chaque commande.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
BySource
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-SubscriptionId
Spécifie un ID d’identificateur source que cette applet de commande annule les abonnements aux événements.
Un paramètre SourceIdentifier ou SubscriptionId doit être inclus dans chaque commande.
Propriétés du paramètre
| Type: | Int32 |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
ById
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | Wi |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
Entrées
PSEventSubscriber
Vous pouvez diriger la sortie de Get-EventSubscriber vers cette applet de commande.
Sorties
None
Cette applet de commande ne retourne aucune sortie.
Notes
Aucune source d’événements n’est disponible sur les plateformes Linux ou macOS.
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 la session active, la file d’attente d’événements est ignorée et l’abonnement à l’événement est annulé.
Unregister-Event ne peut pas supprimer les événements créés à l’aide de l’applet de commande New-Event, sauf si vous vous êtes abonné à l’événement à l’aide de l’applet de commande Register-EngineEvent. Pour supprimer un événement personnalisé de la session, vous devez le supprimer par programme ou fermer la session.