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 Cmdlet Get-Credential erstellt ein Anmeldeinformationsobjekt für einen angegebenen Benutzernamen und ein angegebenes Kennwort. Sie können das Anmeldeinformationsobjekt für Sicherheitsvorgänge verwenden.

Das cmdlet Get-Credential fordert den Benutzer zur Eingabe eines Kennworts oder eines Benutzernamens und Kennworts auf. 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 variablen $c.

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 Anmeldeinformationsparameter. 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 variablen $c. Der zweite Befehl zeigt den Wert der Username-Eigenschaft des resultierenden Anmeldeobjekts 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 variablen $Credential.

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

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

Beispiel 4

In diesem Beispiel wird veranschaulicht, wie Sie ein Anmeldeinformationsobjekt erstellen, das mit dem von Get-Credentialzurückgegebenen Objekt identisch ist.

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

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

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

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

Beispiel 5

$credentialParams = @{
    Message = "Credential are required for access to the \\Server1\Scripts file share."
    UserName = "Server01\PowerUser"
}
Get-Credential @credentialParams

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 Cmdlets Get-Credential. Dieses Befehlsformat wurde für freigegebene Skripts und Funktionen entwickelt. In diesem Fall teilt die Nachricht dem Benutzer mit, warum Anmeldeinformationen benötigt werden, und gibt ihm vertrauen, dass die Anforderung legitim ist.

Beispiel 6

Invoke-Command -ComputerName Server01 -ScriptBlock {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 cmdlet Invoke-Command zum Ausführen eines Get-Credential Befehls auf dem Remotecomputer. Die Ausgabe zeigt die Remotesicherheitsmeldung an, die Get-Credential im Authentifizierungsprompt enthält.

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, wird Get-Credential vor dem Namen keinen umgekehrten Schrägstrich mehr einfügen.

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

Anmerkung

Weitere Informationen zu SecureString Datenschutz 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 ist für die Verwendung in einer Funktion oder einem Skript vorgesehen. Mithilfe der Nachricht können Sie dem Benutzer erklären, warum Sie Anmeldeinformationen anfordern und wie diese 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 ein Kennwort 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 in cmdlets erstellt wird Get-Credential, das 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 unterstützt, z. B. die Get-Content und New-PSDrive Cmdlets.