Get-Credential
Obtém um objeto de credencial com base em um nome de usuário e senha.
Syntax
Get-Credential
[[-Credential] <PSCredential>]
[<CommonParameters>]Get-Credential
[-Message <String>]
[[-UserName] <String>]
[-Title <String>]
[<CommonParameters>]Description
O Get-Credential cmdlet cria um objeto de credencial para um nome de usuário e senha especificados. É possível utilizar o objeto de credencial em operações de segurança.
O Get-Credential cmdlet solicita ao usuário uma senha ou um nome de usuário e senha. Você pode usar o parâmetro Message para especificar uma mensagem personalizada para o prompt.
No Windows PowerShell 5.1 e anteriores, o Windows apresenta uma caixa de diálogo para solicitar um nome de usuário e uma senha. No PowerShell 6.0 e posterior, o prompt é apresentado no console de todas as plataformas.
Exemplos
Exemplo 1
$c = Get-CredentialEsse comando obtém um objeto de credencial e o salva na $c variável .
Ao inserir o comando, você será solicitado a fornecer um nome de usuário e uma senha. Quando você insere as informações solicitadas, o cmdlet cria um objeto PSCredential que representa as credenciais do usuário e as salva na $c variável.
É possível utilizar o objeto como entrada para os cmdlets que exigem autenticação de usuário, como aqueles com um parâmetro Credential. No entanto, alguns provedores instalados com o PowerShell não dão suporte ao parâmetro Credential .
Exemplo 2
$c = Get-Credential -credential User01
$c.Username
User01Este exemplo cria uma credencial que inclui um nome de usuário sem um nome de domínio.
O primeiro comando obtém uma credencial com o nome de usuário User01 e armazena-a na $c variável .
O segundo comando exibe o valor da propriedade Username do objeto de credencial resultante.
Exemplo 3
$Credential = $host.ui.PromptForCredential("Need credentials", "Please enter your user name and password.", "", "NetBiosUserName")Este comando utiliza o método PromptForCredential para solicitar ao usuário seu nome de usuário e senha. O comando salva as credenciais resultantes na $Credential variável.
O método PromptForCredential é uma alternativa ao uso do Get-Credential cmdlet . Ao usar PromptForCredential, você pode especificar o legenda, as mensagens e o nome de usuário que aparecem no prompt.
Para obter mais informações, consulte a documentação PromptForCredential no SDK.
Exemplo 4
Este exemplo mostra como criar um objeto de credencial idêntico ao objeto que Get-Credential retorna sem avisar o usuário. Este método requer uma senha de texto sem formatação, que pode violar os padrões de segurança em algumas empresas.
$User = "Domain01\User01"
$PWord = ConvertTo-SecureString -String "P@sSwOrd" -AsPlainText -Force
$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $PWordO primeiro comando salva o nome da conta de usuário no $User parâmetro . O valor deve ter o formato "Domain\User" ou "ComputerName\User".
O segundo comando usa o ConvertTo-SecureString cmdlet para criar uma cadeia de caracteres segura com base em uma senha de texto sem formatação. O comando utiliza o parâmetro AsPlainText para indicar que a cadeia de caracteres de texto está sem formatação e o parâmetro Force para confirmar que você compreende os riscos do uso de texto sem formatação.
O terceiro comando usa o New-Object cmdlet para criar um objeto PSCredential com base nos valores nas $User variáveis e $PWord .
Exemplo 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:Esse comando usa os parâmetros Message e UserName do Get-Credential cmdlet . Esse formato de comando destina-se a funções e scripts compartilhados. Nesse caso, a mensagem informa ao usuário porque as credenciais são necessárias e dá a eles confiança de que a solicitação é legítima.
Exemplo 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.SecureStringEsse comando obtém uma credencial do computador remoto Server01. O comando usa o Invoke-Command cmdlet para executar um Get-Credential comando no computador remoto. A saída mostra a mensagem de segurança remota que Get-Credential inclui no prompt de autenticação.
Parâmetros
-Credential
Especifica um nome de usuário para a credencial, como User01 ou Domain01\User01. O nome do parâmetro, -Credential, é opcional.
Ao enviar o comando e especificar um nome de usuário, você será solicitado a fornecer uma senha. Se você omitir esse parâmetro, será solicitado que você solicite um nome de usuário e uma senha.
A partir do PowerShell 3.0, se você inserir um nome de usuário sem um domínio, Get-Credential não inserirá mais uma barra invertida antes do nome.
As credenciais são armazenadas em um objeto PSCredential e a senha é armazenada como um SecureString.
Observação
Para obter mais informações sobre a proteção de dados SecureString , consulte Quão seguro é SecureString?.
| Type: | PSCredential |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Message
Especifica uma mensagem que aparece no prompt de autenticação. Esse parâmetro é projetado para o uso em uma função ou script. É possível utilizar a mensagem para explicar ao usuário por que você está solicitando credenciais e como elas serão utilizadas.
Esse parâmetro foi introduzido no PowerShell 3.0.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Title
Define o texto da linha de título para o prompt de autenticação no console.
Esse parâmetro foi introduzido no PowerShell 6.0.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserName
Especifica um nome de usuário. O prompt de autenticação solicita uma senha para o nome de usuário. Por padrão, o nome de usuário está em branco e o prompt de autenticação solicita um nome de usuário e uma senha.
Esse parâmetro foi introduzido no PowerShell 3.0.
| Type: | String |
| Position: | 1 |
| Default value: | None (blank) |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Entradas
None
Você não pode canalizar objetos para este cmdlet.
Saídas
Esse cmdlet retorna um objeto de credencial.
Observações
Você pode usar o objeto PSCredential que Get-Credential cria em cmdlets que solicitam a autenticação do usuário, como aqueles com um parâmetro Credential .
Não há suporte para o parâmetro Credential em todos os provedores instalados com o PowerShell.
A partir do PowerShell 3.0, há suporte para cmdlets selecionados, como os Get-Content cmdlets e New-PSDrive .