about_Command_Syntax
Mis à jour: mai 2014
S'applique à: Windows PowerShell 2.0, Windows PowerShell 3.0, Windows PowerShell 4.0, Windows PowerShell 5.0
Insérez l'introduction ici.
RUBRIQUE
about_Command_Syntax
DESCRIPTION COURTE
Décrit les diagrammes de syntaxe utilisés dans Windows PowerShell®.
DESCRIPTION DÉTAILLÉE
Les applets de commande Get-Help et Get-Command affichent les diagrammes de syntaxe pour vous aider à construire les commandes correctement. Cette rubrique explique comment interpréter les diagrammes de syntaxe.
DIAGRAMMES DE SYNTAXE
Chaque paragraphe d'un diagramme de syntaxe de commande représente une forme valide de la commande.
Pour construire une commande, suivez le diagramme de syntaxe de gauche à droite. Sélectionnez au sein des paramètres facultatifs et fournissez des valeurs pour les espaces réservés.
Windows PowerShell utilise la notation suivante pour les diagrammes de syntaxe.
<command-name> -<Required Parameter Name> <Required Parameter Value>
[-<Optional Parameter Name> <Optional Parameter Value>]
[-<Optional Switch Parameters>]
[-<Optional Parameter Name>] <Required Parameter Value>
La syntaxe de l'applet de commande New-Alias est la suivante.
New-Alias [-Name] <string> [-Value] <string> [-Description <string>]
[-Force] [-Option {None | ReadOnly | Constant | Private | AllScope}]
[-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
La syntaxe est en majuscules pour une meilleure lisibilité, mais Windows PowerShell n'est pas sensible à la casse.
Le diagramme de syntaxe possède les éléments suivants.
NOM DE LA COMMANDE
------------
Les commandes commencent toujours par un nom de commande, comme New-Alias. Tapez le nom de commande ou son alias, tel que « gcm » pour Get-Command.
PARAMÈTRES
----------
Les paramètres d'une commande sont des options qui déterminent ce que fait la commande. Certains paramètres acceptent une « valeur », qui est l'entrée utilisateur de la commande.
Par exemple, la commande Get-Help possède un paramètre Name qui vous permet de spécifier le nom de la rubrique pour laquelle l'aide est affichée. Le nom de la rubrique est la valeur du paramètre Name.
Dans une commande Windows PowerShell, les noms de paramètre commencent toujours par un trait d'union. Le trait d'union indique à Windows PowerShell que l'élément dans la commande est un nom de paramètre.
Par exemple, pour utiliser le paramètre Name de New-Alias, vous tapez ce qui suit :
-Name
Les paramètres peuvent être obligatoires ou facultatifs. Dans un diagramme de syntaxe, les éléments facultatifs sont placés entre crochets ([ ]).
Pour plus d'informations sur les paramètres, consultez about_Parameters.
VALEURS DE PARAMÈTRE
----------------
Une valeur de paramètre est l'entrée que le paramètre accepte. Comme Windows PowerShell repose sur le Microsoft .NET Framework, les valeurs de paramètre sont représentées dans le diagramme de syntaxe par leur type .NET.
Par exemple, le paramètre Name de Get-Help prend une valeur de type String, qui est une chaîne de texte, comme un mot unique ou plusieurs mots placés entre guillemets.
[-Name] <string>
Le type .NET d'une valeur de paramètre est placé entre crochets angulaires (< >) pour indiquer qu'il s'agit d'un espace réservé pour une valeur, et non d'un littéral que vous tapez dans une commande.
Pour utiliser le paramètre, remplacez l'espace réservé de type .NET par un objet ayant le type .NET spécifié.
Par exemple, pour utiliser le paramètre Name, tapez « -Name » suivi d'une chaîne, telle que la suivante :
-Name MyAlias
PARAMÈTRES SANS VALEURS
-------------------------
Certains paramètres n'acceptent pas d'entrée et, donc, n'ont pas de valeur de paramètre. Les paramètres sans valeurs sont appelés « paramètres de commutateur », car ils fonctionnent comme commutateurs de type activé/désactivé. Vous les incluez (on) ou les omettez (off) dans une commande.
Pour utiliser un paramètre de commutateur, tapez simplement le nom du paramètre, précédé d'un trait d'union.
Par exemple, pour utiliser le paramètre WhatIf de l'applet de commande New-Alias, tapez ce qui suit :
-WhatIf
JEUX DE PARAMÈTRES
--------------
Les paramètres d'une commande sont répertoriés dans des jeux de paramètres. Les jeux de paramètres s'apparentent aux paragraphes d'un diagramme de syntaxe.
L'applet de commande New-Alias possède un jeu de paramètres, mais de nombreuses applets de commande ont plusieurs jeux de paramètres. Certains paramètres d'applet de commande sont spécifiques à un jeu de paramètres et d'autres apparaissent dans plusieurs jeux de paramètres.
Chaque jeu de paramètres représente le format d'une commande valide. Un jeu de paramètres inclut uniquement les paramètres qui peuvent être utilisés ensemble dans une commande. Si les paramètres ne peuvent pas être utilisés dans la même commande, ils apparaissent dans des jeux de paramètres distincts.
Par exemple, l'applet de commande Get-Random possède les jeux de paramètres suivants :
Get-Random [[-Maximum] <Object>] [-Minimum <Object>] [-SetSeed <int>]
[<CommonParameters>]
Get-Random [-InputObject] <Object[]> [-Count <int>] [-SetSeed <int>]
[<CommonParameters>]
Le premier jeu de paramètres, qui retourne un nombre aléatoire, possède les paramètres Minimum et Maximum. Le deuxième jeu de paramètres, qui renvoie un objet sélectionné de façon aléatoire à partir d'un ensemble d'objets, inclut les paramètres InputObject et Count. Les deux jeux de paramètres ont le paramètre Set-Seed et les paramètres communs.
Ces jeux de paramètres indiquent que vous pouvez utiliser les paramètres InputObject et Count dans la même commande, mais vous ne pouvez pas utiliser les paramètres Maximum et Count dans la même commande.
Vous indiquez quel jeu de paramètres vous voulez utiliser avec les paramètres de ce jeu de paramètres.
Toutefois, chaque applet de commande possède aussi un jeu de paramètres par défaut. Le jeu de paramètres par défaut est utilisé lorsque vous ne spécifiez pas de paramètres spécifiques à un jeu de paramètres. Par exemple, si vous utilisez Get-Random sans paramètres, Windows PowerShell suppose que vous utilisez le jeu de paramètres Number et l'applet de commande retourne un nombre aléatoire.
Dans chaque jeu de paramètres, les paramètres apparaissent par ordre de position. L'ordre des paramètres d'une commande n'importe que lorsque vous omettez les noms des paramètres facultatifs. Lorsque les noms des paramètres sont omis, Windows PowerShell assigne des valeurs aux paramètres par position et par type. Pour plus d'informations sur la position des paramètres, consultez about_Parameters.
SYMBOLES DANS LES DIAGRAMMES DE SYNTAXE
Le diagramme de syntaxe répertorie le nom de la commande, les paramètres de la commande et les valeurs des paramètres. Il utilise également des symboles pour montrer comment construire une commande valide.
Les diagrammes de syntaxe utilisent les symboles suivants :
-- Un trait d'union (-) indique un nom de paramètre. Dans une commande, tapez le trait d'union immédiatement avant le nom du paramètre sans espace, comme illustré dans le diagramme de syntaxe.
Par exemple, pour utiliser le paramètre Name de New-Alias, tapez :
-Name
-- Les crochets angulaires (<>) indiquent un texte d'espace réservé. Vous ne tapez pas les crochets angulaires ou le texte d'espace réservé dans une commande. Au lieu de cela, vous les remplacez par l'élément décrit.
Les crochets angulaires permettent d'identifier le type .NET de la valeur que prend un paramètre. Par exemple, pour utiliser le paramètre Name de l'applet de commande New-Alias, vous remplacez la <chaîne> par une chaîne, qui est un seul mot ou un groupe de mots placés entre guillemets.
-- Les crochets ([ ]) indiquent des éléments facultatifs. Un paramètre et sa valeur peuvent être facultatifs, ou le nom d'un paramètre requis peut être facultatif.
Par exemple, le paramètre Description de New-Alias et sa valeur sont placés entre crochets, car ils sont tous deux facultatifs.
[-Description <string>]
Les crochets indiquent également que la valeur du paramètre Name (<string>) est requise, mais le nom du paramètre, « Name », est facultatif.
[-Name] <string>
-- Un crochet gauche et un crochet droit ([ ]) ajoutés à un type .NET indiquent que le paramètre peut accepter une ou plusieurs valeurs de ce type. Entrez les valeurs dans une liste séparée par des virgules.
Par exemple, le paramètre Name de l'applet de commande New-Alias accepte uniquement une chaîne, mais le paramètre Name de Get-Process peut accepter une ou plusieurs chaînes.
New-Alias [-Name] <string>
New-Alias -Name MyAlias
Get-Process [-Name] <string[]>
Get-Process -Name Explorer, Winlogon, Services
-- Les accolades ({}) indiquent une « énumération », qui est un ensemble de valeurs valides pour un paramètre.
Les valeurs entre accolades sont séparées par des barres verticales (|). Ces barres indiquent un choix « ou exclusif », ce qui signifie que vous ne pouvez choisir qu'une seule valeur dans l'ensemble des valeurs répertoriées dans les accolades.
Par exemple, la syntaxe de l'applet de commande New-Alias inclut l'énumération des valeurs suivantes pour le paramètre Option :
-Option {None | ReadOnly | Constant | Private | AllScope}
Les accolades et les barres verticales indiquent que vous pouvez choisir l'une des valeurs répertoriées pour le paramètre Option, tel que ReadOnly ou AllScope.
-Option ReadOnly
ÉLÉMENTS FACULTATIFS
Les crochets ([]) entourent les éléments facultatifs. Par exemple, dans la description de la syntaxe de l'applet de commande New-Alias, le paramètre Scope est facultatif. Cela est indiqué dans la syntaxe par les crochets autour du nom du paramètre et du type :
[-Scope <string>]
Les deux exemples suivants sont des utilisations correctes de l'applet de commande New-Alias :
New-Alias -Name utd -Value Update-TypeData
New-Alias -Name utd -Value Update-TypeData -Scope global
Un nom de paramètre peut être facultatif, même si la valeur pour ce paramètre est obligatoire. Cela est indiqué dans la syntaxe par les crochets autour du nom de paramètre, mais pas le type de paramètre, comme dans cet exemple à partir de l'applet de commande New-Alias :
[-Name] <string> [-Value] <string>
Les commandes suivantes utilisent correctement l'applet de commande New-Alias. Les commandes produisent le même résultat.
New-Alias -Name utd -Value Update-TypeData
New-Alias -Name utd Update-TypeData
New-Alias utd -Value Update-TypeData
New-Alias utd Update-TypeData
Si le nom du paramètre n'est pas inclus dans l'instruction tel que tapé, Windows PowerShell essaie d'utiliser la position des arguments pour assigner les valeurs aux paramètres.
L'exemple suivant n'est pas complet :
New-Alias utd
Cette applet de commande requiert des valeurs pour les noms Name et Value.
Dans les exemples de syntaxe, les crochets sont aussi utilisés dans la dénomination et la conversion en types .NET Framework. Dans ce contexte, les crochets n'indiquent pas qu'un élément est facultatif.
MOTS CLÉS
about_Symbols
about_Punctuation
about_Help_Syntax
VOIR AUSSI
about_Parameters
Get-Command
Get-Help