Get-Credential
ユーザー名とパスワードに基づいて資格情報オブジェクトを取得します。
構文
Get-Credential
[-Credential] <PSCredential>
[<CommonParameters>]
Get-Credential
-Message <String>
[[-UserName] <String>]
[<CommonParameters>]
説明
Get-Credential
コマンドレットは、指定したユーザー名とパスワードの資格情報オブジェクトを作成します。 セキュリティ操作で資格情報オブジェクトを使用できます。
PowerShell 3.0 以降では、Message パラメーターを使用して、ユーザーに名前とパスワードの入力を求めるカスタマイズされたメッセージをダイアログ ボックスで指定できます。
Get-Credential
コマンドレットは、ユーザーにパスワードまたはユーザー名とパスワードの入力を求めます。 既定では、ユーザーに確認を求める認証ダイアログ ボックスが表示されます。 ただし、PowerShell コンソールなどの一部のホスト プログラムでは、レジストリ エントリを変更することで、コマンド ラインでユーザーにプロンプトを表示できます。 このレジストリ エントリの詳細については、メモと例を参照してください。
例
例 1
$c = Get-Credential
このコマンドは資格情報オブジェクトを取得し、$c
変数に保存します。
コマンドを入力すると、ユーザー名とパスワードを要求するダイアログ ボックスが表示されます。 要求された情報を入力すると、ユーザーの資格情報を表す PSCredential オブジェクトが作成され、$c
変数に保存されます。
このオブジェクトは、Credential パラメーターを持つコマンドレットなど、ユーザー認証を要求するコマンドレットへの入力として使用できます。 ただし、PowerShell でインストールされているプロバイダーの中には、Credential パラメーターがサポートされていないものもあります。
例 2
$c = Get-Credential -Credential User01
$c.Username
User01
この例では、ドメイン名のないユーザー名を含む資格情報を作成します。
最初のコマンドは、User01 というユーザー名の資格情報を取得し、$c
変数に格納します。
2 番目のコマンドは、結果の資格情報オブジェクトの Username プロパティの値を表示します。
例 3
$Credential = $Host.UI.PromptForCredential("Need credentials", "Please enter your user name and password.", "", "NetBiosUserName")
このコマンドは、PromptForCredential メソッドを使用して、ユーザーにユーザー名とパスワードの入力を求めます。 このコマンドは、結果の資格情報を $Credential
変数に保存します。
PromptForCredential メソッドは、Get-Credential
コマンドレットを使用する代わりに使用できます。 PromptForCredential 使用する場合は、メッセージ ボックスに表示されるキャプション、メッセージ、およびユーザー名を指定できます。
詳細については、SDK の PromptForCredential ドキュメントを参照してください。
例 4
Set-ItemProperty "HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds" -Name ConsolePrompting -Value $true
この例では、ダイアログ ボックスを使用するのではなく、コマンド ラインでユーザーにプロンプトが表示されるようにレジストリを変更する方法を示します。
このコマンドは、ConsolePrompting レジストリ エントリを作成し、その値を True に設定します。 このコマンドを実行するには、[管理者として実行] オプションを使用して PowerShell を起動します。
ダイアログ ボックスを使用してプロンプトを表示するには、ConsolePrompting の値を false ($false) に設定するか、Remove-ItemProperty
コマンドレットを使用して削除します。
ConsolePrompting レジストリ エントリは、PowerShell コンソールなどの一部のホスト プログラムで動作します。 一部のホスト プログラムでは機能しない場合があります。
例 5
この例では、Get-Credential
によって返される資格情報オブジェクトと同じ資格情報オブジェクトを作成する方法を示します。
$User = "Domain01\User01"
$PWord = Read-Host -Prompt 'Enter a Password' -AsSecureString
$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $PWord
最初のコマンドは、$User
変数にユーザー名を割り当てます。 値が "Domain\User" または "ComputerName\User" の形式に従っていることを確認します。
2 番目のコマンドでは、Read-Host
コマンドレットを使用して、ユーザー入力からセキュリティで保護された文字列を作成します。
Prompt パラメーターはユーザー入力を要求し、AsSecureString パラメーターは入力をマスクし、セキュリティで保護された文字列に変換します。
3 番目のコマンドでは、New-Object
コマンドレットを使用して、 変数と $User
変数に格納されている値から、$PWord
オブジェクトを作成します。
例 6
Get-Credential -Message "Credential are required for access to the \\Server1\Scripts file share." -User Server01\PowerUser
PowerShell Credential Request
Credential are required for access to the \\Server1\Scripts file share.
Password for user Server01\PowerUser:
このコマンドでは、 コマンドレットの Message パラメーターと userName Get-Credential
します。 このコマンド形式は、共有スクリプトと関数用に設計されています。 この場合、メッセージは資格情報が必要な理由をユーザーに伝え、要求が正当であることを信頼できるようにします。
例 7
Invoke-Command -ComputerName Server01 {Get-Credential Domain01\User02}
PowerShell Credential Request : PowerShell Credential Request
Warning: This credential is being requested by a script or application on the SERVER01 remote computer. Enter your credentials only if you
trust the remote computer and the application or script requesting it.
Enter your credentials.
Password for user Domain01\User02: ***************
PSComputerName : Server01
RunspaceId : 422bdf52-9886-4ada-ab2f-130497c6777f
PSShowComputerName : True
UserName : Domain01\User01
Password : System.Security.SecureString
このコマンドは、Server01 リモート コンピューターから資格情報を取得します。 このコマンドでは、Invoke-Command
コマンドレットを使用して、リモート コンピューターで Get-Credential
コマンドを実行します。 出力には、認証プロンプトに含まれるリモート セキュリティ メッセージ Get-Credential
表示されます。
パラメーター
-Credential
User01 や Domain01\User01など、資格情報のユーザー名を指定します。 パラメーター名 (-Credential
) は省略可能です。
コマンドを送信し、ユーザー名を指定すると、パスワードの入力を求められます。 このパラメーターを省略すると、ユーザー名とパスワードの入力を求められます。
PowerShell 3.0 以降では、ドメインのないユーザー名を入力した場合、Get-Credential
名前の前に円記号が挿入されなくなります。
資格情報は PSCredential オブジェクトに格納され、パスワードは SecureStringとして格納されます。
手記
SecureString データ保護 の詳細については、「SecureString のセキュリティ 方法」を参照してください。.
型: | PSCredential |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Message
認証プロンプトに表示されるメッセージを指定します。 このパラメーターは、関数またはスクリプトで使用するように設計されています。 このメッセージを使用して、資格情報を要求する理由とその使用方法をユーザーに説明できます。
このパラメーターは PowerShell 3.0 で導入されました。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-UserName
ユーザー名を指定します。 認証プロンプトは、ユーザー名のパスワードを要求します。 既定では、ユーザー名は空白で、認証プロンプトはユーザー名とパスワードの両方を要求します。
ダイアログ ボックスに認証プロンプトが表示されたら、ユーザーは指定したユーザー名を編集できます。 ただし、コマンド ラインにプロンプトが表示された場合、ユーザーはユーザー名を変更できません。 このパラメーターを共有関数またはスクリプトで使用する場合は、考えられるすべてのプレゼンテーションを検討してください。
このパラメーターは PowerShell 3.0 で導入されました。
型: | String |
配置: | 1 |
規定値: | None (blank) |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
None
このコマンドレットにオブジェクトをパイプすることはできません。
出力
このコマンドレットは、資格情報オブジェクトを返します。
メモ
Credential パラメーターを使用するなど、ユーザー認証を要求するコマンドレットで作成 Get-Credential
PSCredential オブジェクトを使用できます。
既定では、認証プロンプトがダイアログ ボックスに表示されます。 コマンド ラインで認証プロンプトを表示するには、ConsolePrompting レジストリ エントリ (HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds\ConsolePrompting
) を追加し、その値を Trueに設定します。
ConsolePrompting レジストリ エントリが存在しない場合、またはその値が False の場合、認証プロンプトがダイアログ ボックスに表示されます。 手順については、例を参照してください。
ConsolePrompting レジストリ エントリは PowerShell コンソールで動作しますが、一部のホスト プログラムでは機能しません。
たとえば、PowerShell 統合スクリプト環境 (ISE) には影響しません。 ConsolePrompting レジストリ エントリの効果については、ホスト プログラムのヘルプ トピックを参照してください。
Credential パラメーターは、PowerShell でインストールされているすべてのプロバイダーでサポートされているわけではありません。
PowerShell 3.0 以降では、Get-Content
コマンドレットや New-PSDrive
コマンドレットなど、選択したコマンドレットでサポートされています。
関連リンク
PowerShell