Partager via

New-Variable

Module:
Microsoft.PowerShell.Utility Module

Crée une variable.

Syntaxe

Default (Par défaut) 

New-Variable
    [-Name] <String>
    [[-Value] <Object>]
    [-Description <String>]
    [-Option <ScopedItemOptions>]
    [-Visibility <SessionStateEntryVisibility>]
    [-Force]
    [-PassThru]
    [-Scope <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

L’applet New-Variable de commande crée une variable dans PowerShell. Vous pouvez affecter une valeur à la variable lors de sa création ou lui attribuer ou modifier la valeur après sa création.

Vous pouvez utiliser les paramètres de New-Variable définir les propriétés de la variable, définir l’étendue d’une variable et déterminer si les variables sont publiques ou privées.

En règle générale, vous créez une variable en tapant le nom de la variable et sa valeur, par $Var = 3exemple, mais vous pouvez utiliser l’applet New-Variable de commande pour utiliser ses paramètres.

Exemples

Exemple 1 : Créer une variable

New-Variable days

Cette commande crée une variable nommée days. Vous n’êtes pas obligé de taper le paramètre Name.

Exemple 2 : Créer une variable et l’affecter à une valeur

New-Variable -Name "zipcode" -Value 98033

Cette commande crée une variable nommée zipcode et lui affecte la valeur 98033.

Exemple 3 : Créer une variable avec l’option ReadOnly

PS C:\> New-Variable -Name Max -Value 256 -Option ReadOnly
PS C:\> New-Variable -Name max -Value 1024

New-Variable : A variable with name 'max' already exists.
At line:1 char:1
+ New-Variable -Name max -Value 1024
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ResourceExists: (max:String) [New-Variable], SessionStateException
    + FullyQualifiedErrorId : VariableAlreadyExists,Microsoft.PowerShell.Commands.NewVariableCommand

PS C:\> New-Variable -Name max -Value 1024 -Force

Cet exemple montre comment utiliser l’option ReadOnly de New-Variable protection d’une variable contre le remplacement d’une variable.

La première commande crée une variable nommée Max et définit sa valeur sur 256. Il utilise le paramètre Option avec la valeur .ReadOnly

La deuxième commande tente de créer une deuxième variable portant le même nom. Cette commande renvoie une erreur, car l’option en lecture seule est définie sur la variable.

La troisième commande utilise le paramètre Forcer pour remplacer la protection en lecture seule sur la variable. Dans ce cas, la commande permettant de créer une variable portant le même nom réussit.

Exemple 4 : Affecter plusieurs options à une variable

New-Variable -Name 'TestVariable' -Value 'Test Value' -Option AllScope,Constant

Cet exemple crée une variable et affecte les options Constant et les AllScope options afin que la variable soit disponible dans l’étendue actuelle et toutes les nouvelles étendues créées et ne peuvent pas être modifiées ou supprimées.

Exemple 5 : Créer une variable privée

Cette commande illustre le comportement d’une variable privée dans un module. Le module contient l’applet Get-Counter de commande, qui a une variable privée nommée Counter. La commande utilise le paramètre visibilité avec la valeur Private pour créer la variable.

PS C:\> New-Variable -Name counter -Visibility Private

#Effect of private variable in a module.

PS C:\> Get-Variable c*

Name                           Value
----                           -----
Culture                        en-US
ConsoleFileName
ConfirmPreference              High
CommandLineParameters          {}

PS C:\> $counter
"Cannot access the variable '$counter' because it is a private variable"
At line:1 char:1
+ $counter
+ ~~~~~~~~
    + CategoryInfo          : PermissionDenied: (counter:String) [], SessionStateException
    + FullyQualifiedErrorId : VariableIsPrivate

PS C:\> Get-Counter
Name         Value
----         -----
Counter1     3.1415
...

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.

Exemple 6 : Créer une variable avec un espace

Cet exemple montre que les variables avec des espaces peuvent être créées. Les variables sont accessibles à l’aide de l’applet Get-Variable de commande ou directement en limitant une variable avec accolades.

PS C:\> New-Variable -Name 'with space' -Value 'abc123xyz'

PS C:\> Get-Variable -Name 'with space'

Name                           Value
----                           -----
with space                     abc123xyz

PS C:\> ${with space}
abc123xyz

Paramètres

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:cf

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Description

Spécifie une description de la variable.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Force

Indique que l’applet de commande crée une variable portant le même nom qu’une variable en lecture seule existante.

Par défaut, vous pouvez remplacer une variable, sauf si la variable a une valeur d’option ou ReadOnlyConstant. Pour plus d’informations, consultez le paramètre option .

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Name

Spécifie un nom pour la nouvelle variable.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Option

Spécifie la valeur de la propriété Options de la variable. Les valeurs acceptables pour ce paramètre sont les suivantes :

  • None - Définit aucune option. None est la valeur par défaut.
  • ReadOnly - Peut être supprimé. Impossible de modifier, sauf en utilisant le paramètre force .
  • Private - La variable est disponible uniquement dans l’étendue actuelle.
  • AllScope - La variable est copiée dans toutes les nouvelles étendues créées.
  • Constant - Impossible de supprimer ou de modifier. Constant est valide uniquement lorsque vous créez une variable. Vous ne pouvez pas modifier les options d’une variable existante en Constant.

Ces valeurs sont définies comme une énumération basée sur des indicateurs. Vous pouvez combiner plusieurs valeurs pour définir plusieurs indicateurs à l’aide de ce paramètre. Les valeurs peuvent être transmises au paramètre Option en tant que tableau de valeurs ou sous forme de chaîne séparées par des virgules de ces valeurs. L’applet de commande combine les valeurs à l’aide d’une opération binary-OR. La transmission de valeurs en tant que tableau est l’option la plus simple et vous permet également d’utiliser la complétion par tabulation pour les valeurs.

Pour afficher la propriété Options de toutes les variables de la session, tapez Get-Variable | Format-Table -Property Name, Options -AutoSize.

Propriétés du paramètre

Type:ScopedItemOptions
Valeur par défaut:None
Valeurs acceptées:None, ReadOnly, Constant, Private, AllScope, Unspecified
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-PassThru

Retourne un objet représentant l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucune sortie.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Scope

Spécifie l’étendue de la nouvelle variable. Les valeurs acceptables pour ce paramètre sont les suivantes :

  • Global - Les variables créées dans l’étendue globale sont accessibles partout dans un processus PowerShell.
  • Local - L’étendue locale fait référence à l’étendue actuelle, il peut s’agir de n’importe quelle étendue en fonction du contexte. Local est l’étendue par défaut lorsque le paramètre d’étendue n’est pas spécifié.
  • Script - Les variables créées dans l’étendue du script sont accessibles uniquement dans le fichier de script ou le module dans lequel elles sont créées.
  • Nombre relatif à l’étendue actuelle (0 au nombre d’étendues, où 0 est l’étendue actuelle, 1 est son parent, 2 le parent de l’étendue parente, etc.). Les nombres négatifs ne peuvent pas être utilisés.

Remarque

Le paramètre accepte également la valeur de Private. Private n’est pas réellement une étendue, mais un paramètre facultatif pour une variable. Toutefois, l’utilisation de la Private valeur avec cette applet de commande ne modifie pas la visibilité de la variable. Pour plus d’informations, consultez about_Scopes.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Value

Spécifie la valeur initiale de la variable.

Propriétés du paramètre

Type:Object
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:1
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Visibility

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 être utilisé dans les scripts et les commandes qui seront remis à d’autres utilisateurs. Les valeurs acceptables pour ce paramètre sont les suivantes :

  • 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 des listes de variables, telles que celles retournées par Get-Variable, ou dans les affichages du Variable: lecteur. Les commandes permettant de lire ou de modifier la valeur d’une variable privée retournent une erreur. Toutefois, l’utilisateur peut exécuter des commandes qui utilisent une variable privée si les commandes ont été écrites dans la session dans laquelle la variable a été définie.

Propriétés du paramètre

Type:SessionStateEntryVisibility
Valeur par défaut:None
Valeurs acceptées:Public, Private
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:Wi

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

Object

Vous pouvez diriger n’importe quel objet vers New-Variable.

Sorties

None

Par défaut, cette applet de commande ne retourne aucune sortie.

PSVariable

Lorsque vous utilisez le paramètre PassThru , cette applet de commande retourne un objet PSVariable représentant la nouvelle variable.

Notes

Windows PowerShell inclut les alias suivants pour New-Variable:

  • nv