13. Applets de commande

Note éditoriale

Important

La spécification du langage Windows PowerShell 3.0 a été publiée en décembre 2012 et est basée sur Windows PowerShell 3.0. Cette spécification ne reflète pas l’état actuel de PowerShell. Il n’existe aucun plan de mise à jour de cette documentation pour refléter l’état actuel. Cette documentation est présentée ici pour référence historique.

Le document de spécification est disponible en tant que document Microsoft Word à partir du Centre de téléchargement Microsoft à l’adresse : https://www.microsoft.com/download/details.aspx?id=36389 ce document Word a été converti pour présentation ici sur Microsoft Learn. Pendant la conversion, certaines modifications éditoriales ont été apportées pour prendre en charge la mise en forme de la plateforme Docs. Certaines fautes de frappe et erreurs mineures ont été corrigées.

Une applet de commande est une commande à fonctionnalité unique qui manipule des objets dans PowerShell. Les applets de commande peuvent être reconnues par leur format de nom, un verbe et un nom séparés par un tiret (-), par exemple Get-Help, Get-Process et Start-Service. Un modèle de verbe est un verbe exprimé à l’aide de caractères génériques, comme dans W*. Un modèle de nom est un nom exprimé à l’aide de caractères génériques, comme dans event.

Les applets de commande doivent être simples et être conçues pour être utilisées en combinaison avec d’autres applets de commande. Par exemple, les cmdlets Get ne doivent récupérer que des données, les cmdlets Set ne doivent qu'établir ou modifier des données, les cmdlets Format doivent uniquement mettre en forme les données, et les cmdlets Out doivent uniquement diriger le résultat vers une destination spécifiée.

Pour chaque applet de commande, fournissez un fichier d’aide accessible en tapant :

Get-Help *cmdlet-name* -Detailed

L’affichage détaillé du fichier d’aide de l’applet de commande doit inclure une description de l’applet de commande, la syntaxe de commande, les descriptions des paramètres et un exemple illustrant l’utilisation de cette applet de commande.

Les applets de commande sont utilisées de la même façon que les commandes et utilitaires du système d’exploitation. Les commandes PowerShell ne respectent pas la casse.

Remarque

Remarque de l’éditeur : le document d’origine contient une liste d’applets de commande avec des descriptions, des diagrammes de syntaxe, des définitions de paramètres et des exemples. Ces informations sont incomplètes et obsolètes. Pour plus d’informations sur l’applet de commande, consultez la section Informations de référence de la documentation PowerShell.

13.1 Paramètres courants

Les paramètres communs sont un ensemble de paramètres de cmdlet qui peuvent être utilisés avec n’importe quel cmdlet. Ils sont implémentés par l’environnement d’exécution PowerShell lui-même, et non par le développeur d’applets de commande, et ils sont automatiquement disponibles pour n’importe quelle applet de commande ou fonction qui utilise l’attribut paramètre (§12.3.7) ou l’attribut CmdletBinding (§12.3.5).

Bien que les paramètres communs soient acceptés par n’importe quelle applet de commande, il se peut qu’ils n’aient aucune sémantique pour cette applet de commande. Par exemple, si une applet de commande ne génère aucune sortie verbale, l'utilisation du paramètre commun Verbose n'a aucun effet.

Plusieurs paramètres courants remplacent les paramètres système par défaut ou préférences qui peuvent être définis via des variables de préférence (§2.3.2.3). Contrairement aux variables de préférence, les paramètres communs affectent uniquement les commandes dans lesquelles elles sont utilisées.

Remarque

Remarque de l’éditeur : le document d’origine contient une liste des paramètres communs. Ces informations sont incomplètes et obsolètes. Pour des informations actuelles, consultez about_CommonParameters.