Set-Variable

Syntaxe

Default (Par défaut)

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

Description

Exemples

Exemple 1 : Définir une variable et obtenir sa valeur

PS C:\> Set-Variable -Name "desc" -Value "A description"
PS C:\> Get-Variable -Name "desc"

Exemple 2 : Définir une variable globale en lecture seule

PS C:\> Set-Variable -Name "processes" -Value (Get-Process) -Option constant -Scope global -Description "All processes" -PassThru | Format-List -Property *

Exemple 3 : Comprendre les variables publiques et privées

PS C:\> New-Variable -Name "counter" -Visibility Public -Value 26
PS C:\> $Counter
26
PS C:\> Get-Variable c*

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

PS C:\> Set-Variable -Name "counter" -Visibility Private
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"

PS C:\> .\use-counter.ps1
#Commands completed successfully.

Paramètres

-Confirm

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

Propriétés du paramètre

Jeux de paramètres

-Description

Spécifie la description de la variable.

Propriétés du paramètre

Jeux de paramètres

-Exclude

Spécifie un tableau d’éléments que cette applet de commande exclut de l’opération. La valeur de ce paramètre qualifie le paramètre Path. Entrez un élément de chemin ou un modèle, tel que *.txt. Les caractères génériques sont autorisés.

Propriétés du paramètre

Jeux de paramètres

-Force

Vous permet de créer une variable portant le même nom qu’une variable en lecture seule existante ou de modifier la valeur d’une variable en lecture seule.

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

Propriétés du paramètre

Jeux de paramètres

-Include

Spécifie un tableau d’éléments inclus dans cette applet de commande dans l’opération. La valeur de ce paramètre qualifie le paramètre Name. Entrez un nom ou un modèle de nom, tel que c*. Les caractères génériques sont autorisés.

Propriétés du paramètre

Jeux de paramètres

-Name

Spécifie le nom de la variable.

Propriétés du paramètre

Jeux de paramètres

-Option

Spécifie la valeur de la propriété Options de la variable.

Les valeurs valides sont les suivantes :

• Aucun : définit aucune option. (« Aucun » est la valeur par défaut.)
• ReadOnly : peut être supprimé. Impossible de modifier, sauf en utilisant le paramètre Force.
• Constante : Impossible de supprimer ou de modifier. « Constante » est valide uniquement lorsque vous créez une variable. Vous ne pouvez pas modifier les options d’une variable existante en « Constante ».
• Privé : la variable est disponible uniquement dans l’étendue actuelle.
• AllScope : la variable est copiée dans toutes les nouvelles étendues créées.

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

Jeux de paramètres

-PassThru

Retourne un objet représentant la nouvelle variable. Par défaut, cette applet de commande ne génère aucune sortie.

Propriétés du paramètre

Jeux de paramètres

-Scope

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

• Mondial
• Local
• Scénario
• Privé
• Nombre relatif à l’étendue actuelle (0 au nombre d’étendues, où 0 est l’étendue actuelle et 1 est son parent).

Local est la valeur par défaut.

Pour plus d’informations, consultez about_Scopes.

Propriétés du paramètre

Jeux de paramètres

-Value

Spécifie la valeur de la variable.

Propriétés du paramètre

Jeux de paramètres

-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 valides sont les suivantes :

• Public : la variable est visible. (« Public » est la valeur par défaut.)
• Privé : 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, ou dans les affichages de la 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

Jeux de paramètres

-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

Jeux de paramètres

CommonParameters

Entrées

Object

Sorties

None or System.Management.Automation.PSVariable

Liens associés

• Clear-Variable
• Get-Variable
• New-Variable
• Remove-Variable