Unregister-Event

  • Référence
Module:
Microsoft.PowerShell.Utility

Annule un abonnement aux événements.

Syntax

Unregister-Event
          [-SourceIdentifier] <String>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-Event
          [-SubscriptionId] <Int32>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Description

L’applet Unregister-Event de commande annule un abonnement aux événements créé à l’aide de l’applet de commande , Register-ObjectEventou Register-WmiEvent de l’applet Register-EngineEventde commande.

Quand un abonnement aux événements est annulé, l'abonné aux événements est supprimé de la session et les événements ayant fait l'objet d'un abonnement 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 New-Event de commande, 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 Remove-Event commande.

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 Get-Event de commande. Pour rechercher l’identificateur source d’un abonnement aux événements, 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 l'identificateur d'abonnement 2.

Pour rechercher l’identificateur d’abonnement d’un abonnement à un événement, utilisez l’applet Get-EventSubscriber de commande.

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é aux événements dans la session, y compris les abonnés masqués à l’aide du paramètre SupportEvent des applets de commande d’inscription d’événements.

Il utilise un opérateur de pipeline (|) pour envoyer les objets abonnés à Unregister-Event, ce 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 demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

Type:Int32
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

PSEventSubscriber

Vous pouvez diriger la sortie vers cette applet de Get-EventSubscriber commande.

Sorties

None

Cette applet de commande ne retourne pas de 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 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 New-Event de commande, sauf si vous vous êtes abonné à l’événement à l’aide de l’applet Register-EngineEvent de commande. Pour supprimer un événement personnalisé de la session, vous devez le supprimer par programmation ou fermer la session.