Get-Credential

Obtém um objeto de credencial com base em um nome de usuário e uma senha.

Sintaxe

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

Descrição

O cmdlet Get-Credential cria um objeto de credencial para um nome de usuário e uma senha especificados. Você pode usar o objeto de credencial em operações de segurança.

O cmdlet solicita ao usuário uma senha ou um nome de usuário e senha. Os usuários são avisados por meio de uma caixa de diálogo ou na linha de comando, dependendo das configurações do Registro do sistema.

Parâmetros

-Credential <PSCredential>

Especifica um nome de usuário para a credencial, como "User01" ou "Domain01\User01". O nome do parâmetro ("Credential") é opcional.

Uma senha será solicitada quando você inserir o comando.

Se você digitar um nome de usuário sem um domínio, Get-Credential inserirá uma barra invertida antes do nome.

Se você omitir esse parâmetro, será solicitado que digite um nome de usuário e uma senha.

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.

Entradas e saídas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.

Observações

Você pode usar o objeto PSCredential criado por Get-Credential nos cmdlets que solicitam autenticação do usuário, como aqueles que possuem um parâmetro Credential.

O parâmetro Credential não suportados pelos provedores instalados com o Windows PowerShell. No entanto, você pode usar o parâmetro Credential com Get-WmiObject, pois ele chama Microsoft .NET Framework diretamente.

Exemplo 1

C:\PS>$c = Get-Credential

Descrição
-----------
Esse comando obtém um objeto de credencial e salva-o na variável $c. 

Quando você insere o comando, é exibida uma caixa de diálogo solicitando 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 salva-o na variável $c. 

Você pode usar o objeto como entrada para os cmdlets que solicitam autenticação do usuário, como aqueles que possuem um parâmetro Credential. No entanto, os provedores instalados com o Windows PowerShell não suportam o parâmetro Credential.

Exemplo 2

C:\PS>$c = Get-Credential

C:\PS>Get-WmiObject Win32_DiskDrive -ComputerName Server01 -Credential $c

Descrição
-----------
Esses comandos usam um objeto de credencial de Get-Credential para autenticar um usuário em um computador remoto, de forma que eles possam usar o WMI () para gerenciar o computador.

O primeiro comando obtém um objeto de credencial e salva-o na variável $c. O segundo comando usa o objeto de credencial em um comando Get-WmiObject. Esse comando obtém informações sobre as unidades de disco no computador Server01.

Exemplo 3

C:\PS>C:\PS>Get-WmiObject Win32_BIOS -ComputerName Server01 '
-Credential (get-credential Domain01\User01)

Descrição
-----------
Esse comando mostra como incluir um comando Get-Credential em um comando Get-WmiObject.

Esse comando usa o cmdlet Get-WmiObject para obter informações sobre o BIOS no computador Server01. Ele usa o parâmetro Credential para autenticar o usuário, Domain01\User01, e um comando Get-Credential como o valor do parâmetro Credential.

Exemplo 4

C:\PS>$c = Get-Credential -credential User01

C:\PS>$c.Username

\User01

Descrição
-----------
Este exemplo cria uma credencial que inclui um nome de usuário sem um nome de domínio. Ele demonstra que Get-Credential insere uma barra invertida antes do nome de usuário.

O primeiro comando obtém uma credencial com o nome de usuário, User01, e a armazena na variável $c.

O segundo comando exibe o valor da propriedade Username do objeto de credencial resultante.

Exemplo 5

C:\PS>$credential = $host.ui.PromptForCredential("Need credentials", "Please enter your user name and password.", "", "NetBiosUserName")

Descrição
-----------
Esse comando usa o método PromptForCredential para solicitar ao usuário a senha e o nome de usuário. O comando salva as credenciais resultantes na variável $credential.

PromptForCredential é uma alternativa ao uso de Get-Credential. Quando você usar PromptForCredential, poderá especificar a legenda, as mensagens e o nome de usuário que aparecerão na caixa de mensagem.

Exemplo 6

C:\PS>Set-ItemProperty 'HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds' ConsolePrompting $true

Descrição
-----------
Quando a senha e o nome de usuário forem obrigatórios, por padrão, será exibida uma caixa de diálogo para avisar o usuário. Para ser avisado na linha de comando, modifique o Registro executando esse comando como administrador no Windows PowerShell.

Use o mesmo comando, com "ConsolePrompting $false", para ser avisado com uma caixa de diálogo.