Partager via

Remove-Variable

  • Référence
Module:
Microsoft.PowerShell.Utility

Supprime une variable et sa valeur.

Syntaxe

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

Description

L’applet Remove-Variable de commande 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 qui sont définies en tant que constantes ou celles qui sont détenues par le système.

Exemples

Exemple 1 : Supprimer une variable

Remove-Variable Smp

Cette commande supprime la $Smp variable.

Paramètres

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Exclude

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

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:True

-Force

Indique que l’applet de commande supprime une variable même si elle est en lecture seule. Même en utilisant le paramètre Force, l’applet de commande ne peut pas supprimer une constante.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:True

-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

Type:String[]
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:True

-Scope

Obtient seulement les variables de l'étendue spécifiée. Les valeurs valides pour ce paramètre sont :

  • Global
  • Local
  • Script
  • 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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

PSVariable

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

Sorties

None

Cette applet de commande ne retourne pas de sortie.

Notes

PowerShell inclut les alias suivants pour Remove-Variable:

  • Toutes les plateformes :

    • rv

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