Read-Host
Считывает строку ввода из консоли.
Синтаксис
Read-Host
[[-Prompt] <Object>]
[-AsSecureString]
[<CommonParameters>]
Описание
Командлет Read-Host
считывает строку ввода из консоли. Его можно использовать для запроса ввода данных пользователем. Так как входные данные можно сохранить в виде защищенной строки, этот командлет можно использовать, чтобы запросить у пользователя защищенные данные, такие как пароли, а также общие данные.
Примеры
Пример 1. Сохранение входных данных консоли в переменной
В этом примере отображается строка "Пожалуйста, введите свой возраст:" в качестве запроса. При вводе значения и нажатии клавиши ВВОД значение сохраняется в переменной $Age
.
$Age = Read-Host "Please enter your age"
Пример 2. Сохранение входных данных консоли в виде защищенной строки
В этом примере отображается строка "Введите пароль:" в виде запроса. При вводе значения вместо входных данных на консоли появляются звездочки (*
). При нажатии клавиши ВВОД значение сохраняется в переменной в $pwd_secure_string
виде объекта SecureString.
$pwd_secure_string = Read-Host "Enter a Password" -AsSecureString
Параметры
-AsSecureString
Указывает, что командлет отображает звездочки (*
) вместо символов, введенных пользователем в качестве входных данных. При использовании этого параметра выходными данными командлета Read-Host
является объект SecureString (System.Security.SecureString).
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Prompt
Задает текст запроса.
Введите строку.
Если строка содержит пробелы, заключите ее в кавычки.
PowerShell добавляет двоеточие (:
) к вводу текста.
Type: | Object |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Входные данные
None
В этот командлет нельзя передать входные данные.
Выходные данные
System.String or System.Security.SecureString
Если используется параметр AsSecureString , Read-Host
возвращает secureString. В противном случае возвращается строка.