Udostępnij za pośrednictwem


EnvironmentCredential class

Umożliwia uwierzytelnianie w usłudze Microsoft Entra ID przy użyciu klucza tajnego klienta lub certyfikatu albo jako użytkownik z nazwą użytkownika i hasłem.

Konstruktory

EnvironmentCredential(EnvironmentCredentialOptions)

Tworzy wystąpienie klasy EnvironmentCredential i decyduje o użyciu poświadczeń w zależności od dostępnych zmiennych środowiskowych.

Wymagane zmienne środowiskowe:

  • AZURE_TENANT_ID: identyfikator dzierżawy (katalogu) firmy Microsoft.
  • AZURE_CLIENT_ID: identyfikator klienta (aplikacji) rejestracji aplikacji w dzierżawie.

Jeśli ustawisz AZURE_TENANT_ID, możesz również ustawić dodatkowo dozwolone dzierżawy

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: w przypadku aplikacji wielodostępnych określa dodatkowe dzierżawy, dla których poświadczenia mogą uzyskiwać tokeny z pojedynczym ciągiem rozdzielanym średnikami. Użyj * , aby zezwolić na wszystkie dzierżawy.

Zmienne środowiskowe używane do uwierzytelniania poświadczeń klienta:

  • AZURE_CLIENT_SECRET: wpis tajny klienta wygenerowany na potrzeby rejestracji aplikacji.
  • AZURE_CLIENT_CERTIFICATE_PATH: ścieżka do certyfikatu PEM do użycia podczas uwierzytelniania zamiast klucza tajnego klienta.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (opcjonalnie) hasło do pliku certyfikatu.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (opcjonalnie) wskazuje, że łańcuch certyfikatów powinien być ustawiony w nagłówku x5c w celu obsługi uwierzytelniania opartego na nazwie podmiotu/wystawcy.

Alternatywnie użytkownicy mogą udostępniać zmienne środowiskowe na potrzeby uwierzytelniania nazwy użytkownika i hasła:

  • AZURE_USERNAME: nazwa użytkownika do uwierzytelnienia.
  • AZURE_PASSWORD: hasło do uwierzytelniania za pomocą.

Jeśli brakuje zmiennych środowiskowych wymaganych do przeprowadzenia uwierzytelniania, zostanie zgłoszony CredentialUnavailableError. Jeśli uwierzytelnianie zakończy się niepowodzeniem lub wystąpi nieznany błąd, zostanie zgłoszony błąd AuthenticationError.

Metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu identyfikatora Entra firmy Microsoft i zwraca token dostępu, jeśli się powiedzie.

Szczegóły konstruktora

EnvironmentCredential(EnvironmentCredentialOptions)

Tworzy wystąpienie klasy EnvironmentCredential i decyduje o użyciu poświadczeń w zależności od dostępnych zmiennych środowiskowych.

Wymagane zmienne środowiskowe:

  • AZURE_TENANT_ID: identyfikator dzierżawy (katalogu) firmy Microsoft.
  • AZURE_CLIENT_ID: identyfikator klienta (aplikacji) rejestracji aplikacji w dzierżawie.

Jeśli ustawisz AZURE_TENANT_ID, możesz również ustawić dodatkowo dozwolone dzierżawy

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: w przypadku aplikacji wielodostępnych określa dodatkowe dzierżawy, dla których poświadczenia mogą uzyskiwać tokeny z pojedynczym ciągiem rozdzielanym średnikami. Użyj * , aby zezwolić na wszystkie dzierżawy.

Zmienne środowiskowe używane do uwierzytelniania poświadczeń klienta:

  • AZURE_CLIENT_SECRET: wpis tajny klienta wygenerowany na potrzeby rejestracji aplikacji.
  • AZURE_CLIENT_CERTIFICATE_PATH: ścieżka do certyfikatu PEM do użycia podczas uwierzytelniania zamiast klucza tajnego klienta.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (opcjonalnie) hasło do pliku certyfikatu.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (opcjonalnie) wskazuje, że łańcuch certyfikatów powinien być ustawiony w nagłówku x5c w celu obsługi uwierzytelniania opartego na nazwie podmiotu/wystawcy.

Alternatywnie użytkownicy mogą udostępniać zmienne środowiskowe na potrzeby uwierzytelniania nazwy użytkownika i hasła:

  • AZURE_USERNAME: nazwa użytkownika do uwierzytelnienia.
  • AZURE_PASSWORD: hasło do uwierzytelniania za pomocą.

Jeśli brakuje zmiennych środowiskowych wymaganych do przeprowadzenia uwierzytelniania, zostanie zgłoszony CredentialUnavailableError. Jeśli uwierzytelnianie zakończy się niepowodzeniem lub wystąpi nieznany błąd, zostanie zgłoszony błąd AuthenticationError.

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Parametry

options
EnvironmentCredentialOptions

Opcje konfigurowania klienta, który wysyła żądanie uwierzytelniania.

Szczegóły metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu identyfikatora Entra firmy Microsoft i zwraca token dostępu, jeśli się powiedzie.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Parametry

scopes

string | string[]

Lista zakresów, dla których token będzie miał dostęp.

options
GetTokenOptions

Parametry opcjonalne. Zobacz GetTokenOptions.

Zwraca

Promise<AccessToken>