RUBRIQUE
about_Command_Syntax
DESCRIPTION COURTE
Décrit la notation utilisée pour la syntaxe Windows PowerShell
dans l'aide.
DESCRIPTION LONGUE
L'applet de commande Get-Help décrit l'utilisation des paramètres
d'une applet de commande. L'applet de commande Get-Help fait appel
aux symboles spéciaux suivants :
Les crochets angulaires (<>) indiquent le texte d'un espace
réservé. Les crochets ([]) indiquent des éléments optionnels.
Les accolades ({}) indiquent un choix entre plusieurs valeurs.
Certaines applets de commande comportent plusieurs jeux de
paramètres. Des jeux de paramètres distincts peuvent partager certains
paramètres. L'applet de commande Get-Help affiche tous les jeux de
paramètres d'une applet de commande.
Vous pouvez trouver des informations supplémentaires sur un
paramètre dans sa description et dans la table des attributs de
paramètres. Pour afficher des informations complètes sur un paramètre,
utilisez les paramètres Full ou Parameter de Get-Help.
Syntaxe
L'aide des applets de commande Windows PowerShell, les rubriques
correspondantes et d'autres éléments de documentation utilisent la
notation suivante pour les applets de commande dans les descriptions
de syntaxe.
<nom de l'applet de commande> -<Nom du paramètre
obligatoire> <Valeur du paramètre obligatoire>
[-<Nom du paramètre optionnel> <Valeur du paramètre
optionnel>]
[-<Paramètre booléen optionnel>]
[-<Nom du paramètre optionnel>] <Valeur du
paramètre obligatoire>
La syntaxe de l'applet de commande New-Alias est présentée ci-dessous.
New-Alias [-Force] [-PassThru] [-Scope <chaîne>]
[-Option {None | ReadOnly | Constant | Private | AllScope}]
[-Description <chaîne>] [-Name] <chaîne> [-Value] <chaîne>
[-confirm] [-whatif] [<Paramètres courants>]
La syntaxe est en majuscules pour une meilleure lisibilité,
mais Windows PowerShell ne respecte pas la casse.
Les paramètres apparaissent dans l'ordre indiqué. L'ordre des
paramètres est important uniquement lorsque les noms de
paramètres sont optionnels. Si vous ne spécifiez pas de nom de
paramètre lorsque vous utilisez une applet de commande, Windows
PowerShell attribue des valeurs aux paramètres en fonction de
la position et du type.
Les noms de paramètres sont précédés d'un trait d'union (-). Les
paramètres booléens apparaissent sans type de valeur. Les autres
paramètres apparaissent avec le type Microsoft .NET Framework de
l'argument obligatoire ou avec une énumération de valeurs possibles.
Pour plus d'informations sur les types .NET Framework, consultez
https://go.microsoft.com/fwlink/? LinkId=143682.
Les crochets angulaires (<>) indiquent le texte d'un espace
réservé. Ce texte peut décrire le type d'un élément (tel qu'une
chaîne ou un objet Process). Il peut galement correspondre à un
éespace réservé pour un ou plusieurs paramètres courants.
Les crochets ([]) indiquent des éléments optionnels. Un
paramètre ou le nom d'un paramètre obligatoire peut être
optionnel. Les paramètres booléens sont toujours optionnels.
Les accolades ({}) encadrent les valeurs d'une énumération.
Dans l'exemple de l'applet de commande New-Alias, le paramètre
Option peut prendre n'importe laquelle des valeurs indiquées.
Éléments optionnels
Les crochets ([]) encadrent des éléments optionnels. Par
exemple, dans la description de syntaxe de l'applet de commande
New-Alias description, le paramètre Scope est optionnel. Cela
est indiqué dans la syntaxe par les crochets encadrant le nom
et le type du paramètre :
[-Scope <chaîne>]
Les deux exemples suivants illustrent des emplois corrects 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 optionnel même si la valeur du
paramètre est obligatoire. Cela est indiqué dans la syntaxe par les
crochets qui encadrent le nom du paramètre, mais pas son type, comme dans
l'exemple suivant de l'applet de commande New-Alias :
[-Name] <chaîne> [-Value] <chaîne>
Les commandes suivantes utilisent l'applet de commande
New-Alias de façon appropriée. Elles 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 de paramètre n'est pas inclus dans l'instruction
telle qu'elle est tapée, Windows PowerShell tente d'utiliser la
position des arguments pour attribuer les valeurs au paramètre.
L'exemple suivant n'est pas complet :
New-Alias utd
Cette applet de commande requiert des valeurs pour les
paramètres Name et Value.
Dans les exemples de syntaxe, les crochets sont également
utilisés pour l'attribution de noms et le transtypage vers
des types .NET Framework. Dans ce contexte, les crochets
n'indiquent pas qu'un élément est optionnel.
Arguments de tableau
Les crochets sont également utilisés dans les descriptions de
syntaxe pour représenter un tableau. L'exemple suivant présente
la syntaxe de l'applet de commande Restart-Service :
Restart-Service [-Name] <string[]> [-Include <string[]>]
[-Exclude <string[]>] [-Force] [-PassThru] [-Confirm] [-WhatIf]
[<Paramètres courants>]
Le paramètre Name requiert un argument. Plus précisément, il
requiert le nom du service à redémarrer. Il peut accepter une
liste de services séparés par des virgules, comme dans
l'exemple suivant :
Restart-Service RasAuto, RasMan, RemoteAccess
VOIR AUSSI
Get-Help