@azure/identity package

  • Odwołanie

Klasy

AggregateAuthenticationError

Udostępnia tablicę zawierającą errors wystąpienie authenticationError dla niepowodzeń uwierzytelniania z poświadczeń w elemecie ChainedTokenCredential.
AuthenticationError

Zawiera szczegółowe informacje o niepowodzeniu uwierzytelniania w usłudze Azure Active Directory. Pole errorResponse zawiera więcej szczegółów na temat konkretnego błędu.
AuthenticationRequiredError

Błąd używany do wymuszania uwierzytelniania po próbie dyskretnego pobrania tokenu.
AuthorizationCodeCredential

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu kodu autoryzacji uzyskanego za pośrednictwem przepływu kodu autoryzacji, opisanego bardziej szczegółowo w dokumentacji Tożsamość Microsoft Entra:

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
AzureCliCredential

To poświadczenie będzie używać aktualnie zalogowanych informacji logowania użytkownika za pośrednictwem narzędzia wiersza polecenia platformy Azure (az'). W tym celu odczytuje token dostępu użytkownika i wygaśnie czas za pomocą polecenia interfejsu wiersza polecenia platformy Azure "az account get-access-token".
AzureDeveloperCliCredential

Azure Developer CLI to narzędzie interfejsu wiersza polecenia, które umożliwia deweloperom tworzenie i wdrażanie zasobów na platformie Azure oraz zarządzanie nimi. Jest ona oparta na interfejsie wiersza polecenia platformy Azure i udostępnia dodatkowe funkcje specyficzne dla deweloperów platformy Azure. Umożliwia ona użytkownikom uwierzytelnianie się jako użytkownik i/lub jednostka usługi względem Tożsamość Microsoft Entra. Usługa AzureDeveloperCliCredential uwierzytelnia się w środowisku deweloperów i uzyskuje token w imieniu zalogowanego użytkownika lub jednostki usługi w Azure Developer CLI. Działa ona jako Azure Developer CLI zalogowana użytkownik lub jednostka usługi i wykonuje polecenie interfejsu wiersza polecenia platformy Azure pod spodem w celu uwierzytelnienia aplikacji w Tożsamość Microsoft Entra.

Konfigurowanie elementu AzureDeveloperCliCredential

Aby użyć tego poświadczenia, deweloper musi uwierzytelnić się lokalnie w Azure Developer CLI przy użyciu jednego z poniższych poleceń:

  1. Uruchom polecenie "azd auth login" w Azure Developer CLI, aby uwierzytelnić się interaktywnie jako użytkownik.
  2. Uruchom polecenie "azd auth login --client-id clientID-client-secret clientSecret --tenant-id tenantID", aby uwierzytelnić się jako jednostka usługi.

Może być konieczne powtórzenie tego procesu po pewnym czasie, w zależności od ważności tokenu odświeżania w organizacji. Ogólnie rzecz biorąc, okres ważności tokenu odświeżania wynosi od kilku tygodni do kilku miesięcy. AzureDeveloperCliCredential wyświetli monit o ponowne zalogowanie się.
AzurePowerShellCredential

To poświadczenie będzie używać aktualnie zalogowanych informacji o użytkowniku z modułu Azure PowerShell. W tym celu odczytuje token dostępu użytkownika i wygaśnie czas za pomocą polecenia Azure PowerShellGet-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

Umożliwia wypróbowanie wielu TokenCredential implementacji, dopóki jedna z metod getToken nie zwróci tokenu dostępu.
ClientAssertionCredential

Uwierzytelnia jednostkę usługi przy użyciu asercji JWT.
ClientCertificateCredential

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu certyfikatu zakodowanego za pomocą protokołu PEM przypisanego do rejestracji aplikacji. Więcej informacji na temat konfigurowania uwierzytelniania certyfikatów można znaleźć tutaj:

https://learn.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad
ClientSecretCredential

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu klucza tajnego klienta wygenerowanego na potrzeby rejestracji aplikacji. Więcej informacji na temat konfigurowania wpisu tajnego klienta można znaleźć tutaj:

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application
CredentialUnavailableError

Oznacza to, że poświadczenie, które zostało wypróbowane w łańcuchowym poświadczeniu, nie było dostępne do użycia jako poświadczenie. Zamiast traktować to jako błąd, który powinien zatrzymać łańcuch, jest złapany, a łańcuch kontynuuje
DefaultAzureCredential

Udostępnia domyślną konfigurację ChainedTokenCredential , która powinna działać dla większości aplikacji korzystających z zestawu Azure SDK.
DeviceCodeCredential

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu kodu urządzenia, który użytkownik może wprowadzić w https://microsoft.com/deviceloginpliku .
EnvironmentCredential

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu klucza tajnego klienta lub certyfikatu albo jako użytkownik z nazwą użytkownika i hasłem.
InteractiveBrowserCredential

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra wewnątrz przeglądarki internetowej przy użyciu interaktywnego przepływu logowania.
ManagedIdentityCredential

Podejmuje próbę uwierzytelnienia przy użyciu tożsamości zarządzanej dostępnej w środowisku wdrażania. Ten typ uwierzytelniania działa na maszynach wirtualnych platformy Azure, wystąpieniach App Service, aplikacjach Azure Functions, usługach Azure Kubernetes Services, wystąpieniach usługi Azure Service Fabric i wewnątrz Cloud Shell Azure.

Więcej informacji na temat konfigurowania tożsamości zarządzanych można znaleźć tutaj: https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
OnBehalfOfCredential

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu przepływu w imieniu.
UsernamePasswordCredential

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu nazwy użytkownika i hasła. To poświadczenie wymaga wysokiego stopnia zaufania, dlatego należy używać go tylko wtedy, gdy nie można używać innych, bezpieczniejszych typów poświadczeń.
VisualStudioCodeCredential

Nawiązuje połączenie z platformą Azure przy użyciu poświadczeń dostarczonych przez rozszerzenie VSCode "Konto platformy Azure". Po zalogowaniu się użytkownika za pośrednictwem rozszerzenia to poświadczenie może współużytkować ten sam token odświeżania, który jest buforowany przez rozszerzenie.

Znany jest problem polegający na tym, że to poświadczenie nie działa z rozszerzeniami konta platformy Azure nowszymi niż 0.9.11. Długoterminowe rozwiązanie tego problemu jest w toku. W międzyczasie rozważ uwierzytelnianie za pomocą usługi AzureCliCredential.
WorkloadIdentityCredential

Uwierzytelnianie tożsamości obciążenia to funkcja platformy Azure, która umożliwia aplikacjom działającym na maszynach wirtualnych dostęp do innych zasobów platformy Azure bez konieczności posiadania jednostki usługi lub tożsamości zarządzanej. W przypadku uwierzytelniania tożsamości obciążenia aplikacje uwierzytelniają się przy użyciu własnej tożsamości, a nie przy użyciu jednostki usługi udostępnionej lub tożsamości zarządzanej. W ramach programu uwierzytelnianie tożsamości obciążenia używa koncepcji poświadczeń konta usługi (SACs), które są automatycznie tworzone przez platformę Azure i przechowywane bezpiecznie na maszynie wirtualnej. Korzystając z uwierzytelniania tożsamości obciążenia, można uniknąć konieczności zarządzania jednostkami usługi lub tożsamościami zarządzanymi dla każdej aplikacji na każdej maszynie wirtualnej i obracać je. Ponadto, ponieważ kontrolery SAC są tworzone automatycznie i zarządzane przez platformę Azure, nie musisz martwić się o przechowywanie i zabezpieczanie poufnych poświadczeń. Element WorkloadIdentityCredential obsługuje uwierzytelnianie Tożsamość obciążeń Microsoft Entra na platformie Azure Kubernetes i uzyskuje token przy użyciu kontrolerów SAC dostępnych w środowisku usługi Azure Kubernetes. Aby uzyskać więcej informacji, zobacz Tożsamość obciążeń Microsoft Entra.

Interfejsy

AccessToken

Reprezentuje token dostępu z czasem wygaśnięcia.
AuthenticationRecord

Rekord używany do znajdowania buforowanych tokenów w pamięci podręcznej.
AuthenticationRequiredErrorOptions

Opcjonalne parametry uwierzytelnianiaRequiredError
AuthorityValidationOptions

Udostępnia opcje konfigurowania sposobu sprawdzania poprawności przez bibliotekę tożsamości podczas żądań uwierzytelniania w celu Tożsamość Microsoft Entra.
AuthorizationCodeCredentialOptions

Opcje dla obiektu AuthorizationCodeCredential
AzureCliCredentialOptions

Opcje dla obiektu AzureCliCredential
AzureDeveloperCliCredentialOptions

Opcje dla elementu AzureDeveloperCliCredential
AzurePowerShellCredentialOptions

Opcje dla obiektu AzurePowerShellCredential
BrokerAuthOptions

Opcje konfiguracji interactiveBrowserCredential do obsługi uwierzytelniania brokera WAM.
BrokerDisabledOptions

Parametry, gdy uwierzytelnianie brokera WAM jest wyłączone.
BrokerEnabledOptions

Parametry, gdy jest włączone uwierzytelnianie brokera WAM.
BrowserCustomizationOptions

Opcje konfiguracji udostępnionej dla dostosowywania przeglądarki
ClientAssertionCredentialOptions

Opcje dla obiektu ClientAssertionCredential
ClientCertificateCredentialOptions

Opcjonalne parametry klasy ClientCertificateCredential .
ClientCertificatePEMCertificate

Wymagane opcje konfiguracji dla klasy ClientCertificateCredential z zawartością ciągu certyfikatu PEM
ClientCertificatePEMCertificatePath

Wymagane opcje konfiguracji klientaCertificateCredential ze ścieżką do certyfikatu PEM.
ClientSecretCredentialOptions

Opcjonalne parametry klasy ClientSecretCredential .
CredentialPersistenceOptions

Opcje konfiguracji udostępnionej dla poświadczeń, które obsługują trwałe buforowanie tokenów.
DefaultAzureCredentialClientIdOptions

Udostępnia opcje konfigurowania klasy DefaultAzureCredential . Ta odmiana jest obsługiwana managedIdentityClientId , a nie managedIdentityResourceId, ponieważ obsługiwana jest tylko jedna z obu opcji.
DefaultAzureCredentialOptions

Udostępnia opcje konfigurowania klasy DefaultAzureCredential .
DefaultAzureCredentialResourceIdOptions

Udostępnia opcje konfigurowania klasy DefaultAzureCredential . Ta odmiana jest obsługiwana managedIdentityResourceId , a nie managedIdentityClientId, ponieważ obsługiwana jest tylko jedna z obu opcji.
DeviceCodeCredentialOptions

Definiuje opcje klasy InteractiveBrowserCredential dla Node.js.
DeviceCodeInfo

Udostępnia kod użytkownika i identyfikator URI weryfikacji, w którym należy wprowadzić kod. Zawiera również komunikat wyświetlany użytkownikowi, który zawiera instrukcję z tymi szczegółami.
EnvironmentCredentialOptions

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra w zależności od dostępnych zmiennych środowiskowych. Definiuje opcje klasy EnvironmentCredential.
ErrorResponse

Aby uzyskać więcej informacji, zobacz oficjalną dokumentację:

https://learn.microsoft.com/en-us/azure/active-directory/develop/v1-protocols-oauth-code#error-response-1

UWAGA: Ta dokumentacja jest przeznaczona dla obsługi protokołu OAuth w wersji 1, ale te same szczegóły odpowiedzi na błędy nadal dotyczą wersji 2.
GetTokenOptions

Definiuje opcje tokenCredential.getToken.
InteractiveBrowserCredentialInBrowserOptions

Definiuje typowe opcje klasy InteractiveBrowserCredential.
InteractiveBrowserCredentialNodeOptions

Definiuje typowe opcje klasy InteractiveBrowserCredential.
InteractiveCredentialOptions

Typowe opcje konstruktora dla poświadczeń tożsamości, które wymagają interakcji użytkownika.
ManagedIdentityCredentialClientIdOptions

Opcje wysyłania w konstruktorze ManagedIdentityCredential . Ta odmiana jest obsługiwana clientId , a nie resourceId, ponieważ obsługiwana jest tylko jedna z obu opcji.
ManagedIdentityCredentialResourceIdOptions

Opcje wysyłania w konstruktorze ManagedIdentityCredential . Ta odmiana jest obsługiwana resourceId , a nie clientId, ponieważ obsługiwana jest tylko jedna z obu opcji.
MultiTenantTokenCredentialOptions

Opcje aplikacji z wieloma dzierżawami, które umożliwiają korzystanie z dodatkowych dozwolonych dzierżaw.
OnBehalfOfCredentialCertificateOptions

Definiuje parametry do uwierzytelniania onBehalfOfCredential przy użyciu certyfikatu.
OnBehalfOfCredentialSecretOptions

Definiuje parametry do uwierzytelnienia obiektu OnBehalfOfCredential przy użyciu wpisu tajnego.
TokenCachePersistenceOptions

Parametry, które umożliwiają trwałość pamięci podręcznej tokenów w poświadczeniach tożsamości.
TokenCredential

Reprezentuje poświadczenie, które może zapewnić token uwierzytelniania.
TokenCredentialOptions

Zawiera opcje konfigurowania sposobu, w jaki biblioteka tożsamości wysyła żądania uwierzytelniania do Tożsamość Microsoft Entra.
UsernamePasswordCredentialOptions

Definiuje opcje dla klasy UsernamePasswordCredential .
VisualStudioCodeCredentialOptions

Udostępnia opcje konfigurowania poświadczeń Visual Studio Code.
WorkloadIdentityCredentialOptions

Opcje dla obiektu WorkloadIdentityCredential

Aliasy typu

BrokerOptions

Parametry, które umożliwiają uwierzytelnianie brokera WAM w pliku InteractiveBrowserCredential.
BrowserLoginStyle

(Funkcja tylko w przeglądarce) Styl logowania do użycia w przepływie uwierzytelniania:

  • "przekierowanie" przekierowuje użytkownika do strony uwierzytelniania, a następnie przekierowuje je z powrotem do strony po zakończeniu uwierzytelniania.
  • Polecenie "popup" otwiera nowe okno przeglądarki za pomocą zainicjowanego przepływu przekierowania. Istniejące okno przeglądarki użytkownika nie pozostawia bieżącej strony
ClientCertificateCredentialPEMConfiguration

Wymagane opcje konfiguracji klientaCertificateCredential z zawartością ciągu certyfikatu PEM lub ścieżką do certyfikatu PEM.
DeviceCodePromptCallback

Definiuje podpis wywołania zwrotnego, który zostanie przekazany do elementu DeviceCodeCredential w celu wyświetlenia szczegółów uwierzytelniania użytkownikowi.
IdentityPlugin

Typ wtyczki azure Identity, funkcja akceptująca kontekst wtyczki.
OnBehalfOfCredentialOptions

Opcjonalne parametry klasy OnBehalfOfCredential .

Wyliczenia

AzureAuthorityHosts

Lista znanych hostów urzędu platformy Azure

Funkcje

deserializeAuthenticationRecord(string)

Deserializuje wcześniej serializowany rekord uwierzytelniania z ciągu do obiektu.

Ciąg wejściowy musi zawierać następujące właściwości:

  • "urząd"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "nazwa użytkownika"
  • "version" (wersja)

Jeśli otrzymana wersja nie jest obsługiwana, zostanie zgłoszony błąd.

Obecnie jedyną dostępną wersją jest: "1.0", która jest zawsze ustawiana po serializacji rekordu uwierzytelniania.
getDefaultAzureCredential()

Zwraca nowe wystąpienie wartości DefaultAzureCredential.
serializeAuthenticationRecord(AuthenticationRecord)

Serializuje element AuthenticationRecord w ciągu.

Dane wyjściowe rekordu uwierzytelniania serializowanego będą zawierać następujące właściwości:

  • "urząd"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "nazwa użytkownika"
  • "version" (wersja)

Aby później przekonwertować ten ciąg na serializacji AuthenticationRecord, użyj wyeksportowanej funkcji deserializeAuthenticationRecord().
useIdentityPlugin(IdentityPlugin)

Rozszerzanie tożsamości platformy Azure przy użyciu dodatkowych funkcji. Przekaż wtyczkę z pakietu wtyczki, na przykład:

  • @azure/identity-cache-persistence: zapewnia trwałe buforowanie tokenów
  • @azure/identity-vscode: udostępnia zależności VisualStudioCodeCredential i włącza je

Przykład:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

// The plugin has the capability to extend `DefaultAzureCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DefaultAzureCredential({
  tokenCachePersistenceOptions: {
    enabled: true
  }
});

