@azure/identity package
Klasy
| AggregateAuthenticationError |
Udostępnia tablicę |
| AuthenticationError |
Zawiera szczegóły dotyczące niepowodzenia uwierzytelnienia w Azure Active Directory. Pole |
| AuthenticationRequiredError |
Błąd używany do wymuszania uwierzytelniania po próbie dyskretnego pobrania tokenu. |
| AuthorizationCodeCredential |
Umożliwia uwierzytelnianie do Microsoft Entra ID za pomocą kodu autoryzacyjnego uzyskanego poprzez przepływ kodu autoryzacyjnego, opisany bardziej szczegółowo w dokumentacji Microsoft Entra ID: https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow |
| AzureCliCredential |
Dane te będą korzystać z aktualnie zalogowanych danych logowania użytkownika za pomocą narzędzia Azure CLI ('az') w wierszu poleceń. Aby to zrobić, odczyta token dostępu użytkownika i wygasa za pomocą polecenia Azure CLI "az account get-access-token". |
| AzureDeveloperCliCredential |
Azure Developer CLI to narzędzie do interfejsu wiersza poleceń, które pozwala deweloperom na tworzenie, zarządzanie i wdrażanie zasobów w Azure. Jest zbudowany na bazie Azure CLI i oferuje dodatkowe funkcje specyficzne dla deweloperów Azure. Pozwala użytkownikom uwierzytelniać się jako użytkownik i/lub jako podmiot usługowy przeciwko Microsoft Entra ID. AzureDeveloperCliCredential uwierzytelnia się w środowisku deweloperskim i pozyskuje token w imieniu zalogowanego użytkownika lub podmiotu usługi w Azure Developer CLI. Działa jako zalogowany użytkownik lub główny użytkownik Azure Developer CLI i wykonuje polecenie Azure CLI poniżej, aby uwierzytelnić aplikację na Microsoft Entra ID. Konfigurowanie elementu AzureDeveloperCliCredentialAby użyć tego poświadczenia, programista musi uwierzytelnić się lokalnie w Azure Developer CLI, korzystając z jednego z poniższych poleceń:
Może być konieczne powtórzenie tego procesu po upływie określonego czasu, w zależności od ważności tokenu odświeżania w organizacji. Zazwyczaj okres ważności tokenu odświeżania wynosi od kilku tygodni do kilku miesięcy. Polecenie AzureDeveloperCliCredential wyświetli monit o ponowne zalogowanie się. |
| AzurePipelinesCredential |
To poświadczenie jest zaprojektowane do użycia w Azure Pipelines z połączeniami usługowymi jako konfiguracja federacji tożsamości obciążenia. |
| AzurePowerShellCredential |
Dane uwierzytelniające będą korzystać z aktualnie zalogowanych danych użytkownika z modułu Azure PowerShell. Aby to zrobić, odczyta token dostępu użytkownika i wygasa Azure PowerShell polecenie |
| ChainedTokenCredential |
Umożliwia wypróbowanie wielu implementacji |
| ClientAssertionCredential |
Uwierzytelnia jednostkę usługi przy użyciu asercji JWT. |
| ClientCertificateCredential |
Umożliwia uwierzytelnianie do Microsoft Entra ID za pomocą certyfikatu zakodowanego przez PEM, który jest przypisany do rejestracji aplikacji. Więcej informacji na temat konfigurowania uwierzytelniania certyfikatów można znaleźć tutaj: |
| ClientSecretCredential |
Umożliwia uwierzytelnianie do Microsoft Entra ID za pomocą sekretu klienta wygenerowanego dla rejestracji aplikacji. Więcej informacji na temat konfigurowania wpisu tajnego klienta można znaleźć tutaj: |
| CredentialUnavailableError |
Oznacza to, że poświadczenia, które zostały wypróbowane w łańcuchowym poświadczeniu, nie były dostępne do użycia jako poświadczenia. Zamiast traktować to jako błąd, który powinien zatrzymać łańcuch, jest złapany, a łańcuch kontynuuje |
| DefaultAzureCredential |
Zapewnia domyślną konfigurację ChainedTokenCredential, która działa w większości aplikacji korzystających z Azure SDK bibliotek klienckich. Aby uzyskać więcej informacji, zobacz Omówienie domyślneAzureCredential. Następujące typy poświadczeń zostaną wypróbowane w następującej kolejności:
Zapoznaj się z dokumentacją tych typów poświadczeń, aby uzyskać więcej informacji na temat sposobu próby uwierzytelnienia. W poniższym przykładzie pokazano, jak używać tej
|
| DeviceCodeCredential |
Umożliwia uwierzytelnianie Microsoft Entra ID za pomocą kodu urządzenia, który użytkownik może wpisać w https://microsoft.com/devicelogin. |
| EnvironmentCredential |
Umożliwia uwierzytelnianie do Microsoft Entra ID za pomocą sekretu klienta lub certyfikatu. |
| InteractiveBrowserCredential |
Umożliwia uwierzytelnianie do Microsoft Entra ID w przeglądarce internetowej za pomocą 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 w maszynach wirtualnych Azure, instancjach App Service, aplikacjach Azure Functions, usługach Azure Kubernetes, instancjach Azure Service Fabric oraz wewnątrz Azure Cloud Shell. Więcej informacji na temat konfigurowania tożsamości zarządzanych można znaleźć tutaj: https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview |
| OnBehalfOfCredential |
Umożliwia uwierzytelnianie Microsoft Entra ID za pomocą On Behalf Of flow. |
| UsernamePasswordCredential |
Umożliwia uwierzytelnianie do Microsoft Entra ID za pomocą nazwy użytkownika i hasła użytkownika. 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 |
Łączy się z Azure za pomocą konta użytkownika zalogowanego przez rozszerzenie Azure Resources w Visual Studio Code. 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. |
| WorkloadIdentityCredential |
Uwierzytelnianie tożsamości obciążenia to funkcja w Azure, która pozwala aplikacjom działającym na maszynach wirtualnych (VM) uzyskać dostęp do innych zasobów Azure bez potrzeby posiadania zasady 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. Pod maską uwierzytelnianie tożsamości obciążenia wykorzystuje koncepcję poświadczeń Account Service (SAC), które są automatycznie tworzone przez Azure i bezpiecznie przechowywane w 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. Dodatkowo, ponieważ SAC-y są tworzone automatycznie i zarządzane przez Azure, nie musisz martwić się o przechowywanie i zabezpieczanie wrażliwych danych uwierzytelniających. Uwierzytelnienie WorkloadIdentityCredential obsługuje uwierzytelnianie Tożsamość obciążeń Microsoft Entra w Azure Kubernetes i pozyskuje token za pomocą SAC-ów dostępnych w środowisku Azure Kubernetes. Więcej informacji można znaleźć w 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 AuthenticationRequiredError |
| AuthorityValidationOptions |
Oferuje opcje konfiguracji, jak biblioteka tożsamości waliduje autorytet podczas żądań uwierzytelniania do Microsoft Entra ID. |
| AuthorizationCodeCredentialOptions | |
| AzureCliCredentialOptions |
Opcje AzureCliCredential |
| AzureDeveloperCliCredentialOptions | |
| AzurePipelinesCredentialOptions |
Opcjonalne parametry dla klasy AzurePipelinesCredential. |
| AzurePowerShellCredentialOptions | |
| BrokerAuthOptions |
Opcje konfiguracji interactiveBrowserCredential do obsługi uwierzytelniania brokera WAM. |
| BrokerDisabledOptions |
Parametry, gdy uwierzytelnianie brokera WAM jest wyłączone. |
| BrokerEnabledOptions |
Parametry po włączeniu uwierzytelniania brokera WAM. |
| BrowserCustomizationOptions |
Opcje konfiguracji udostępnionej dla dostosowywania przeglądarki |
| ClientAssertionCredentialOptions | |
| ClientCertificateCredentialOptions |
Opcjonalne parametry klasy ClientCertificateCredential. |
| ClientCertificatePEMCertificate |
Wymagane opcje konfiguracji dla ClientCertificateCredentialz zawartością ciągu certyfikatu PEM |
| ClientCertificatePEMCertificatePath |
Wymagane opcje konfiguracji dla ClientCertificateCredential, ze ścieżką do certyfikatu PEM. |
| ClientSecretCredentialOptions |
Opcjonalne parametry klasy ClientSecretCredential. |
| CredentialPersistenceOptions |
Udostępnione opcje konfiguracji dla poświadczeń, które obsługują trwałe buforowanie tokenów. |
| DefaultAzureCredentialClientIdOptions |
Udostępnia opcje konfigurowania klasy DefaultAzureCredential.
Ta odmiana obsługuje |
| DefaultAzureCredentialOptions |
Udostępnia opcje konfigurowania klasy DefaultAzureCredential. |
| DefaultAzureCredentialResourceIdOptions |
Udostępnia opcje konfigurowania klasy DefaultAzureCredential.
Ta odmiana obsługuje |
| DeviceCodeCredentialOptions |
Definiuje opcje dla 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ę zawierającą te szczegóły. |
| EnvironmentCredentialOptions |
Umożliwia uwierzytelnianie do Microsoft Entra ID w zależności od dostępnych zmiennych środowiskowych. Definiuje opcje dla klasy EnvironmentCredential. |
| ErrorResponse |
Aby uzyskać więcej informacji, zobacz oficjalną dokumentację: https://learn.microsoft.com/azure/active-directory/develop/v1-protocols-oauth-code#error-response-1 UWAGA: Ta dokumentacja dotyczy obsługi protokołu OAuth w wersji 1, ale te same szczegóły odpowiedzi na błędy nadal dotyczą wersji 2. |
| GetBearerTokenProviderOptions |
Opcje konfigurowania dostawcy tokenów. |
| GetTokenOptions |
Definiuje opcje tokenCredential.getToken. |
| InteractiveBrowserCredentialInBrowserOptions |
Definiuje typowe opcje dla klasy InteractiveBrowserCredential. |
| InteractiveBrowserCredentialNodeOptions |
Definiuje typowe opcje dla 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 obsługuje |
| ManagedIdentityCredentialObjectIdOptions |
Opcje wysyłania w konstruktorze ManagedIdentityCredential.
Ta odmiana obsługuje |
| ManagedIdentityCredentialResourceIdOptions |
Opcje wysyłania w konstruktorze ManagedIdentityCredential.
Ta odmiana obsługuje |
| MultiTenantTokenCredentialOptions |
Opcje dla aplikacji wielodostępnych, które umożliwiają korzystanie z dodatkowych dozwolonych dzierżaw. |
| OnBehalfOfCredentialAssertionOptions |
Definiuje parametry do uwierzytelniania OnBehalfOfCredential z asercją. |
| OnBehalfOfCredentialCertificateOptions |
Definiuje parametry do uwierzytelniania OnBehalfOfCredential przy użyciu certyfikatu. |
| OnBehalfOfCredentialSecretOptions |
Definiuje parametry do uwierzytelniania OnBehalfOfCredential za pomocą wpisu tajnego. |
| TokenCachePersistenceOptions |
Parametry, które umożliwiają trwałość pamięci podręcznej tokenu w poświadczeniach tożsamości. |
| TokenCredential |
Reprezentuje poświadczenie, które może zapewnić token uwierzytelniania. |
| TokenCredentialOptions |
Oferuje opcje konfiguracji, jak biblioteka tożsamości wysyła żądania uwierzytelniania do Microsoft Entra ID. |
| UsernamePasswordCredentialOptions |
Definiuje opcje dla klasy UsernamePasswordCredential. |
| VisualStudioCodeCredentialOptions |
Oferuje opcje konfiguracji poświadczenia Visual Studio Code. |
| WorkloadIdentityCredentialOptions |
Aliasy typu
| BrokerOptions |
Parametry, które umożliwiają uwierzytelnianie brokera WAM w InteractiveBrowserCredential. |
| BrowserLoginStyle |
(Funkcja tylko w przeglądarce) Styl logowania do użycia w przepływie uwierzytelniania:
|
| ClientCertificateCredentialPEMConfiguration |
Wymagane opcje konfiguracji dla ClientCertificateCredential, z zawartością ciągu certyfikatu PEM lub ścieżką do certyfikatu PEM. |
| DefaultAzureCredentialEnvVars |
Często obsługiwane zmienne środowiskowe dla klasy DefaultAzureCredential . |
| DeviceCodePromptCallback |
Definiuje podpis wywołania zwrotnego, który zostanie przekazany do elementu DeviceCodeCredential na potrzeby wyświetlania szczegółów uwierzytelniania użytkownikowi. |
| IdentityPlugin |
Typ wtyczki Azure Identity, czyli funkcji akceptującej kontekst wtyczki. |
| OnBehalfOfCredentialOptions |
Opcjonalne parametry klasy OnBehalfOfCredential. |
Wyliczenia
| AzureAuthorityHosts |
Lista znanych hostów Azure authority |
Funkcje
| deserialize |
Deserializuje wcześniej serializowany rekord uwierzytelniania z ciągu do obiektu. Ciąg wejściowy musi zawierać następujące właściwości:
Jeśli otrzymana wersja nie jest obsługiwana, zostanie zgłoszony błąd. W tej chwili jedyną dostępną wersją jest: "1.0", która jest zawsze ustawiana po serializacji rekordu uwierzytelniania. |
| get |
Zwraca wywołanie zwrotne, które zapewnia token elementu nośnego. Na przykład token elementu nośnego może służyć do uwierzytelniania żądania w następujący sposób:
|
| get |
Zwraca nowe wystąpienie DefaultAzureCredential. |
| serialize |
Serializuje Dane wyjściowe zserializowanego rekordu uwierzytelniania będą zawierać następujące właściwości:
Aby później przekonwertować ten ciąg na serializowany |
| use |
Rozszerzenie Azure Identity o dodatkowe funkcje. Przekaż wtyczkę z pakietu wtyczki, na przykład:
Przykład:
|
Zmienne
| Aggregate |
Wartość Error.name błędu AggregateAuthenticationError |
| Authentication |
Wartość Error.name błędu uwierzytelniania |
| Credential |
Wartość Error.name poświadczeniaNiedostępne |
| logger | AzureLogger używany dla wszystkich klientów w ramach pakietu tożsamości |
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" (identyfikator konta domowego)
- "clientId" (identyfikator klienta)
- "tenantId" (identyfikator dzierżawy)
- "nazwa użytkownika"
- "wersja"
Jeśli otrzymana wersja nie jest obsługiwana, zostanie zgłoszony błąd.
W tej chwili 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 wcześniej serializowany w ciąg.
Zwraca
UwierzytelnianieRekord.
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)
Zwraca wywołanie zwrotne, które zapewnia token elementu nośnego. Na przykład token elementu nośnego może służyć do uwierzytelniania żądania w następujący sposób:
import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
import { createPipelineRequest } from "@azure/core-rest-pipeline";
const credential = new DefaultAzureCredential();
const scope = "https://cognitiveservices.azure.com/.default";
const getAccessToken = getBearerTokenProvider(credential, scope);
const token = await getAccessToken();
// usage
const request = createPipelineRequest({ url: "https://example.com" });
request.headers.set("Authorization", `Bearer ${token}`);
function getBearerTokenProvider(credential: TokenCredential, scopes: string | string[], options?: GetBearerTokenProviderOptions): () => Promise<string>
Parametry
- credential
- TokenCredential
Poświadczenie używane do uwierzytelniania żądania.
- scopes
-
string | string[]
Zakresy wymagane dla tokenu elementu nośnego.
- options
- GetBearerTokenProviderOptions
Opcje konfigurowania dostawcy tokenów.
Zwraca
() => Promise<string>
wywołanie zwrotne, które zapewnia token elementu nośnego.
getDefaultAzureCredential()
Zwraca nowe wystąpienie DefaultAzureCredential.
function getDefaultAzureCredential(): TokenCredential
Zwraca
serializeAuthenticationRecord(AuthenticationRecord)
Serializuje AuthenticationRecord w ciągu.
Dane wyjściowe zserializowanego rekordu uwierzytelniania będą zawierać następujące właściwości:
- "urząd"
- "homeAccountId" (identyfikator konta domowego)
- "clientId" (identyfikator klienta)
- "tenantId" (identyfikator dzierżawy)
- "nazwa użytkownika"
- "wersja"
Aby później przekonwertować ten ciąg na serializowany AuthenticationRecord, użyj wyeksportowanej funkcji deserializeAuthenticationRecord().
function serializeAuthenticationRecord(record: AuthenticationRecord): string
Parametry
- record
- AuthenticationRecord
Zwraca
string
useIdentityPlugin(IdentityPlugin)
Rozszerzenie Azure Identity o dodatkowe funkcje. Przekaż wtyczkę z pakietu wtyczki, na przykład:
-
@azure/identity-cache-persistence: zapewnia trwałe buforowanie tokenów -
@azure/identity-vscode: zapewnia zależnościVisualStudioCodeCredentiali włącza je
Przykład:
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);
// The plugin has the capability to extend `DeviceCodeCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DeviceCodeCredential({
tokenCachePersistenceOptions: {
enabled: true,
},
});
function useIdentityPlugin(plugin: IdentityPlugin)
Parametry
- plugin
- IdentityPlugin
wtyczka do zarejestrowania
Szczegóły zmiennej
AggregateAuthenticationErrorName
Wartość Error.name błędu AggregateAuthenticationError
AggregateAuthenticationErrorName: "AggregateAuthenticationError"
Typ
"AggregateAuthenticationError"
AuthenticationErrorName
Wartość Error.name błędu uwierzytelniania
AuthenticationErrorName: "AuthenticationError"
Typ
"AuthenticationError"
CredentialUnavailableErrorName
Wartość Error.name poświadczeniaNiedostępne
CredentialUnavailableErrorName: "CredentialUnavailableError"
Typ
"CredentialUnavailableError"
logger
AzureLogger używany dla wszystkich klientów w ramach pakietu tożsamości
logger: AzureLogger