Get-Credential

模組:

Microsoft.PowerShell.Security

根據使用者名稱和密碼取得認證物件。

Syntax

Get-Credential
   [-Credential] <PSCredential>
   [<CommonParameters>]

Get-Credential
   -Message <String>
   [[-UserName] <String>]
   [<CommonParameters>]

Description

Cmdlet Get-Credential 會為指定的使用者名稱和密碼建立認證物件。 您可以在安全性作業中使用認證物件。

從 PowerShell 3.0 開始，您可以使用 Message 參數在對話框上指定自訂訊息，提示使用者輸入其名稱和密碼。

Cmdlet Get-Credential 會提示使用者輸入密碼或使用者名稱和密碼。 根據預設，[驗證] 對話框會顯示為提示使用者。 不過，在某些主機程式中，例如 PowerShell 控制台，您可以變更登錄專案，在命令行提示使用者。 如需此登錄專案的詳細資訊，請參閱附註和範例。

範例

範例 1

$c = Get-Credential

此命令會取得認證物件，並將它儲存在變數中 $c 。

當您輸入命令時，會出現一個對話框，要求使用者名稱和密碼。 當您輸入要求的資訊時，Cmdlet 會 建立代表用戶認證的 PSCredential 物件，並將它儲存在變數中 $c 。

您可以使用 對象作為要求使用者驗證的 Cmdlet 輸入，例如具有 Credential 參數的 Cmdlet。 不過，某些與 PowerShell 一起安裝的提供者不支援 Credential 參數。

範例 2

$c = Get-Credential -credential User01
$c.Username
User01

此範例會建立包含不含功能變數名稱之使用者名稱的認證。

第一個命令會取得用戶名稱 User01 的認證，並將它儲存在變數中 $c 。 第二個命令會顯示 所產生認證物件的Username 屬性值。

範例 3

$Credential = $host.ui.PromptForCredential("Need credentials", "Please enter your user name and password.", "", "NetBiosUserName")

此命令會使用 PromptForCredential 方法來提示使用者輸入其使用者名稱和密碼。 命令會將產生的認證儲存在變數中 $Credential 。

PromptForCredential 方法是使用 Get-Credential Cmdlet 的替代方法。 當您使用 PromptForCredential 時，可以指定出現在消息框中的 標題、訊息和用戶名稱。

如需詳細資訊，請參閱 SDK 中的 PromptForCredential 檔。

範例 4

Set-ItemProperty "HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds" -Name ConsolePrompting -Value $true

這個範例示範如何修改登錄，讓使用者在命令行提示，而不是使用對話框。

此命令會 建立 ConsolePrompting 登錄專案，並將其值設定為 True。 若要執行此命令，請使用 [以系統管理員身分執行] 選項啟動 PowerShell。

若要使用對話框提示，請將 ConsolePrompting 的值設定為 false （$false），或使用 Remove-ItemProperty Cmdlet 將其刪除。

ConsolePrompting 登錄專案適用於某些主機程式，例如 PowerShell 控制台。 它可能無法在所有主機程序中運作。

範例 5

此範例示範如何建立與傳回的物件相同的認證物件， Get-Credential 而不提示使用者。 此方法需要純文本密碼，這可能會違反某些企業的安全性標準。

$User = "Domain01\User01"
$PWord = ConvertTo-SecureString -String "P@sSwOrd" -AsPlainText -Force
$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $PWord

第一個命令會將用戶帳戶名稱儲存在 參數中 $User 。 值必須具有 「Domain\User」 或 「ComputerName\User」 格式。

第二個命令會 ConvertTo-SecureString 使用 Cmdlet，從純文本密碼建立安全字串。 此命令會使用 AsPlainText 參數來指出字串是純文字，而 Force 參數會確認您瞭解使用純文字的風險。

第三個命令會New-Object使用 Cmdlet，從和 $PWord 變數中的$User值建立 PSCredential 物件。

範例 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:

此命令會使用 Cmdlet 的 Get-Credential Message 和 UserName 參數。 此命令格式是針對共用文本和函式所設計。 在此情況下，訊息會告知用戶為何需要認證，並讓他們確信要求是合法的。

範例 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 使用 Cmdlet 在遠端電腦上執行 Get-Credential 命令。 輸出會顯示驗證提示中所包含的遠端安全性訊息 Get-Credential 。

參數

-Credential

指定認證的用戶名稱，例如User01或Domain01\User01。 參數名稱 -Credential是選擇性的。

當您提交命令並指定使用者名稱時，系統會提示您輸入密碼。 如果您省略此參數，系統會提示您輸入使用者名稱和密碼。

從 PowerShell 3.0 開始，如果您輸入沒有網域的使用者名稱， Get-Credential 就不會再插入名稱之前的反斜杠。

認證會儲存在 PSCredential 物件中，密碼會儲存為 SecureString。

注意

如需 SecureString 數據保護的詳細資訊，請參閱 SecureString 有多安全？。

Type:	PSCredential
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Message

指定出現在驗證提示中的訊息。 此參數的設計目的是在函式或腳本中使用。 您可以使用訊息向使用者說明您要求認證的原因，以及其使用方式。

此參數是在 PowerShell 3.0 中引進的。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-UserName

指定用戶名稱。 驗證提示會要求使用者名稱的密碼。 根據預設，用戶名稱是空白的，而驗證提示會同時要求使用者名稱和密碼。

當驗證提示出現在對話框中時，用戶可以編輯指定的用戶名稱。 不過，當提示出現在命令行時，用戶無法變更用戶名稱。 在共用函式或腳本中使用此參數時，請考慮所有可能的簡報。

此參數是在 PowerShell 3.0 中引進的。

Type:	String
Position:	1
Default value:	None (blank)
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

輸入

None

您無法使用管線將物件傳送至此 Cmdlet。

輸出

PSCredential

此 Cmdlet 會傳回認證物件。

備註

您可以使用 PSCredential 物件，Get-Credential在要求使用者驗證的 Cmdlet 中建立，例如具有 Credential 參數的 Cmdlet。

根據預設，驗證提示會出現在對話框中。 若要在命令行顯示驗證提示，請新增 ConsolePrompting 登錄專案 （HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds\ConsolePrompting）， 並將其值設定為 True。 如果 ConsolePrompting 登錄專案不存在，或其值為 False，驗證提示會出現在對話框中。 如需指示，請參閱範例。

ConsolePrompting 登錄專案可在 PowerShell 控制台中運作，但無法在所有主機程式中運作。

例如，它在PowerShell整合式腳本環境 （ISE） 中沒有作用。 如需 ConsolePrompting 登錄專案之效果的相關信息，請參閱主機程式的說明主題。

所有與 PowerShell 一起安裝的提供者都不支援 Credential 參數。 從 PowerShell 3.0 開始，選取 Cmdlet 支援它，例如 Get-Content 和 New-PSDrive Cmdlet。

相關連結

• PromptForCredential