Get-Credential
Obtém um objeto de credencial com base em um nome de usuário e senha.
Sintaxe
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. Você pode usar 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 versões anteriores, o Windows apresenta uma caixa de diálogo para solicitar um nome de usuário e senha. No PowerShell 6.0 e posterior, o prompt é apresentado no console para todas as plataformas.
Exemplos
Exemplo 1
$c = Get-CredentialEste comando obtém um objeto de credencial e o salva na $c variável.
Quando introduz o comando, é-lhe pedido um nome de utilizador e uma palavra-passe. Quando você insere as informações solicitadas, o cmdlet cria um objeto PSCredential que representa as credenciais do usuário e o salva na $c variável.
Você pode usar o objeto como entrada para cmdlets que solicitam autenticação de usuário, como aqueles com um parâmetro Credential . No entanto, alguns provedores instalados com o PowerShell não oferecem 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 a armazena $c na 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 usa 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 a 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 demonstra como criar um objeto de credencial idêntico ao retornado pelo Get-Credential.
$User = "Domain01\User01"
$PWord = Read-Host -Prompt 'Enter a Password' -AsSecureString
$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $PWordO primeiro comando atribui o nome de usuário à $User variável. Verifique se o valor segue o formato "Domínio\Usuário" ou "Nome_do_Computador\Usuário".
O segundo comando usa o Read-Host cmdlet para criar uma cadeia de caracteres segura a partir da entrada do usuário. O parâmetro Prompt solicita a entrada do usuário e o parâmetro AsSecureString mascara a entrada e a converte em uma cadeia de caracteres segura.
O terceiro comando usa o New-Object cmdlet para criar um objeto PSCredential a partir dos valores armazenados nas $User variáveis and $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:Este comando usa os parâmetros Message e UserName do Get-Credential cmdlet. Esse formato de comando foi projetado para scripts e funções compartilhados. Nesse caso, a mensagem informa ao usuário por que as credenciais são necessárias e dá a ele 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.SecureStringEste 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 incluída Get-Credential 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.
Quando você envia o comando e especifica um nome de usuário, é solicitada uma senha. Se omitir este parâmetro, ser-lhe-á pedido um nome de utilizador e uma palavra-passe.
A partir do PowerShell 3.0, se você inserir um nome de usuário sem um domínio, Get-Credential não insere mais uma barra invertida antes do nome.
As credenciais são armazenadas em um objeto PSCredential e a senha é armazenada como um SecureString.
Nota
Para obter mais informações sobre a proteção de dados do SecureString , consulte Quão seguro é o SecureString?.
| Tipo: | PSCredential |
| Position: | 1 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-Message
Especifica uma mensagem que aparece no prompt de autenticação. Este parâmetro foi projetado para uso em uma função ou script. Você pode usar a mensagem para explicar ao usuário por que está solicitando credenciais e como elas serão usadas.
Esse parâmetro foi introduzido no PowerShell 3.0.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | 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.
| Tipo: | String |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | 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 senha.
Esse parâmetro foi introduzido no PowerShell 3.0.
| Tipo: | String |
| Position: | 1 |
| Default value: | None (blank) |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
Entradas
None
Não é possível canalizar objetos para este cmdlet.
Saídas
Este cmdlet retorna um objeto de credencial.
Notas
Você pode usar o objeto PSCredential que Get-Credential cria em cmdlets que solicitam autenticação de usuário, como aqueles com um parâmetro Credential .
O parâmetro Credential não é suportado por todos os provedores instalados com o PowerShell.
A partir do PowerShell 3.0, ele é suportado em cmdlets selecionados, como os Get-Content cmdlets e New-PSDrive .
