Partager via

Remove-Variable

Module:
Microsoft.PowerShell.Utility Module

Supprime une variable et sa valeur.

Syntaxe

Default (Par défaut) 

Remove-Variable
    [-Name] <String[]>
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-Force]
    [-Scope <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

L’applet de commande Remove-Variable supprime une variable et sa valeur de l’étendue dans laquelle elle est définie, telle que la session active. Vous ne pouvez pas utiliser cette applet de commande pour supprimer des variables définies en tant que constantes ou celles appartenant au système.

Exemples

Exemple 1 : Supprimer une variable

Remove-Variable Smp

Cette commande supprime la variable $Smp.

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

-Exclude

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

Propriétés du paramètre

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:True
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 supprime une variable même si elle est en lecture seule. Même à l’aide du paramètre Forcer, l’applet de commande ne peut pas supprimer une constante.

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

-Include

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

Propriétés du paramètre

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:True
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 le nom de la variable à supprimer. Le nom du paramètre (Name) est facultatif. Les caractères génériques sont autorisés

Propriétés du paramètre

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:True
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

-Scope

Obtient uniquement les variables de l’étendue spécifiée. Les valeurs acceptables pour ce paramètre sont les suivantes :

  • Mondial
  • Local
  • Scénario
  • Nombre relatif à l’étendue actuelle (de 0 jusqu'au nombre total 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

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

-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

PSVariable

Vous pouvez diriger un objet variable vers cette applet de commande.

Sorties

None

Cette applet de commande ne retourne aucune sortie.

Notes

Windows PowerShell inclut les alias suivants pour Remove-Variable:

  • rv

  • Les modifications affectent uniquement l’étendue actuelle, telle qu’une session. Pour supprimer une variable de toutes les sessions, ajoutez une commande Remove-Variable à votre profil PowerShell.