about_Parameters

Mis à jour: mai 2014

S'applique à: Windows PowerShell 2.0, Windows PowerShell 3.0, Windows PowerShell 4.0, Windows PowerShell 5.0

RUBRIQUE

about_Parameters

DESCRIPTION COURTE

Décrit comment utiliser les paramètres de commande dans Windows PowerShell.

DESCRIPTION DÉTAILLÉE

La plupart des commandes Windows PowerShell, telles que les applets de commande, les fonctions et les scripts, s’appuient 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 commande et se présentent sous la forme suivante :

        -<parameter_name> <parameter_value>

Le nom du paramètre est précédé d’un trait d’union (-), qui signale à Windows PowerShell que le mot qui suit le trait d’union est un nom de paramètre. Certains paramètres ne requièrent ni n’acceptent de valeur de paramètre. D’autres paramètres requièrent une valeur, mais ne nécessitent pas le nom du paramètre dans la commande.

Le type des paramètres et la configuration requise pour ces paramètres varient. Pour rechercher des informations sur les paramètres d’une 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’un script, utilisez le chemin d’accès complet au fichier de script. Exemple :

        Get-Help $home\Documents\Scripts\Get-Function.ps1

L’applet de commande Get-Help retourne divers détails sur la commande, notamment une description, la syntaxe de commande, des informations sur les paramètres et des exemples montrant comment utiliser les paramètres dans une commande.

Vous pouvez également utiliser le paramètre Parameter de l’applet de commande Get-Help pour rechercher des informations sur un paramètre particulier. Vous pouvez aussi utiliser le paramètre Parameter avec la valeur de caractère générique (*) pour trouver des informations sur tous les paramètres de la commande. Par exemple, la commande suivante obtient des informations sur tous les paramètres de l’applet de commande Get-Member :

        Get-Help Get-Member -Parameter *

VALEURS DE PARAMÈTRE PAR DÉFAUT

Les paramètres facultatifs ont une valeur par défaut, qui est la valeur utilisée ou supposée quand le paramètre n’est pas spécifié dans la commande.

Par exemple, la valeur par défaut du paramètre ComputerName de nombreuses applets de commande est le nom de l’ordinateur local. Par conséquent, le nom de l’ordinateur local est utilisé dans la commande, sauf si le paramètre ComputerName est spécifié.

Pour rechercher la valeur de paramètre par défaut, consultez la rubrique d’aide de l’applet de commande. La description du paramètre doit inclure la valeur par défaut.

Vous pouvez également définir une valeur par défaut personnalisée pour n’importe quel paramètre d’une applet de commande ou fonction avancée. Pour plus d’informations sur la définition des valeurs par défaut personnalisées, consultez about_Parameters_Default_Values.

TABLE DES ATTRIBUTS DE PARAMÈTRE

Quand vous utilisez les paramètres Full, Parameter ou Online de l’applet de commande Get-Help, Get-Help affiche une table des attributs de paramètre avec des informations détaillées sur le paramètre.

Ces informations incluent les détails que vous devez connaître pour utiliser le paramètre. Par exemple, la rubrique d’aide pour l’applet de commande Get-ChildItem inclut les détails suivants sur son paramètre Path :

        -path <string[]>
            Specifies a path of one or more locations. Wildcard characters are
            permitted. The default location is the current directory (.).

        Required?                    false
        Position?                    1
        Default value                Current directory
        Accept pipeline input?       true (ByValue, ByPropertyName)
        Accept wildcard characters?  true

Les informations de paramètre incluent la syntaxe, une description et les attributs de paramètre. Les sections suivantes décrivent les attributs de paramètre.

PARAMÈTRE REQUIS ?

Ce paramètre indique si le paramètre est obligatoire, autrement dit si toutes les commandes qui utilisent cette applet de commande doivent inclure ce paramètre. Quand la valeur est True et que le paramètre est manquant dans la commande, Windows PowerShell vous demande une valeur pour le paramètre.

POSITION DU PARAMÈTRE ?

Ce paramètre indique si vous pouvez fournir la valeur d’un paramètre sans la faire précéder du nom du paramètre. Si la valeur est « 0 » ou « nommé », un nom de paramètre est requis. Ce type de paramètre est désigné sous le nom de paramètre nommé. Un paramètre nommé peut être répertorié dans n’importe quelle position après le nom de l’applet de commande.

