Partager via

Get-Credential

  • Référence
Module:
Microsoft.PowerShell.Security

Obtient un objet d'informations d'identification basé sur un nom d'utilisateur et un mot de passe.

Syntaxe

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

Description

L’applet Get-Credential de commande crée un objet d’informations d’identification pour un nom d’utilisateur et un mot de passe spécifiés. Vous pouvez utiliser l'objet d'informations d'identification dans les opérations de sécurité.

À compter de PowerShell 3.0, vous pouvez utiliser le paramètre Message pour spécifier un message personnalisé dans la boîte de dialogue qui invite l’utilisateur à entrer son nom et son mot de passe.

L’applet Get-Credential de commande invite l’utilisateur à entrer un mot de passe ou un nom d’utilisateur et un mot de passe. Par défaut, une boîte de dialogue d'authentification s'affiche pour solliciter l'utilisateur. Toutefois, dans certains programmes hôtes, tels que la console PowerShell, vous pouvez inviter l’utilisateur à se trouver sur la ligne de commande en modifiant une entrée de Registre. Pour plus d'informations sur cette entrée de Registre, consultez les remarques et les exemples.

Exemples

Exemple 1

$c = Get-Credential

Cette commande obtient un objet d’informations d’identification et l’enregistre dans la $c variable.

Quand vous entrez la commande, une boîte de dialogue s'affiche demandant un nom d'utilisateur et un mot de passe. Lorsque vous entrez les informations demandées, l’applet de commande crée un objet PSCredential représentant les informations d’identification de l’utilisateur et l’enregistre dans la $c variable.

Vous pouvez utiliser l’objet comme entrée pour les applets de commande qui demandent l’authentification utilisateur, telles que celles avec un paramètre Credential . Toutefois, certains fournisseurs installés avec PowerShell ne prennent pas en charge le paramètre Credential .

Exemple 2

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

Cet exemple crée une information d'identification qui inclut un nom d'utilisateur sans nom de domaine.

La première commande obtient des informations d’identification avec le nom d’utilisateur User01 et la stocke dans la $c variable. La deuxième commande affiche la valeur de la propriété Username de l’objet d’informations d’identification résultant.

Exemple 3

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

Cette commande utilise la méthode PromptForCredential pour inviter l’utilisateur à entrer son nom d’utilisateur et son mot de passe. La commande enregistre les informations d’identification obtenues dans la $Credential variable.

La méthode PromptForCredential est une alternative à l’utilisation de l’applet de Get-Credential commande. Lorsque vous utilisez PromptForCredential, vous pouvez spécifier la légende, les messages et le nom d’utilisateur qui s’affichent dans la zone de message.

Pour plus d’informations, consultez la documentation PromptForCredential dans le Kit de développement logiciel (SDK).

Exemple 4

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

Cet exemple montre comment modifier le Registre pour que l'utilisateur soit sollicité depuis la ligne de commande, et non à l'aide d'une boîte de dialogue.

La commande crée l’entrée de Registre ConsolePrompting et définit sa valeur sur True. Pour exécuter cette commande, démarrez PowerShell avec l’option « Exécuter en tant qu’administrateur ».

Pour utiliser une boîte de dialogue pour l’invite, définissez la valeur de consolePrompting sur false ($false) ou utilisez l’applet de commande pour la Remove-ItemProperty supprimer.

L’entrée de Registre ConsolePrompting fonctionne dans certains programmes hôtes, tels que la console PowerShell. Elle peut ne pas fonctionner dans tous les programmes hôtes.

Exemple 5

Cet exemple montre comment créer un objet d’informations d’identification identique à celui retourné par Get-Credential.

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

La première commande affecte le nom d’utilisateur à la $User variable. Vérifiez que la valeur suit le format « Domain\User » ou « ComputerName\User ».

La deuxième commande utilise l’applet Read-Host de commande pour créer une chaîne sécurisée à partir de l’entrée utilisateur. Le paramètre Prompt demande une entrée utilisateur, et le paramètre AsSecureString masque l’entrée et le convertit en chaîne sécurisée.

