Udostępnij za pośrednictwem

Get-Credential

  • Odwołanie
Moduł:
Microsoft.PowerShell.Security

Pobiera obiekt poświadczeń, uzyskując go na podstawie nazwy użytkownika i hasła.

Składnia

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

Opis

Polecenie cmdlet Get-Credential tworzy obiekt poświadczeń dla określonej nazwy użytkownika i hasła. Obiekt poświadczeń można używać w operacjach związanych z bezpieczeństwem.

Polecenie cmdlet Get-Credential monituje użytkownika o podanie hasła lub nazwy użytkownika i hasła. Możesz użyć parametru Message, aby określić dostosowany komunikat dla monitu.

W programie Windows PowerShell 5.1 i starszych system Windows wyświetla okno dialogowe z monitem o podanie nazwy użytkownika i hasła. W programie PowerShell 6.0 lub nowszym w konsoli jest wyświetlany monit dla wszystkich platform.

Przykłady

Przykład 1

$c = Get-Credential

To polecenie pobiera obiekt poświadczeń i zapisuje go w zmiennej $c.

Po wprowadzeniu polecenia zostanie wyświetlony monit o podanie nazwy użytkownika i hasła. Po wprowadzeniu żądanych informacji polecenie cmdlet tworzy obiekt PSCredential reprezentujący poświadczenia użytkownika i zapisuje go w zmiennej $c.

Możesz użyć obiektu jako danych wejściowych do poleceń cmdlet, które żądają uwierzytelniania użytkownika, takich jak te z parametrem Credential. Jednak niektórzy dostawcy, którzy są instalowani za pomocą programu PowerShell, nie obsługują parametru Credential.

Przykład 2

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

W tym przykładzie zostanie utworzone poświadczenie zawierające nazwę użytkownika bez nazwy domeny.

Pierwsze polecenie pobiera poświadczenie z nazwą użytkownika User01 i zapisuje je w zmiennej $c. Drugie polecenie wyświetla wartość właściwości Username wynikowego obiektu poświadczeń.

Przykład 3

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

To polecenie używa metody PromptForCredential, aby monitować użytkownika o podanie nazwy użytkownika i hasła. Polecenie zapisuje poświadczenia wynikowe w zmiennej $Credential.

Metoda PromptForCredential jest alternatywą dla polecenia cmdlet Get-Credential. W przypadku używania PromptForCredentialmożna określić tytuł, komunikaty i nazwę użytkownika wyświetlaną w oknie dialogowym.

Aby uzyskać więcej informacji, zobacz dokumentację PromptForCredential w zestawie SDK.

Przykład 4

W tym przykładzie pokazano, jak utworzyć obiekt poświadczeń identyczny z obiektem zwróconym przez Get-Credential.

$User = "Domain01\User01"
$PWord = Read-Host -Prompt 'Enter a Password' -AsSecureString
$credentialParams = @{
    TypeName = 'System.Management.Automation.PSCredential'
    ArgumentList = $User, $PWord
}
$Credential = New-Object @credentialParams

Pierwsze polecenie przypisuje nazwę użytkownika do zmiennej $User. Upewnij się, że wartość jest zgodna z formatem "Domain\User" lub "ComputerName\User".

Drugie polecenie używa polecenia cmdlet Read-Host do utworzenia bezpiecznego ciągu na podstawie danych wejściowych użytkownika. Parametr Prompt żąda danych wejściowych użytkownika, a parametr AsSecureString maskuje dane wejściowe i konwertuje go na bezpieczny ciąg.

Trzecie polecenie używa polecenia cmdlet New-Object do utworzenia obiektu PSCredential z wartości przechowywanych w zmiennych $User i $PWord.

Przykład 5

$credentialParams = @{
    Message = "Credential are required for access to the \\Server1\Scripts file share."
    UserName = "Server01\PowerUser"
}
Get-Credential @credentialParams

PowerShell Credential Request
Credential are required for access to the \\Server1\Scripts file share.
Password for user Server01\PowerUser:

To polecenie używa parametrów Message i UserName w poleceniu cmdlet Get-Credential. Ten format polecenia jest przeznaczony dla udostępnionych skryptów i funkcji. W takim przypadku komunikat informuje użytkownika, dlaczego potrzebne są poświadczenia i daje im pewność, że żądanie jest uzasadnione.

Przykład 6

Invoke-Command -ComputerName Server01 -ScriptBlock {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

To polecenie pobiera poświadczenie ze zdalnego komputera Server01. Polecenie używa polecenia cmdlet Invoke-Command do uruchomienia polecenia Get-Credential na komputerze zdalnym. Dane wyjściowe pokazują komunikat zabezpieczeń zdalnych, który Get-Credential zawiera w monicie uwierzytelniania.

Parametry

-Credential

Określa nazwę użytkownika dla poświadczeń, na przykład User01 lub Domain01\User01. Nazwa parametru -Credentialjest opcjonalna.

Po przesłaniu polecenia i określeniu nazwy użytkownika zostanie wyświetlony monit o podanie hasła. Jeśli pominięto ten parametr, zostanie wyświetlony monit o podanie nazwy użytkownika i hasła.

Począwszy od programu PowerShell 3.0, jeśli wprowadzisz nazwę użytkownika bez domeny, Get-Credential nie wstawia już ukośnika odwrotnego przed nazwą.

Poświadczenia są przechowywane w obiekcie PSCredential, a hasło jest przechowywane jako SecureString.

Notatka

Aby uzyskać więcej informacji na temat ochrony danych SecureString, zobacz Jak bezpieczny jest protokół SecureString?.

Typ:PSCredential
Position:1
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Message

Określa komunikat wyświetlany w monicie uwierzytelniania. Ten parametr jest przeznaczony do użycia w funkcji lub skryscie. Możesz użyć komunikatu , aby wyjaśnić użytkownikowi, dlaczego żądasz poświadczeń i jak będą używane.

Ten parametr został wprowadzony w programie PowerShell 3.0.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Title

Ustawia tekst tytułowy dla monitu uwierzytelniania w konsoli.

Ten parametr został wprowadzony w programie PowerShell 6.0.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-UserName

Określa nazwę użytkownika. Monit o uwierzytelnienie żąda hasła dla nazwy użytkownika. Domyślnie nazwa użytkownika jest pusta, a monit o uwierzytelnienie żąda zarówno nazwy użytkownika, jak i hasła.

Ten parametr został wprowadzony w programie PowerShell 3.0.

Typ:String
Position:1
Domyślna wartość:None (blank)
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

None

Nie można potokować obiektów do tego polecenia cmdlet.

Dane wyjściowe

PSCredential

To polecenie cmdlet zwraca obiekt poświadczeń.

Uwagi

Można użyć obiektu PSCredential, który Get-Credential tworzy w poleceniach cmdlet żądających uwierzytelniania użytkowników, takich jak te z parametrem Credential.

Parametr Credential nie jest obsługiwany przez wszystkich dostawców zainstalowanych za pomocą programu PowerShell. Począwszy od programu PowerShell 3.0, jest obsługiwany dla wybranych poleceń cmdlet, takich jak Get-Content i New-PSDrive.