Partager via

Read-Host

Module:
Microsoft.PowerShell.Utility Module

Lit une ligne d’entrée à partir de la console.

Syntaxe

Default (Par défaut) 

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

Description

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

Exemples

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

PS C:\> $Age = Read-Host "Please enter your age"

Cette commande affiche 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 variable $Age.

Exemple 2 : Enregistrer l’entrée de console sous forme de chaîne sécurisée

PS C:\> $pwd_secure_string = Read-Host "Enter a Password" -AsSecureString

Cette commande affiche la chaîne « Entrer un mot de passe : » en tant qu’invite. Comme une valeur est entrée, les astérisques (*) 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 variable $pwd_secure_string.

Paramètres

-AsSecureString

Indique que l’applet de commande affiche des astérisques (*) à la place des caractères que l’utilisateur tape comme entrée.

Lorsque vous utilisez ce paramètre, la sortie de l’applet de commande read-Host est un objet SecureString (System.Security.SecureString).

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

-Prompt

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

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:0
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

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é, en lecture-hôte renvoie un SecureString. Sinon, elle retourne une chaîne.