La troisième commande utilise l’applet New-Object de commande pour créer un objet PSCredential à partir des valeurs stockées dans les variables et $PWord les $User variables.

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

Cette commande utilise les paramètres Message et UserName de l’applet Get-Credential de commande. Ce format de commande est conçu pour les fonctions et les scripts partagés. Dans ce cas, le message indique à l'utilisateur pourquoi les informations d'identification sont nécessaires tout en l'assurant implicitement que la demande est légitime.

Exemple 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

Cette commande obtient des informations d'identification de l'ordinateur distant Server01. La commande utilise l’applet Invoke-Command de commande pour exécuter une Get-Credential commande sur l’ordinateur distant. La sortie affiche le message de sécurité à distance inclus Get-Credential dans l’invite d’authentification.

Paramètres

-Credential

Spécifie un nom d’utilisateur pour les informations d’identification, telles que User01 ou Domain01\User01. Le nom du paramètre, est -Credentialfacultatif.

Lorsque vous envoyez la commande et spécifiez un nom d’utilisateur, vous êtes invité à entrer un mot de passe. Si vous omettez ce paramètre, vous êtes invité à entrer un nom d’utilisateur et un mot de passe.

À compter de PowerShell 3.0, si vous entrez un nom d’utilisateur sans domaine, Get-Credential n’insère plus de barre oblique inverse avant le nom.

Les informations d’identification sont stockées dans un objet PSCredential et le mot de passe est stocké en tant que SecureString.

Remarque

Pour plus d’informations sur la protection des données SecureString , consultez Comment secure is SecureString ?.

Type:PSCredential
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Message

Spécifie un message qui s'affiche dans l'invite d'authentification. Ce paramètre est conçu pour une utilisation dans une fonction ou un script. Vous pouvez utiliser le message pour expliquer à l'utilisateur pourquoi vous demandez des informations d'identification et comment elles seront utilisées.

Ce paramètre a été introduit dans PowerShell 3.0.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-UserName

Spécifie un nom d'utilisateur. L'invite d'authentification demande un mot de passe pour le nom d'utilisateur. Par défaut, le nom d'utilisateur est vide et l'invite d'authentification demande un nom d'utilisateur et un mot de passe.

Quand l'invite d'authentification s'affiche dans une boîte de dialogue, l'utilisateur peut modifier le nom d'utilisateur spécifié. Toutefois, l'utilisateur ne peut pas modifier le nom d'utilisateur quand l'invite apparaît sur la ligne de commande. Quand vous utilisez ce paramètre dans une fonction partagée ou un script, envisagez toutes les présentations possibles.

Ce paramètre a été introduit dans PowerShell 3.0.

Type:String
Position:1
Valeur par défaut:None (blank)
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

None

Vous ne pouvez pas diriger les objets vers cette applet de commande.

Sorties

PSCredential

Cette applet de commande retourne un objet d’informations d’identification.

Notes

Vous pouvez utiliser l’objet PSCredential qui Get-Credential crée dans les applets de commande qui demandent l’authentification de l’utilisateur, comme celles avec un paramètre Credential .

Par défaut, l'invite d'authentification s'affiche dans une boîte de dialogue. Pour afficher l’invite d’authentification sur la ligne de commande, ajoutez l’entrée de Registre ConsolePrompting (HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds\ConsolePrompting) et définissez sa valeur sur True. Si l’entrée de Registre ConsolePrompting n’existe pas ou si sa valeur est False, l’invite d’authentification s’affiche dans une boîte de dialogue. Pour obtenir des instructions, consultez les exemples.

L’entrée de Registre ConsolePrompting fonctionne dans la console PowerShell, mais elle ne fonctionne pas dans tous les programmes hôtes.

Par exemple, il n’a aucun effet dans l’environnement de script intégré PowerShell (ISE). Pour plus d’informations sur l’effet de l’entrée de Registre ConsolePrompting , consultez les rubriques d’aide du programme hôte.

Le paramètre Credential n’est pas pris en charge par tous les fournisseurs installés avec PowerShell. À compter de PowerShell 3.0, il est pris en charge sur les applets de commande sélectionnées, telles que les Get-Content applets de commande et New-PSDrive les applets de commande.