Get-Credential

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

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

L’applet de commande Get-Credential 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 de commande Get-Credential 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 inviter 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 notes et les exemples.

$c = Get-Credential

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

Lorsque vous entrez la commande, une boîte de dialogue s’affiche en 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 variable $c.

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

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

Cet exemple crée des informations d’identification qui incluent 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 variable $c. La deuxième commande affiche la valeur de la propriété Username de l’objet d’informations d’identification résultant.

$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 variable $Credential.

La méthode PromptForCredential est une alternative à l’utilisation de l’applet de commande Get-Credential. 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).

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

Cet exemple montre comment modifier le Registre afin que l’utilisateur soit invité à la ligne de commande, au lieu d’utiliser 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 Remove-ItemProperty pour la supprimer.

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

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 variable $User. Vérifiez que la valeur suit le format « Domain\User » ou « ComputerName\User ».

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

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

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 de commande Get-Credential. Ce format de commande est conçu pour les scripts et fonctions partagés. Dans ce cas, le message indique à l’utilisateur pourquoi les informations d’identification sont nécessaires et leur donne confiance que la demande est légitime.

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

La commande récupère un identifiant de l’ordinateur distant Server01. La commande utilise l’applet de commande Invoke-Command pour exécuter une commande Get-Credential sur l’ordinateur distant. La sortie montre le message de sécurité à distance que Get-Credential inclut dans l'invite d'authentification.

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

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

Cette applet de commande retourne un objet d'identification.

Vous pouvez utiliser l’objet PSCredential qui Get-Credential crée dans des applets de commande qui demandent l’authentification de l’utilisateur, telles que celles avec un paramètre d'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 apparaît 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 applets de commande Get-Content et New-PSDrive.