RUBRIQUE
about_Parameters
DESCRIPTION COURTE
Décrit comment gérer les paramètres d'applet de commande dans Windows
PowerShell.
DESCRIPTION LONGUE
La plupart des fonctions et applets de commande de Windows PowerShell
reposent sur des paramètres pour permettre aux utilisateurs de
sélectionner des options ou de fournir une entrée. Les paramètres
suivent le nom de fonction ou d'applet de commande et ont
généralement le format suivant :
-<nom-paramètre> <valeur-paramètre>
Le nom du paramètre est précédé d'un trait d'union (-) pour signaler à
Windows PowerShell que le mot qui le suit est un paramètre et non une
valeur passée à la fonction ou l'applet de commande. Tous les
paramètres ne requièrent pas de valeur, et tous les noms de
paramètres n'ont pas besoin d'être spécifiés. Dans certains cas,
le nom du paramètre est implicite et n'a pas besoin d'être inclus
dans la commande.
Le type des paramètres et les conditions requises pour ceux-ci
varient d'une fonction et d'une applet de commande à l'autre.
Pour plus d'informations sur les paramètres d'une applet de commande,
utilisez l'applet de commande Get-Help. Par exemple, pour rechercher
des informations sur les paramètres de l'applet de commande
Get-ChildItem, tapez :
get-help get-childitem
Pour rechercher des informations sur les paramètres d'une
fonction, examinez les définitions de paramètre. Les paramètres
sont définis après le nom de fonction ou dans le corps de la
fonction, à l'aide du mot clé Param. Pour plus d'informations,
consultez about_Functions.
Certaines fonctions contiennent également de l'aide basée sur des
commentaires à propos des paramètres. Utilisez l'applet de commande
Get-Help avec ces fonctions. Pour plus d'informations, consultez la
rubrique d'aide sur Get-Help et about_Comment_Based_Help.
L'applet de commande Get-Help retourne divers détails sur la
fonction ou l'applet de commande, notamment une description, la
syntaxe de commande, des informations sur les paramètres et des
exemples indiquant comment utiliser la fonction ou l'applet de
commande.
Vous pouvez également utiliser le paramètre Parameter de la
fonction ou applet de commande Get-Help pour rechercher des
informations sur un paramètre particulier. Sinon, vous pouvez
utiliser le caractère générique (*) avec le paramètre Parameter
pour rechercher des informations sur tous les paramètres de la
fonction ou applet de commande. Par exemple, la commande suivante
obtient des informations sur tous les paramètres de la fonction
ou applet de commande Get-Member :
get-help get-member -parameter *
Ces informations incluent les détails que vous avez besoin de
connaître pour utiliser le paramètre. Par exemple, la rubrique
d'aide de l'applet de commande Get-ChildItem inclut les détails
suivants sur son paramètre Path :
-path <string[]>
Spécifie un chemin d'accès d'un ou de plusieurs
emplacements. Les caractères génériques sont autorisés.
L'emplacement par défaut est le répertoire actif (.).
Obligatoire ? false
Position ? 1
Valeur par défaut Répertoire actif
Accepter l'entrée de pipeline ? true (ByValue, ByPropertyName)
Accepter les caractères génériques ? true
Les informations de paramètre incluent la syntaxe de paramètre,
une description du paramètre et les attributs de paramètre.
Les sections suivantes décrivent les attributs de paramètre.
Paramètre obligatoire ?
Cette valeur indique si le paramètre est obligatoire,
c'est-à-dire si toutes les commandes qui utilisent cette applet
de commande doivent l'inclure ou non. Lorsque la valeur est
" True " et que le paramètre est absent de la commande, Windows
PowerShell vous invite à fournir une valeur pour le paramètre.
Position du paramètre ?
Cette valeur indique si vous pouvez fournir la valeur d'un
paramètre sans la faire précéder du nom de paramètre. Si cette
valeur est définie sur " 0 " ou sur " named ", un nom de paramètre
est requis. Ce type de paramètre est appelé paramètre " nommé ".
Un paramètre nommé peut être répertorié à n'importe quel
emplacement après le nom de l'applet de commande.
Si la valeur " Position du paramètre ? " est définie sur un
nombre entier autre que 0, le nom du paramètre n'est pas
obligatoire. Ce type de paramètre est appelé paramètre
" positionnel " et le nombre indique la position à laquelle doit
figurer ce paramètre par rapport aux autres paramètres
positionnels. Si vous incluez le nom de paramètre pour un paramètre
positionnel, celui-ci peut figurer n'importe où après le nom de
l'applet de commande.
Par exemple, l'applet de commande Get-ChildItem comporte les
paramètres Path et Exclude. La valeur " Position du paramètre ? "
pour Path est 1, ce qui signifie qu'il s'agit d'un paramètre
positionnel. La valeur " Position du paramètre ? " pour Exclude
est 0, ce qui signifie qu'il s'agit d'un paramètre nommé.
Cela signifie que Path ne requiert pas de nom de paramètre,
mais que sa valeur de paramètre doit être la première ou
l'unique valeur de paramètre sans nom de la commande.
Toutefois, étant donné que le paramètre Exclude est un
paramètre nommé, vous pouvez le placer n'importe où
dans la commande.
Avec ces valeurs " Position du paramètre ? " pour ces deux
paramètres, les commandes suivantes peuvent être utilisées :
Get-ChildItem -path c:\techdocs -exclude *.ppt
Get-ChildItem c:\techdocs -exclude *.ppt
Get-ChildItem -exclude *.ppt -path c:\techdocs
Get-ChildItem -exclude *.ppt c:\techdocs
Si vous deviez inclure un autre paramètre positionnel sans nom de
paramètre, celui-ci devrait être placé dans l'ordre spécifié par
la valeur " Position du paramètre ? ".
Type de paramètre
Cette valeur spécifie le type Microsoft .NET Framework de la valeur de
paramètre. Par exemple, si le type est Int32, la valeur de paramètre
doit être un nombre entier. Si le type est string (chaîne), la valeur
de paramètre doit être une chaîne de caractères. Si la chaîne contient
des espaces, la valeur doit figurer entre guillemets ou les espaces
doivent être précédés du caractère d'échappement (`).
Valeur par défaut
Cette valeur spécifie la valeur que le paramètre utilisera si
aucune autre n'est spécifiée. Par exemple, la valeur par défaut
du paramètre Path est souvent le répertoire actif. Les paramètres
obligatoires n'ont jamais de valeur par défaut. Pour de nombreux
paramètres optionnels, il n'y a aucune valeur par défaut car le
paramètre n'a aucun effet s'il n'est pas utilisé.
Accepte plusieurs valeurs ?
Cette valeur indique si un paramètre accepte plusieurs valeurs
de paramètre. Lorsqu'un paramètre accepte plusieurs valeurs,
vous pouvez taper une liste séparée par des virgules en tant
que valeur du paramètre de la commande ou enregistrer une
liste séparée par des virgules (tableau) dans une variable,
puis spécifier la variable en tant que valeur de paramètre.
Par exemple, le paramètre ServiceName de l'applet de commande
Get-Service accepte plusieurs valeurs. Les commandes suivantes
sont toutes les deux valides :
get-service -servicename winrm, netlogon
$s = "winrm", "netlogon"
get-service -servicename $s
Accepte l'entrée de pipeline ?
Cette valeur indique si vous pouvez utiliser l'opérateur
de pipeline (|) pour envoyer une valeur au paramètre.
Valeur Description
----- -----------
False Indique que vous ne pouvez pas rediriger de
valeur vers le paramètre.
True (by Value) Indique que vous pouvez rediriger toute valeur
vers le paramètre, simplement pour que la valeur
ait le type .NET Framework spécifié pour le
paramètre ou pour qu'elle puisse être convertie
dans le type .NET Framework spécifié.
Lorsqu'un paramètre est " True (by Value) ",
Windows PowerShell essaie de lui associer les
valeurs redirigées avant qu'il n'essaie d'autres
méthodes pour interpréter la commande.
True (by Property Name) Indique que vous pouvez rediriger une valeur
vers le paramètre, mais le type .NET Framework
du paramètre doit inclure une propriété avec
le même nom que le paramètre.
Par exemple, vous pouvez rediriger une
valeur vers un paramètre Name uniquement
lorsque la valeur comporte une propriété
appelée " Name ".
Accepte les caractères génériques ?
Cette valeur indique si la valeur du paramètre peut contenir des
caractères génériques pour qu'une concordance puisse être établie
avec plusieurs éléments du conteneur cible.
Paramètres courants
Les paramètres courants sont des paramètres que vous pouvez
utiliser avec toute applet de commande. Pour plus d'informations
sur les paramètres courants, tapez :
help about_commonparameters
VOIR AUSSI
about_Command_syntax
about_Comment_Based_Help
about_Functions_Advanced
about_Pipelines
about_Wildcards