Vue d’ensemble des applets de commande

Une applet de commande est une commande légère qui est utilisée dans l’environnement PowerShell. Le runtime PowerShell appelle ces applets de commande dans le contexte des scripts d’automatisation fournis sur la ligne de commande. Le runtime PowerShell les appelle également par programme par le biais des API PowerShell.

Applets de commande

Les applets de commande effectuent une action et retournent généralement un objet Microsoft .NET à la commande suivante dans le pipeline. Une applet de commande est une commande unique qui participe à la sémantique de pipeline de PowerShell. Cela comprend les applets de commande binaires (C#), les fonctions de script avancées, le CDXML et les workflows.

La documentation de ce kit de développement logiciel (SDK) décrit comment créer des applets de commande binaires écrites en C#. Pour plus d’informations sur les applets de commande basées sur des scripts, consultez :

Pour créer une applet de commande binaire, vous devez implémenter une classe d’applet de commande qui dérive de l’une des deux classes de base d’applets de commande spécialisées. La classe dérivée doit :

  • Déclarez un attribut qui identifie la classe dérivée en tant qu’applet de commande.
  • Définissez les propriétés publiques qui sont décorées avec des attributs qui identifient les propriétés publiques comme paramètres d’applet de commande.
  • Remplacez une ou plusieurs méthodes de traitement d’entrée pour traiter les enregistrements.

Vous pouvez charger l’assembly qui contient la classe directement à l’aide de l’applet de commande import-module , ou vous pouvez créer une application hôte qui charge l’assembly à l’aide de l’API System.Management.Automation.Runspaces.Initialsessionstate . Les deux méthodes fournissent un accès par programmation et en ligne de commande à la fonctionnalité de l’applet de commande.

Termes de l’applet de commande

Les termes suivants sont fréquemment utilisés dans la documentation sur les applets de commande PowerShell :

Attribut d’applet de commande

Attribut .NET utilisé pour déclarer une classe d’applet de commande en tant qu’applet de commande. Bien que PowerShell utilise plusieurs autres attributs facultatifs, l’attribut d’applet de commande est requis. Pour plus d’informations sur cet attribut, consultez déclaration d’attribut d’appletde commande.

Paramètre d’applet de commande

Les propriétés publiques qui définissent les paramètres disponibles pour l’utilisateur ou pour l’application qui exécute l’applet de commande. Les applets de commande peuvent avoir des paramètres requis, nommés, positionnels et de commutateur . Les paramètres de commutateur vous permettent de définir des paramètres qui sont évalués uniquement si les paramètres sont spécifiés dans l’appel. Pour plus d’informations sur les différents types de paramètres, consultez paramètres d’appletde commande.

Jeu de paramètres

Groupe de paramètres qui peut être utilisé dans la même commande pour effectuer une action spécifique. Une applet de commande peut avoir plusieurs jeux de paramètres, mais chaque jeu de paramètres doit avoir au moins un paramètre unique. Une bonne conception d’applet de commande suggère fortement que le paramètre unique est également un paramètre obligatoire. Pour plus d’informations sur les jeux de paramètres, consultez jeux de paramètres d’appletde commande.

Paramètre dynamique

Paramètre qui est ajouté à l’applet de commande au moment de l’exécution. En règle générale, les paramètres dynamiques sont ajoutés à l’applet de commande lorsqu’un autre paramètre est défini sur une valeur spécifique. Pour plus d’informations sur les paramètres dynamiques, consultez paramètres dynamiques des appletsde commande.

Méthodes de traitement d’entrée

La classe System. Management. Automation. applet de commande fournit les méthodes virtuelles suivantes qui sont utilisées pour traiter les enregistrements. Toutes les classes d’applet de commande dérivées doivent remplacer une ou plusieurs des trois premières méthodes :

Pour plus d’informations sur ces méthodes, consultez méthodes de traitement d’entrée des appletsde commande.

Lorsque vous implémentez une applet de commande, vous devez remplacer au moins l’une de ces méthodes de traitement d’entrée. En règle générale, ProcessRecord () est la méthode que vous substituez, car elle est appelée pour chaque enregistrement traité par l’applet de commande. En revanche, la méthode BeginProcessing () et la méthode EndProcessing () sont appelées une fois pour effectuer le pré-traitement ou le postérieur au traitement des enregistrements. Pour plus d’informations sur ces méthodes, consultez méthodes de traitement d’entrée.

Fonction ShouldProcess

PowerShell vous permet de créer des applets de commande qui invitent l’utilisateur à entrer des commentaires avant que l’applet de commande n’apporte une modification au système. Pour utiliser cette fonctionnalité, l’applet de commande doit déclarer qu’elle prend en charge la ShouldProcess fonctionnalité lorsque vous déclarez l’attribut d’applet de commande, et l’applet de commande doit appeler les méthodes System. Management. Automation. cmdlet. ShouldProcess et System. Management. Automation. cmdlet. ShouldContinue à partir d’une méthode de traitement d’entrée. Pour plus d’informations sur la façon de prendre en charge la ShouldProcess fonctionnalité, consultez demande de confirmation.

Transaction

Groupe logique de commandes traitées comme une tâche unique. La tâche échoue automatiquement si une commande du groupe échoue et que l’utilisateur a le choix d’accepter ou de rejeter les actions effectuées dans la transaction. Pour participer à une transaction, l’applet de commande doit déclarer qu’elle prend en charge les transactions lorsque l’attribut d’applet de commande est déclaré. La prise en charge des transactions a été introduite dans Windows PowerShell 2,0. Pour plus d’informations sur les transactions, consultez How to support transactions.

Différences entre les applets de commande et les commandes

Les applets de commande diffèrent des commandes dans d’autres environnements de l’interpréteur de commandes des manières suivantes :

  • Les applets de commande sont des instances de classes .NET. ce ne sont pas des exécutables autonomes.
  • Les applets de commande peuvent être créées à partir d’une douzaine de lignes de code.
  • Les applets de commande n’effectuent généralement pas leur propre analyse, présentation d’erreur ou mise en forme de sortie. L’analyse, la présentation des erreurs et la mise en forme de la sortie sont gérées par le runtime PowerShell.
  • Les applets de commande traitent les objets d’entrée du pipeline plutôt que des flux de texte, et les cmdlets délivrent généralement des objets comme sortie au pipeline.
  • Les applets de commande sont orientées enregistrement, car elles traitent un seul objet à la fois.

Classes de base de l’applet de commande

Windows PowerShell prend en charge les applets de commande dérivées des deux classes de base suivantes.

  • La plupart des applets de commande sont basées sur les classes .NET qui dérivent de la classe de base System. Management. Automation. applet de commande. La dérivation de cette classe permet à une applet de commande d’utiliser l’ensemble minimal de dépendances sur le runtime Windows PowerShell. Cela a deux avantages. Le premier avantage est que les objets d’applet de commande sont plus petits et que vous êtes moins susceptible d’être affecté par les modifications apportées au runtime PowerShell. Le deuxième avantage est que, si vous en avez besoin, vous pouvez créer directement une instance de l’objet cmdlet, puis l’appeler directement au lieu de l’appeler par le biais du runtime PowerShell.

  • Les applets de commande plus complexes sont basées sur les classes .NET qui dérivent de la classe de base System. Management. Automation. PSCmdlet . La dérivation de cette classe vous donne un plus grand accès au runtime PowerShell. Cet accès permet à votre applet de commande d’appeler des scripts, d’accéder à des fournisseurs et d’accéder à l’état de session actuel. (Pour accéder à l’état de session actuel, vous recevez et définissez des variables et des préférences de session.) Toutefois, la dérivation de cette classe augmente la taille de l’objet d’applet de commande, et cela signifie que votre applet de commande est plus étroitement couplée à la version actuelle du runtime PowerShell.

En général, sauf si vous avez besoin de l’accès étendu au runtime PowerShell, vous devez dériver de la classe System. Management. Automation. applet de commande. Toutefois, le runtime PowerShell dispose de fonctionnalités de journalisation étendues pour l’exécution des applets de commande. Si votre modèle d’audit dépend de cette journalisation, vous pouvez empêcher l’exécution de votre applet de commande à partir d’une autre applet de commande en dérivant de la classe System. Management. Automation. PSCmdlet .

Attributs des applets de commande

PowerShell définit plusieurs attributs .NET utilisés pour gérer les applets de commande et pour spécifier les fonctionnalités communes fournies par PowerShell et qui peuvent être requises par l’applet de commande. Par exemple, les attributs sont utilisés pour désigner une classe comme applet de commande, pour spécifier les paramètres de l’applet de commande et pour demander la validation de l’entrée afin que les développeurs d’applets de commande n’aient pas à implémenter cette fonctionnalité dans leur code d’applet de commande. Pour plus d’informations sur les attributs, consultez attributs PowerShell.

Noms des applets de commande

PowerShell utilise une paire verbe-and-substantif pour nommer les applets de commande. Par exemple, l' Get-Command applet de commande incluse dans PowerShell est utilisée pour obtenir toutes les cmdlets inscrites dans l’interface de commande. Le verbe identifie l’action effectuée par l’applet de commande, et le nom identifie la ressource sur laquelle l’applet de commande exécute son action.

Ces noms sont spécifiés lorsque la classe .NET est déclarée en tant qu’applet de commande. Pour plus d’informations sur la façon de déclarer une classe .NET en tant qu’applet de commande, consultez déclaration d’attribut d’appletde commande.

Écriture du code de l’applet de commande

Ce document propose deux méthodes pour découvrir comment le code de l’applet de commande est écrit. Si vous préférez voir le code sans trop d’explications, consultez exemples de code d’applet decommande. Si vous préférez plus d’explications sur le code, consultez les rubriques didacticiel GetProc, didacticiel StopProcou didacticiel SelectStr .

Pour plus d’informations sur les instructions d’écriture des applets de commande, consultez instructions de développement d’appletsde commande.

Voir aussi

Concepts des applets de commande PowerShell

Écriture d’une applet de commande PowerShell

Kit de développement logiciel (SDK) PowerShell