Read-Host
コンソールから入力行を読み取ります。
構文
Read-Host
[[-Prompt] <Object>]
[-AsSecureString]
[<CommonParameters>]説明
Read-Host コマンドレットは、コンソールから入力行を読み取ります。 これを使用して、ユーザーに入力を求めることができます。 入力をセキュリティで保護された文字列として保存できるため、このコマンドレットを使用して、パスワードや共有データなどのセキュリティで保護されたデータをユーザーに求めることができます。
例
例 1: コンソール入力を変数に保存する
PS C:\> $Age = Read-Host "Please enter your age"このコマンドは、"Please enter your age:" という文字列をプロンプトとして表示します。 値が入力されて Enter キーが押されると、値は $Age 変数に格納されます。
例 2: コンソール入力をセキュリティで保護された文字列として保存する
PS C:\> $pwd_secure_string = Read-Host "Enter a Password" -AsSecureStringこのコマンドは、"Enter a Password:" という文字列をプロンプトとして表示します。 値を入力すると、入力の代わりにアスタリスク (*) がコンソールに表示されます。 Enter キーが押されると、値は SecureString オブジェクトとして $pwd_secure_string 変数に格納されます。
パラメーター
-AsSecureString
コマンドレットが、ユーザーが入力として入力する文字の代わりにアスタリスク (*) を表示することを示します。
このパラメーターを使用すると、 Read-Host コマンドレットの出力は SecureString オブジェクト (System.Security.SecureString) になります。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Prompt
プロンプトのテキストを指定します。 文字列を入力します。 文字列にスペースが含まれている場合は、引用符で囲みます。 Windows PowerShell では、入力したテキストにコロン (:)が追加されます。
| 型: | Object |
| 配置: | 0 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
None
このコマンドレットに入力をパイプすることはできません。
出力
System.String or System.Security.SecureString
AsSecureString パラメータを使用すると、Read-Host は SecureString を返します。 それ以外の場合は、文字列を返します。