Read-Host

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

Lit une ligne d'entrée de la console.

Syntax

Read-Host
    [[-Prompt] <Object>]
    [-AsSecureString]
    [<CommonParameters>]

Description

L’applet Read-Host de commande lit une ligne d’entrée à partir de la console. Vous pouvez l'utiliser pour inviter un utilisateur à saisir une entrée. Comme vous pouvez enregistrer l'entrée sous la forme d'une chaîne sécurisée, vous pouvez utiliser cette applet de commande pour inviter les utilisateurs à entrer des données de sécurité, telles que des mots de passe, ainsi que des données partagées.

Exemples

Exemple 1 : Enregistrer l’entrée de console dans une variable

Cet exemple montre comment afficher la chaîne « Entrez votre âge : » comme invite. Lorsqu’une valeur est entrée et que la touche Entrée est enfoncée, la valeur est stockée dans la $Age variable.

$Age = Read-Host "Please enter your age"

Exemple 2 : Enregistrer l’entrée de console en tant que chaîne sécurisée

Cet exemple montre comment afficher la chaîne « Entrer un mot de passe : » comme invite. Comme une valeur est entrée, les astérisque (*) apparaissent sur la console à la place de l’entrée. Lorsque la touche Entrée est enfoncée, la valeur est stockée en tant qu’objet SecureString dans la $pwd_secure_string variable.

$pwd_secure_string = Read-Host "Enter a Password" -AsSecureString

Paramètres

-AsSecureString

Indique que l’applet de commande affiche des astérisque (*) à la place des caractères que l’utilisateur type comme entrée. Lorsque vous utilisez ce paramètre, la sortie de l’applet Read-Host de commande est un objet SecureString (System.Security.SecureString).

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Prompt

Spécifie le texte de l'invite. Tapez une chaîne. Si la chaîne inclut des espaces, mettez-la entre guillemets. PowerShell ajoute un signe deux-points (:) au texte que vous entrez.

Type:Object
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

None

Vous ne pouvez pas diriger d'entrée vers cette applet de commande.

Sorties

System.String or System.Security.SecureString

Si le paramètre AsSecureString est utilisé, Read-Host retourne un SecureString. Sinon, une chaîne est retournée.