Crée une variable.
Syntaxe
New-Variable [-Name] <string> [[-Value] <Object>] [-Description <string>] [-Force] [-Option {<None> | <ReadOnly> | <Constant> | <Private> | <AllScope>}] [-PassThru] [-Scope <string>] [-Visibility {<Public> | <Private>}] [-Confirm] [-WhatIf] [<CommonParameters>]
Description
L'applet de commande New-Variable crée une variable dans Windows PowerShell. Vous pouvez attribuer une valeur à la variable lors de sa création, ou attribuer ou modifier la valeur après la création.
Vous pouvez utiliser les paramètres de New-Variable pour définir les propriétés de la variable, (telles que celles qui créent des variables en lecture seule ou constantes), définir la portée d'une variable et déterminer si les variables sont publiques ou privées.
En général, vous créez une variable en tapant son nom et sa valeur, par exemple « $var = 3 », mais vous pouvez utiliser l'applet de commande New-Variable pour utiliser ses paramètres.
Paramètres
-Description <string>
Spécifie une description de la variable.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Force
Vous permet de créer une variable portant le même nom qu'une variable en lecture seule existante.
Par défaut, vous pouvez remplacer une variable, sauf si celle-ci a la valeur d'option ReadOnly ou Constant. Pour plus d'informations, consultez le paramètre Option.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Name <string>
Spécifie un nom pour la nouvelle variable.
|
Obligatoire ? |
true |
|
Position ? |
1 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-Option <ScopedItemOptions>
Définit la valeur de la propriété Options de la nouvelle variable.
Les valeurs valides sont :
-- None : ne définit pas d'options. (« None » est la valeur par défaut.)
-- ReadOnly : la valeur de la variable ne peut pas être modifiée, sauf en utilisant le paramètre Force. Vous pouvez utiliser Remove-Variable pour supprimer la variable.
-- Constant : la variable ne peut pas être supprimée et ses propriétés ne peuvent pas être modifiées. La valeur « Constant » est disponible uniquement lorsque vous créez un alias. Vous ne pouvez pas attribuer la valeur « Constant » à l'option d'une variable existante.
-- Private : la variable est uniquement disponible dans la portée spécifiée par le paramètre Scope. Elle est héritée par les portées enfants. (Cette valeur n'est pas liée à la valeur « Private » du paramètre Visibility.)
-- AllScope : la variable est copiée vers toutes les nouvelles portées qui sont créées.
Pour consulter la propriété Options des variables, tapez « get-variable | Format-Table -property Name, Options -autosize ».
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-PassThru
Retourne un objet représentant la nouvelle variable. Par défaut, cette applet de commande ne génère aucune sortie.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Scope <string>
Détermine la portée de la nouvelle variable. Les valeurs valides sont « Global », « Local » ou « Script », ou un nombre relatif à la portée actuelle (0 jusqu'au nombre de portées, où 0 est la portée actuelle et 1 son parent). « Local » est la valeur par défaut. Pour plus d'informations, consultez about_Scopes.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Value <Object>
Spécifie la valeur initiale de la variable.
|
Obligatoire ? |
false |
|
Position ? |
2 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByValue, ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-Visibility <SessionStateEntryVisibility>
Détermine si la variable est visible en dehors de la session dans laquelle elle a été créée. Ce paramètre est conçu pour une utilisation dans les scripts et commandes qui sont remis à d'autres utilisateurs.
Les valeurs valides sont :
-- Public : la variable est visible. (« Public » est la valeur par défaut.)
-- Private : la variable n'est pas visible.
Lorsqu'une variable est privée, elle n'apparaît pas dans les listes de variables, telles que celles retournées par Get-Variable, ni dans les affichages du lecteur Variable:. Les commandes visant à lire ou modifier la valeur d'une variable privée retournent une erreur. Néanmoins, l'utilisateur peut exécuter des commandes qui utilisent une variable privée si ces commandes ont été écrites dans la session dans laquelle la variable a été définie.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
Public |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Confirm
Vous invite à confirmer l'exécution de la commande.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-WhatIf
Décrit le résultat que vous obtiendriez en exécutant la commande, sans réellement l'exécuter.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
|
Entrées |
System.Object Vous pouvez diriger une valeur vers New-Variable. |
|
Sorties |
Aucun ou System.Management.Automation.PSVariable Lorsque vous utilisez le paramètre PassThru, New-Variable génère un objet System.Management.Automation.PSVariable qui représente la nouvelle variable. Sinon, cette applet de commande ne génère aucune sortie. |
Exemple 1
C:\PS>new-variable days Description ----------- Cette commande crée une nouvelle variable nommée « days ». Elle n'a aucune valeur suivant immédiatement la commande.
Exemple 2
C:\PS>new-variable zipcode -value 98033 Description ----------- Cette commande crée une variable nommée « zipcode » et lui assigne la valeur « 98033 ».
Exemple 3
C:\PS>new-variable -name max -value 256 -option readonly new-variable -name max -value 1024 new-variable -name max -value 1024 -force C:\PS> new-variable -name max -value 256 -option readonly C:\PS> new-variable -name max -value 1024 New-Variable : A variable with name 'max' already exists. At line:1 char:13 + new-variable <<<< -name max -value 1024 C:\PS> new-variable -name max -value 1024 -force Description ----------- Cet exemple montre comment utiliser l'option ReadOnly de New-Variable pour protéger une variable contre tout écrasement. La première commande crée un nouvelle variable nommée Max et lui attribue la valeur « 256 ». Elle utilise le paramètre Option avec la valeur ReadOnly. La deuxième commande essaie de créer une deuxième variable avec le même nom. Cette commande retourne une erreur, car l'option de lecture seule est définie sur la variable. La troisième commande utilise le paramètre Force pour écraser la protection de lecture seule de la variable. Dans ce cas, la commande permettant de créer une variable portant le même nom réussit.
Exemple 4
C:\PS>new-variable -name counter -visibility private
#Effect of private variable in a module.
C:\PS> get-variable c*
Name Value
---- -----
Culture en-US
ConsoleFileName
ConfirmPreference High
CommandLineParameters {}
C:\PS> $counter
"Cannot access the variable '$counter' because it is a private variable"
C:\PS> Get-Counter
Name Value
---- -----
Counter1 3.1415
...
Description
-----------
Cette commande illustre le comportement d'une variable privée dans un module. Le module contient l'applet de commande Get-Counter qui comporte une variable privée nommée « Counter ». La commande utilise le paramètre Visibility avec la valeur « Private » pour créer la variable.
L'exemple de sortie montre le comportement d'une variable privée. L'utilisateur qui a chargé le module ne peut pas afficher ou modifier la valeur de la variable Counter, mais la variable Counter peut être lue et modifiée par les commandes du module.
Voir aussi