Compartilhar via

Read-Host

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Lê uma linha de entrada do console.

Sintaxe

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

Description

O cmdlet de host de leitura lê uma linha de entrada do console. Você pode usá-lo para solicitar entrada a um usuário. Como você pode salvar a entrada como uma cadeia de caracteres segura, você 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 cadeia de caracteres "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

Esse comando exibe a cadeia de caracteres "Inserir uma Senha:" como um prompt. Como um valor está sendo inserido, os 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 de Host de Leitura é um objeto SecureString (System.Security.SecureString).

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga: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.

Tipo:Object
Cargo:0
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

None

Não é possível redirecionar a entrada para este cmdlet.

Saídas

System.String or System.Security.SecureString

Se o parâmetro AsSecureString for usado, de Host de Leitura retornará um SecureString. Caso contrário, ele retornará uma cadeia de caracteres.