Dela via

Get-Credential

  • Referens
Modul:
Microsoft.PowerShell.Security

Hämtar ett autentiseringsobjekt baserat på ett användarnamn och lösenord.

Syntax

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

Description

Cmdleten Get-Credential skapar ett autentiseringsobjekt för ett angivet användarnamn och lösenord. Du kan använda autentiseringsobjektet i säkerhetsåtgärder.

Från och med PowerShell 3.0 kan du använda parametern Meddelande för att ange ett anpassat meddelande i dialogrutan som uppmanar användaren att ange deras namn och lösenord.

Cmdleten Get-Credential frågar användaren om ett lösenord eller ett användarnamn och lösenord. Som standard visas en dialogruta för autentisering för att fråga användaren. I vissa värdprogram, till exempel PowerShell-konsolen, kan du dock fråga användaren på kommandoraden genom att ändra en registerpost. Mer information om den här registerposten finns i anteckningarna och exemplen.

Exempel

Exempel 1

$c = Get-Credential

Det här kommandot hämtar ett autentiseringsobjekt och sparar det i variabeln $c .

När du anger kommandot visas en dialogruta som begär användarnamn och lösenord. När du anger den begärda informationen skapar cmdleten ett PSCredential-objekt som representerar användarens autentiseringsuppgifter och sparar den i variabeln $c .

Du kan använda objektet som indata till cmdletar som begär användarautentisering, till exempel de med en autentiseringsparameter . Vissa leverantörer som är installerade med PowerShell stöder dock inte parametern Credential .

Exempel 2

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

I det här exemplet skapas en autentiseringsuppgift som innehåller ett användarnamn utan domännamn.

Det första kommandot hämtar en autentiseringsuppgift med användarnamnet User01 och lagrar den i variabeln $c . Det andra kommandot visar värdet för egenskapen Username för det resulterande autentiseringsobjektet.

Exempel 3

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

Det här kommandot använder metoden PromptForCredential för att fråga användaren om deras användarnamn och lösenord. Kommandot sparar de resulterande autentiseringsuppgifterna i variabeln $Credential .

Metoden PromptForCredential är ett alternativ till att använda cmdleten Get-Credential . När du använder PromptForCredential kan du ange bildtext, meddelanden och användarnamn som visas i meddelanderutan.

Mer information finns i Dokumentationen om PromptForCredential i SDK.

Exempel 4

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

Det här exemplet visar hur du ändrar registret så att användaren uppmanas på kommandoraden i stället för med hjälp av en dialogruta.

Kommandot skapar registerposten ConsolePrompting och anger dess värde till True. Om du vill köra det här kommandot startar du PowerShell med alternativet "Kör som administratör".

Om du vill använda en dialogruta för att fråga anger du värdet för ConsolePrompting till false ($false) eller använder cmdleten Remove-ItemProperty för att ta bort den.

Registerposten ConsolePrompting fungerar i vissa värdprogram, till exempel PowerShell-konsolen. Det kanske inte fungerar i alla värdprogram.

Exempel 5

Det här exemplet visar hur du skapar ett autentiseringsobjekt som är identiskt med det som returneras av Get-Credential.

$User = "Domain01\User01"
$PWord = Read-Host -Prompt 'Enter a Password' -AsSecureString
$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $PWord

Det första kommandot tilldelar variabeln användarnamnet $User . Kontrollera att värdet följer formatet "Domain\User" eller "ComputerName\User".

Det andra kommandot använder cmdleten Read-Host för att skapa en säker sträng från användarindata. Parametern Prompt begär användarindata och parametern AsSecureString maskerar indata och konverterar den till en säker sträng.

Det tredje kommandot använder cmdleten New-Object för att skapa ett PSCredential-objekt från värdena som lagras i variablerna $User och $PWord .

Exempel 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:

Det här kommandot använder parametrarna Meddelande och Användarnamn för cmdleten Get-Credential . Det här kommandoformatet är utformat för delade skript och funktioner. I det här fallet meddelar meddelandet användaren varför autentiseringsuppgifter behövs och ger dem förtroende för att begäran är legitim.

Exempel 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

Det här kommandot hämtar en autentiseringsuppgift från server01-fjärrdatorn. Kommandot använder cmdleten Invoke-Command för att köra ett Get-Credential kommando på fjärrdatorn. Utdata visar fjärrsäkerhetsmeddelandet som Get-Credential ingår i autentiseringsprompten.

Parametrar

-Credential

Anger ett användarnamn för autentiseringsuppgifterna, till exempel User01 eller Domain01\User01. Parameternamnet , -Credentialär valfritt.

När du skickar kommandot och anger ett användarnamn uppmanas du att ange ett lösenord. Om du utelämnar den här parametern uppmanas du att ange ett användarnamn och ett lösenord.

Från och med PowerShell 3.0, om du anger ett användarnamn utan domän, Get-Credential infogar du inte längre ett omvänt snedstreck före namnet.

Autentiseringsuppgifter lagras i ett PSCredential-objekt och lösenordet lagras som en SecureString.

Kommentar

Mer information om SecureString-dataskydd finns i Hur säker är SecureString?.

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

-Message

Anger ett meddelande som visas i autentiseringsprompten. Den här parametern är utformad för användning i en funktion eller ett skript. Du kan använda meddelandet för att förklara för användaren varför du begär autentiseringsuppgifter och hur de ska användas.

Den här parametern introducerades i PowerShell 3.0.

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

-UserName

Anger ett användarnamn. Autentiseringsprompten begär ett lösenord för användarnamnet. Som standard är användarnamnet tomt och autentiseringsprompten begär både användarnamn och lösenord.

När autentiseringsprompten visas i en dialogruta kan användaren redigera det angivna användarnamnet. Användaren kan dock inte ändra användarnamnet när kommandotolken visas på kommandoraden. När du använder den här parametern i en delad funktion eller ett skript bör du överväga alla möjliga presentationer.

Den här parametern introducerades i PowerShell 3.0.

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

Indata

None

Du kan inte skicka objekt till den här cmdleten.

Utdata

PSCredential

Den här cmdleten returnerar ett autentiseringsobjekt.

Kommentarer

Du kan använda PSCredential-objektet som Get-Credential skapas i cmdletar som begär användarautentisering, till exempel de med en autentiseringsparameter.

Som standard visas autentiseringsprompten i en dialogruta. Om du vill visa autentiseringsprompten på kommandoraden lägger du till registerposten ConsolePrompting (HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds\ConsolePrompting) och anger värdet true. Om registerposten ConsolePrompting inte finns eller om dess värde är False visas autentiseringsprompten i en dialogruta. Anvisningar finns i exemplen.

Registerposten ConsolePrompting fungerar i PowerShell-konsolen, men den fungerar inte i alla värdprogram.

Det har till exempel ingen effekt i PowerShell Integrated Scripting Environment (ISE). Information om effekten av registerposten ConsolePrompting finns i hjälpavsnitten för värdprogrammet.

Parametern Credential stöds inte av alla leverantörer som är installerade med PowerShell. Från och med PowerShell 3.0 stöds det på utvalda cmdletar, till exempel Get-Content cmdletarna och New-PSDrive .