Udostępnij za pośrednictwem

Read-Host

  • Odwołanie
Moduł:
Microsoft.PowerShell.Utility

Odczytuje wiersz danych wejściowych z konsoli programu .

Składnia

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

Opis

Polecenie cmdlet read-host odczytuje wiersz danych wejściowych z konsoli programu . Można go użyć, aby wyświetlić monit o podanie danych wejściowych przez użytkownika. Ponieważ dane wejściowe można zapisać jako bezpieczny ciąg, możesz użyć tego polecenia cmdlet, aby monitować użytkowników o bezpieczne dane, takie jak hasła, a także dane udostępnione.

Przykłady

Przykład 1. Zapisywanie danych wejściowych konsoli w zmiennej

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

To polecenie wyświetla ciąg "Proszę wprowadzić wiek:" w wierszu polecenia. Po wprowadzeniu wartości i naciśnięciu Enter wartość jest przechowywana w zmiennej $Age.

Przykład 2. Zapisywanie danych wejściowych konsoli jako bezpiecznego ciągu

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

To polecenie wyświetla ciąg "Wprowadź hasło:" w wierszu polecenia. W miarę wprowadzania wartości gwiazdki (*) są wyświetlane w konsoli zamiast danych wejściowych. Po naciśnięciu Enter wartość jest przechowywana jako obiekt SecureString w zmiennej $pwd_secure_string.

Parametry

-AsSecureString

Wskazuje, że polecenie cmdlet wyświetla gwiazdki (*) zamiast znaków, które użytkownik wpisze jako dane wejściowe.

W przypadku użycia tego parametru dane wyjściowe polecenia cmdlet Read-Host to obiekt SecureString (System.Security.SecureString).

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Prompt

Określa tekst monitu. Wpisz ciąg. Jeśli ciąg zawiera spacje, należy go ująć w cudzysłów. Program Windows PowerShell dołącza dwukropek (:) do wprowadzonego tekstu.

Typ:Object
Position:0
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

None

Nie można przekazać danych wejściowych potoku do tego polecenia cmdlet.

Dane wyjściowe

System.String or System.Security.SecureString

Jeśli jest używany parametr AsSecureString, read-host zwraca SecureString. W przeciwnym razie zwraca ciąg.