Read-Host
Lê uma linha de entrada do console.
Sintaxe
Default (Predefinição)
Read-Host
[[-Prompt] <Object>]
[-AsSecureString]
[<CommonParameters>]
Description
O cmdlet Read-Host lê uma linha de entrada do console. Você pode usá-lo para solicitar a entrada de um usuário. Como você pode salvar a entrada como uma cadeia de caracteres segura, pode usar esse cmdlet para solicitar aos usuários dados seguros, como senhas, bem como dados compartilhados.
Exemplos
Exemplo 1: Salvar a entrada do console em uma variável
PS C:\> $Age = Read-Host "Please enter your age"
Este comando exibe a string "Por favor, insira sua idade:" como um prompt. Quando um valor é inserido e a tecla Enter é pressionada, o valor é armazenado na variável $Age.
Exemplo 2: Salvar a entrada do console como uma cadeia de caracteres segura
PS C:\> $pwd_secure_string = Read-Host "Enter a Password" -AsSecureString
Este comando exibe a string "Enter a Password:" como um prompt. À medida que um valor é inserido, asteriscos (*) aparecem no console no lugar da entrada. Quando a tecla Enter é pressionada, o valor é armazenado como um objeto SecureString na variável $pwd_secure_string.
Parâmetros
-AsSecureString
Indica que o cmdlet exibe asteriscos (*) no lugar dos caracteres que o usuário digita como entrada.
Quando você usa esse parâmetro, a saída do cmdlet Read-Host é um objeto SecureString (System.Security.SecureString).
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Prompt
Especifica o texto do prompt. Digite uma cadeia de caracteres. Se a cadeia de caracteres incluir espaços, coloque-a entre aspas. O Windows PowerShell acrescenta dois pontos (:) ao texto inserido.
Propriedades dos parâmetros
| Tipo: | Object |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | 0 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
None
Não é possível canalizar a entrada para este cmdlet.
Saídas
System.String or System.Security.SecureString
Se o parâmetro AsSecureString for usado, Read-Host retornará um SecureString. Caso contrário, ele retorna uma cadeia de caracteres.