Szczegóły funkcji

deserializeAuthenticationRecord(string)

Deserializuje wcześniej serializowany rekord uwierzytelniania z ciągu do obiektu.

Ciąg wejściowy musi zawierać następujące właściwości:

  • "urząd"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "nazwa użytkownika"
  • "version" (wersja)

Jeśli otrzymana wersja nie jest obsługiwana, zostanie zgłoszony błąd.

Obecnie jedyną dostępną wersją jest: "1.0", która jest zawsze ustawiana po serializacji rekordu uwierzytelniania.

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Parametry

serializedRecord

string

Rekord uwierzytelniania został wcześniej serializowany w ciąg.

Zwraca

AuthenticationRecord

AuthenticationRecord.

getDefaultAzureCredential()

Zwraca nowe wystąpienie wartości DefaultAzureCredential.

function getDefaultAzureCredential(): TokenCredential

Zwraca

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Serializuje element AuthenticationRecord w ciągu.

Dane wyjściowe rekordu uwierzytelniania serializowanego będą zawierać następujące właściwości:

  • "urząd"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "nazwa użytkownika"
  • "version" (wersja)

Aby później przekonwertować ten ciąg na serializacji AuthenticationRecord, użyj wyeksportowanej funkcji deserializeAuthenticationRecord().

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Parametry

record
AuthenticationRecord

Zwraca

string

useIdentityPlugin(IdentityPlugin)

Rozszerzanie tożsamości platformy Azure przy użyciu dodatkowych funkcji. Przekaż wtyczkę z pakietu wtyczki, na przykład:

  • @azure/identity-cache-persistence: zapewnia trwałe buforowanie tokenów
  • @azure/identity-vscode: udostępnia zależności VisualStudioCodeCredential i włącza je

Przykład:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

// The plugin has the capability to extend `DefaultAzureCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DefaultAzureCredential({
  tokenCachePersistenceOptions: {
    enabled: true
  }
});

function useIdentityPlugin(plugin: IdentityPlugin)

Parametry

plugin
IdentityPlugin

wtyczka do zarejestrowania