Si le paramètre de position du paramètre a pour valeur un entier différent de 0, le nom du paramètre n’est pas requis. Ce type de paramètre est désigné sous le nom de paramètre positionnel et le nombre indique la position dans laquelle le paramètre doit apparaître par rapport aux autres paramètres positionnels. Si vous incluez le nom de paramètre pour un paramètre positionnel, le paramètre peut être répertorié dans n’importe quelle position après le nom de l’applet de commande.

Par exemple, l’applet de commande Get-ChildItem possède les paramètres Path et Exclude. Le paramètre de position du paramètre pour Path a la valeur 1, ce qui signifie qu’il s’agit d’un paramètre positionnel. Le paramètre de position du paramètre pour Exclude a la valeur 0, ce qui signifie qu’il s’agit d’un paramètre nommé.

Cela signifie que Path ne nécessite pas le nom du paramètre, mais sa valeur de paramètre doit être la première ou la seule valeur de paramètre sans nom dans la commande. Toutefois, étant donné que le paramètre Exclude est un paramètre nommé, vous pouvez le placer dans n’importe quelle position dans la commande.

En raison des paramètres de position du paramètre pour ces deux paramètres, vous pouvez utiliser les commandes suivantes :

        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 inclure le nom du paramètre, ce paramètre devrait être placé dans l’ordre spécifié par le paramètre de position du paramètre.

TYPE DE PARAMÈTRE

Ce paramètre spécifie le type Microsoft .NET Framework de la valeur du paramètre. Par exemple, si le type est Int32, la valeur du paramètre doit être un entier. Si le type est string, la valeur du paramètre doit être une chaîne de caractères. Si la chaîne contient des espaces, la valeur doit être placée entre guillemets ou les espaces doivent être précédés du caractère d’échappement (`).

VALEUR PAR DÉFAUT

Ce paramètre spécifie la valeur attribuée au paramètre si aucune autre valeur n’est fournie. Par exemple, la valeur par défaut du paramètre Path est souvent le répertoire actif. Les paramètres requis n’ont jamais de valeur par défaut. Pour de nombreux paramètres facultatifs, il n’existe pas de valeur par défaut, car le paramètre n’a aucun effet s’il n’est pas utilisé.

ACCEPTER PLUSIEURS VALEURS ?

Ce paramètre indique si un paramètre accepte plusieurs valeurs de paramètre. Quand un paramètre accepte plusieurs valeurs, vous pouvez taper une liste séparée par des virgules comme valeur du paramètre dans la commande, ou enregistrer une liste séparée par des virgules (un tableau) dans une variable, puis spécifier la variable comme valeur de paramètre.

Par exemple, le paramètre ServiceName de l’applet de commande Get-Service accepte plusieurs valeurs. Les deux commandes suivantes sont valides :

        get-service -servicename winrm, netlogon


        $s = "winrm", "netlogon"
        get-service -servicename $s

ACCEPTER L’ENTRÉE DE PIPELINE ?

Ce paramètre indique si vous pouvez utiliser l’opérateur pipeline (|) pour envoyer une valeur au paramètre.

    
    Value                    Description
    -----                    -----------
    False                    Indicates that you cannot pipe a value to the 
                             parameter.


    True (by Value)          Indicates that you can pipe any value to the 
                             parameter, just so the value has the .NET 
                             Framework type specified for the parameter or the
                             value can be converted to the specified .NET 
                             Framework type.


                             When a parameter is "True (by Value)", Windows 
                             PowerShell tries to associate any piped values 
                             with that parameter before it tries other methods
                             to interpret the command.


    True (by Property Name)  Indicates that you can pipe a value to the 
                             parameter, but the .NET Framework type of the 
                             parameter must include a property with the same
                             name as the parameter.
 
                             For example, you can pipe a value to a Name 
                             parameter only when the value has a property 
                             called "Name".

ACCEPTER LES CARACTÈRES GÉNÉRIQUES ?

Ce paramètre indique si la valeur du paramètre peut contenir des caractères génériques pour pouvoir la mettre en correspondance avec plusieurs éléments existants dans le conteneur cible.

PARAMÈTRES COMMUNS

Les paramètres communs sont des paramètres que vous pouvez utiliser avec toute applet de commande. Pour plus d’informations sur les paramètres communs, consultez about_CommonParameters.

VOIR AUSSI

about_Command_syntax

about_Comment_Based_Help

about_Functions_Advanced

about_Parameters_Default_Values

about_Pipelines

about_Wildcards