Get-Credential

Referência

Módulo:: Microsoft.PowerShell.Security

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>]
   [<CommonParameters>]

Description

O cmdlet Get-Credential 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.

A partir do Windows PowerShell 3.0, você pode usar o parâmetro Message para especificar uma mensagem personalizada na caixa de diálogo que solicita ao usuário seu nome e senha.

O cmdlet Get-Credential solicita ao usuário uma senha ou um nome de usuário e senha. Por padrão, uma caixa de diálogo de autenticação aparece para solicitar ao usuário. No entanto, em alguns programas de host, como o console do Windows PowerShell, você pode solicitar ao usuário na linha de comando alterando uma entrada do Registro. Para obter mais informações sobre essa entrada do Registro, consulte as anotações e exemplos.

Exemplos

Exemplo 1

$c = Get-Credential

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

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

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 Windows PowerShell não dão suporte ao parâmetro de credenciais .

Exemplo 2

$c = Get-Credential
Get-WmiObject Win32_DiskDrive -ComputerName Server01 -Credential $c

Esses comandos usam um objeto de credencial que o cmdlet Get-Credential retorna para autenticar um usuário em um computador remoto para que ele possa usar a WMI (Instrumentação de Gerenciamento do Windows) para gerenciar o computador.

O primeiro comando obtém um objeto de credencial e o salva 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

Get-WmiObject Win32_BIOS -ComputerName Server01 -Credential (Get-Credential -Credential Domain01\User01)

Este 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 de Credenciais .

Exemplo 4

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

Este 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 o armazena na variável $c.

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

Exemplo 5

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

Esse 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 variável $Credential.

O método PromptForCredential é uma alternativa ao uso do cmdlet Get-Credential. Ao usar PromptForCredential, você pode especificar a legenda, as mensagens e o nome de usuário que aparecem na caixa de mensagem.

Exemplo 6

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

Este exemplo mostra como modificar o registro para que o usuário seja solicitado na linha de comando, em vez de usar uma caixa de diálogo.

O comando cria a entrada do registro ConsolePrompting e define seu valor como True. Para executar esse comando, inicie o Windows PowerShell com a opção "Executar como administrador".

Para usar uma caixa de diálogo para solicitação, defina o valor do ConsolePrompting como false ($false) ou use o cmdlet Remove-ItemProperty para excluí-lo.

A entrada do registro ConsolePrompting funciona em alguns programas de host, como o console do Windows PowerShell. Pode não funcionar em todos os programas de host.

Exemplo 7

Este exemplo mostra como criar um objeto de credencial idêntico ao objeto que Get-Credential retorna sem avisar o usuário. Esse método requer uma senha de texto sem formatação, o que pode violar os padrões de segurança em algumas empresas.

PS> $User = "Domain01\User01"
PS> $PWord = ConvertTo-SecureString -String "P@sSwOrd" -AsPlainText -Force
PS> $Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $PWord

O primeiro comando salva o nome da conta de usuário no parâmetro $User. O valor deve ter o formato "Domínio\Usuário" ou "ComputerName\User".

O segundo comando usa o cmdlet ConvertTo-SecureString para criar uma cadeia de caracteres segura com base em uma senha de texto sem formatação. O comando usa o parâmetro AsPlainText para indicar que a cadeia de caracteres é texto sem formatação e o parâmetro Force para confirmar que você entende os riscos de usar texto sem formatação.

O terceiro comando usa o cmdlet New-Object para criar um objeto PSCredential dos valores nas variáveis $User e $PWord.

Exemplo 8

PS> Get-Credential -Message "Credential are required for access to the \\Server1\Scripts file share." -User Server01\PowerUsers
Windows PowerShell Credential Request
Credential are required for access to the \\Server1\Scripts file share.
Password for user ntdev\juneb:

Esse comando usa os parâmetros de Mensagem e do nome de usuário do cmdlet Get-Credential. 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 lhes dá confiança de que a solicitação é legítima.

Exemplo 9

PS> Invoke-Command -ComputerName Server01 {Get-Credential Domain01\User02}

Windows PowerShell Credential Request : Windows 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

Esse comando obtém uma credencial do computador remoto Server01. O comando usa o cmdlet Invoke-Command para executar um comando Get-Credential 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 ("Credencial") é opcional.

Ao enviar o comando, você será solicitado a fornecer uma senha.

A partir do Windows 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.

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

Tipo:	PSCredential
Cargo:	1
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Message

Especifica uma mensagem que aparece no prompt de autenticação.

Esse parâmetro foi projetado para uso em uma função ou script. Você pode usar a mensagem para explicar ao usuário por que você está solicitando credenciais e como elas serão usadas.

Esse parâmetro é introduzido no Windows PowerShell 3.0.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	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.

Quando o prompt de autenticação aparece em uma caixa de diálogo, o usuário pode editar o nome de usuário especificado. No entanto, o usuário não pode alterar o nome de usuário quando o prompt aparece na linha de comando. Ao usar esse parâmetro em uma função ou script compartilhado, considere todas as apresentações possíveis.

Esse parâmetro é introduzido no Windows PowerShell 3.0.

Tipo:	String
Cargo:	1
Valor padrão:	None (blank)
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

Entradas

None

Não é possível redirecionar a entrada para este cmdlet.

Saídas

PSCredential

Get-Credential retorna um objeto de credencial.

Observações

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.

Por padrão, o prompt de autenticação aparece em uma caixa de diálogo. Para exibir o prompt de autenticação na linha de comando, adicione o ConsolePrompting entrada do Registro (HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds\ConsolePrompting) e defina seu valor como True. Se o ConsolePrompting entrada do Registro não existir ou se seu valor for False, o prompt de autenticação será exibido em uma caixa de diálogo. Para obter instruções, consulte os exemplos.

O ConsolePrompting entrada do Registro funciona no console do Windows PowerShell, mas não funciona em todos os programas de host.

Por exemplo, ele não tem efeito no ISE (Ambiente de Script Integrado) do Windows PowerShell. Para obter informações sobre o efeito do ConsolePrompting entrada do Registro, consulte os tópicos de ajuda para o programa host.

Não há suporte para o parâmetro credencial por todos os provedores instalados com o Windows PowerShell. A partir do Windows PowerShell 3.0, ele tem suporte no cmdlet selecionado, como os cmdlets Get-WmiObject e New-PSDrive.

Compartilhar via