Freigeben über

Get-Credential

  • Referenz
Modul:
Microsoft.PowerShell.Security

Ruft ein Anmeldeinformationsobjekt basierend auf einem Benutzernamen und Kennwort ab.

Syntax

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

Beschreibung

Das Get-Credential Cmdlet erstellt ein Anmeldeinformationsobjekt für einen angegebenen Benutzernamen und ein angegebenes Kennwort. Sie können das Anmeldeinformationsobjekt für Sicherheitsvorgänge verwenden.

Das Get-Credential Cmdlet fordert den Benutzer auf, ein Kennwort oder einen Benutzernamen und ein Kennwort einzugeben. Sie können den Parameter Message verwenden, um eine angepasste Nachricht für die Eingabeaufforderung anzugeben.

In Windows PowerShell 5.1 und früheren Versionen stellt Windows ein Dialogfeld zur Eingabe eines Benutzernamens und Kennworts dar. In PowerShell 6.0 und höher wird die Eingabeaufforderung in der Konsole für alle Plattformen angezeigt.

Beispiele

Beispiel 1

$c = Get-Credential

Dieser Befehl ruft ein Anmeldeinformationsobjekt ab und speichert es in der $c Variablen.

Wenn Sie den Befehl eingeben, werden Sie aufgefordert, einen Benutzernamen und ein Kennwort einzugeben. Wenn Sie die angeforderten Informationen eingeben, erstellt das Cmdlet ein PSCredential-Objekt , das die Anmeldeinformationen des Benutzers darstellt, und speichert sie in der $c Variablen.

Sie können das Objekt als Eingabe für Cmdlets verwenden, die die Benutzerauthentifizierung anfordern, z. B. solche mit einem Credential-Parameter . Einige Anbieter, die mit PowerShell installiert sind, unterstützen jedoch nicht den Parameter "Credential ".

Beispiel 2

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

In diesem Beispiel werden die Anmeldeinformationen erstellt, die einen Benutzernamen ohne Domänennamen enthalten.

Der erste Befehl ruft eine Anmeldeinformation mit dem Benutzernamen User01 ab und speichert sie in der $c Variablen. Der zweite Befehl zeigt den Wert der Username-Eigenschaft des resultierenden Anmeldeinformationsobjekts an.

Beispiel 3

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

Dieser Befehl verwendet die PromptForCredential-Methode , um den Benutzer zur Eingabe seines Benutzernamens und Kennworts aufzufordern. Der Befehl speichert die resultierenden Anmeldeinformationen in der $Credential Variablen.

Die PromptForCredential-Methode ist eine Alternative zur Verwendung des Get-Credential Cmdlets. Wenn Sie PromptForCredential verwenden, können Sie die Beschriftung, Nachrichten und den Benutzernamen angeben, die in der Eingabeaufforderung angezeigt werden.

Weitere Informationen finden Sie in der PromptForCredential-Dokumentation im SDK.

Beispiel 4

In diesem Beispiel wird veranschaulicht, wie ein Anmeldeinformationsobjekt erstellt wird, das mit dem objekt identisch ist, das von Get-Credential.

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

Der erste Befehl weist der Variablen den Benutzernamen zu $User . Stellen Sie sicher, dass der Wert dem Format "Domäne\Benutzer" oder "ComputerName\Benutzer" folgt.

Der zweite Befehl verwendet das Read-Host Cmdlet, um eine sichere Zeichenfolge aus der Benutzereingabe zu erstellen. Der Prompt-Parameter fordert benutzereingaben an, und der AsSecureString-Parameter maskiert die Eingabe und konvertiert sie in eine sichere Zeichenfolge.

Der dritte Befehl verwendet das New-Object Cmdlet, um ein PSCredential-Objekt aus den werten zu erstellen, die in den $User und $PWord Variablen gespeichert sind.

Beispiel 5

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:

Dieser Befehl verwendet die Parameter Message und UserName des Get-Credential Cmdlets. Dieses Befehlsformat wurde für gemeinsam genutzte Skripts und Funktionen entwickelt. In diesem Fall erfährt der Benutzer in der Meldung, warum Anmeldeinformationen erforderlich sind, und bietet ihm die Sicherheit, dass die Anforderung legitim ist.

Beispiel 6

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

Dieser Befehl ruft die Anmeldeinformationen vom Remotecomputer „Server01“ ab. Der Befehl verwendet das Invoke-Command Cmdlet, um einen Get-Credential Befehl auf dem Remotecomputer auszuführen. Die Ausgabe zeigt die Remotesicherheitsmeldung an, die Get-Credential in der Authentifizierungsaufforderung enthalten ist.

Parameter

-Credential

Gibt einen Benutzernamen für die Anmeldeinformationen an, z . B. "User01 " oder "Domain01\User01". Der Parametername , -Credentialist optional.

Wenn Sie den Befehl übermitteln und einen Benutzernamen angeben, werden Sie zur Eingabe eines Kennworts aufgefordert. Wenn Sie diesen Parameter weglassen, werden Sie aufgefordert, einen Benutzernamen und ein Kennwort einzugeben.

Wenn Sie in PowerShell 3.0 einen Benutzernamen ohne Domäne eingeben, Get-Credential wird kein umgekehrter Schrägstrich mehr vor dem Namen eingefügt.

Anmeldeinformationen werden in einem PSCredential-Objekt gespeichert, und das Kennwort wird als SecureString gespeichert.

Hinweis

Weitere Informationen zum Schutz von SecureString finden Sie unter "Wie sicher ist SecureString?".

Typ:PSCredential
Position:1
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Message

Gibt eine Meldung an, die in der Authentifizierungsaufforderung angezeigt wird. Dieser Parameter dient zur Verwendung in einer Funktion oder in einem Skript. Sie können die Meldung verwenden, um dem Benutzer zu erklären, warum Sie Anmeldeinformationen anfordern und wie sie verwendet werden.

Dieser Parameter wurde in PowerShell 3.0 eingeführt.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Title

Legt den Text der Titelzeile für die Authentifizierungsaufforderung in der Konsole fest.

Dieser Parameter wurde in PowerShell 6.0 eingeführt.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-UserName

Gibt einen Benutzernamen an. Die Authentifizierungsaufforderung fordert die Eingabe eines Kennworts für den Benutzernamen an. Standardmäßig ist der Benutzername leer, und die Authentifizierungsaufforderung fordert sowohl einen Benutzernamen als auch ein Kennwort an.

Dieser Parameter wurde in PowerShell 3.0 eingeführt.

Typ:String
Position:1
Standardwert:None (blank)
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

None

Sie können keine Objekte an dieses Cmdlet weiterleiten.

Ausgaben

PSCredential

Dieses Cmdlet gibt ein Anmeldeinformationsobjekt zurück.

Hinweise

Sie können das PSCredential-Objekt verwenden, das Get-Credential in Cmdlets erstellt wird, die die Benutzerauthentifizierung anfordern, z. B. solche mit einem Credential-Parameter .

Der Parameter "Credential " wird von allen Anbietern, die mit PowerShell installiert sind, nicht unterstützt. Ab PowerShell 3.0 wird sie für ausgewählte Cmdlets wie die Get-Content und New-PSDrive cmdlets unterstützt.