Sdílet prostřednictvím

@azure/identity package

  • Reference

Třídy

AggregateAuthenticationError

Poskytuje pole errors obsahující instanci AuthenticationError pro chyby ověřování z přihlašovacích údajů v ChainedTokenCredential.
AuthenticationError

Poskytuje podrobnosti o selhání ověřování v Azure Active Directory. Pole errorResponse obsahuje další podrobnosti o konkrétním selhání.
AuthenticationRequiredError

Chyba použitá k vynucení ověřování po pokusu o načtení tokenu bezobslužně
AuthorizationCodeCredential

Umožňuje ověřování pro Microsoft Entra ID pomocí autorizačního kódu získaného prostřednictvím toku autorizačního kódu, který je podrobněji popsán v dokumentaci k Microsoft Entra ID:

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

Tyto přihlašovací údaje budou používat aktuálně přihlášené přihlašovací údaje uživatele prostřednictvím nástroje příkazového řádku Azure CLI ('az'). Provedete to tak, že načte přístupový token uživatele a vyprší čas pomocí příkazu Azure CLI az account get-access-token.
AzureDeveloperCliCredential

Azure Developer CLI je nástroj pro rozhraní příkazového řádku, který vývojářům umožňuje vytvářet, spravovat a nasazovat prostředky v Azure. Je postavená na Azure CLI a poskytuje další funkce specifické pro vývojáře Azure. Umožňuje uživatelům ověřovat jako uživatele nebo instanční objekt pro Microsoft Entra ID. AzureDeveloperCliCredential se ověřuje ve vývojovém prostředí a získává token jménem přihlášeného uživatele nebo instančního objektu v Azure Developer CLI. Funguje jako Azure Developer CLI přihlášený k uživateli nebo instančnímu objektu a spustí příkaz Rozhraní příkazového řádku Azure, pod který ověří aplikaci na základě ID Microsoft Entra.

Konfigurace AzureDeveloperCliCredential

Pokud chcete použít tyto přihlašovací údaje, musí se vývojář ověřit místně v Azure Developer CLI pomocí jednoho z následujících příkazů:

  1. Spusťte v Azure Developer CLI přihlašovací údaje "azd auth", abyste se mohli interaktivně ověřovat jako uživatel.
  2. Spuštěním příkazu azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID ověřte jako instanční objekt.

Tento proces možná budete muset opakovat po určitém časovém období v závislosti na platnosti obnovovacího tokenu ve vaší organizaci. Obecně platí, že doba platnosti obnovovacího tokenu je několik týdnů až několik měsíců. AzureDeveloperCliCredential vás vyzve k opětovnému přihlášení.
AzurePipelinesCredential

Tyto přihlašovací údaje jsou navržené tak, aby se používaly ve službě Azure Pipelines s připojeními služeb jako nastavení pro federaci identit úloh.
AzurePowerShellCredential

Tyto přihlašovací údaje budou používat informace o aktuálně přihlášených uživatelích z modulu Azure PowerShellu. Provedete to tak, že načte přístupový token uživatele a vyprší čas pomocí příkazu Azure PowerShellu Get-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

Umožňuje vyzkoušet více TokenCredential implementací v pořadí, dokud jedna z metod getToken nevrátí přístupový token.
ClientAssertionCredential

Ověřuje instanční objekt pomocí kontrolního výrazu JWT.
ClientCertificateCredential

Umožňuje ověřování pro Microsoft Entra ID pomocí certifikátu s kódováním PEM, který je přiřazen k registraci aplikace. Další informace o konfiguraci ověřování certifikátů najdete tady:

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

Umožňuje ověřování pro Microsoft Entra ID pomocí tajného klíče klienta vygenerovaného pro registraci aplikace. Další informace o konfiguraci tajného klíče klienta najdete tady:

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

To značí, že přihlašovací údaje, které se pokusily použít v zřetězených přihlašovacích údajích, nebyly k dispozici jako přihlašovací údaje. Místo toho, aby se s tím zacházeli jako s chybou, která by měla řetězec zastavit, je zachycen a řetězec pokračuje.
DefaultAzureCredential

Poskytuje výchozí konfiguraci ChainedTokenCredential, která by měla fungovat pro většinu aplikací, které používají sadu Azure SDK.
DeviceCodeCredential

Umožňuje ověřování pro Microsoft Entra ID pomocí kódu zařízení, který uživatel může zadat do https://microsoft.com/devicelogin.
EnvironmentCredential

Umožňuje ověřování pro Microsoft Entra ID pomocí tajného klíče klienta nebo certifikátu nebo jako uživatel s uživatelským jménem a heslem.
InteractiveBrowserCredential

Umožňuje ověřování pro Microsoft Entra ID uvnitř webového prohlížeče pomocí interaktivního přihlašovacího toku.
ManagedIdentityCredential

Pokusí se o ověření pomocí spravované identity dostupné v prostředí nasazení. Tento typ ověřování funguje ve virtuálních počítačích Azure, instancích služby App Service, aplikacích Azure Functions, službách Azure Kubernetes Services, instancích Azure Service Fabric a ve službě Azure Cloud Shell.

Další informace o konfiguraci spravovaných identit najdete tady: https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
OnBehalfOfCredential

Umožňuje ověřování pro Microsoft Entra ID pomocítoku On Behalf Of .
UsernamePasswordCredential

Umožňuje ověřování pro Microsoft Entra ID pomocí uživatelského jména a hesla uživatele. Tyto přihlašovací údaje vyžadují vysoký stupeň důvěryhodnosti, takže byste je měli používat jenom v případě, že jiné, bezpečnější typy přihlašovacích údajů se nedají použít.
VisualStudioCodeCredential

Připojí se k Azure pomocí přihlašovacích údajů poskytovaných rozšířením VSCode "Účet Azure". Jakmile se uživatel přihlásí přes rozšíření, může toto přihlašovací údaje sdílet stejný obnovovací token, který rozšíření ukládá do mezipaměti.

Jedná se o známý problém, že tyto přihlašovací údaje nefungují s rozšířením účtu Azure novější než 0.9.11. Probíhá dlouhodobé řešení tohoto problému. Mezitím zvažte ověření pomocí azureCliCredential.
WorkloadIdentityCredential

Ověřování identit úloh je funkce v Azure, která umožňuje aplikacím běžícím na virtuálních počítačích přistupovat k jiným prostředkům Azure bez nutnosti instančního objektu nebo spravované identity. Při ověřování identit úloh se aplikace ověřují pomocí vlastní identity místo použití sdíleného instančního objektu nebo spravované identity. Ověřování identit úloh využívá koncept přihlašovacích údajů účtu služby (SACS), které automaticky vytváří Azure a bezpečně se ukládají na virtuálním počítači. Pomocí ověřování identit úloh se můžete vyhnout nutnosti spravovat a obměňovat instanční objekty nebo spravované identity pro každou aplikaci na každém virtuálním počítači. Vzhledem k tomu, že se SACs vytvářejí automaticky a spravují v Azure, nemusíte se starat o ukládání a zabezpečení citlivých přihlašovacích údajů sami. WorkloadIdentityCredential podporuje ověřování ID úloh Microsoft Entra v Azure Kubernetes a získává token pomocí SACS dostupných v prostředí Azure Kubernetes. Další informace najdete v ID úlohy Microsoft Entra.

Rozhraní

AccessToken

Představuje přístupový token s časem vypršení platnosti.
AuthenticationRecord

Záznam, který se má použít k vyhledání tokenů uložených v mezipaměti.
AuthenticationRequiredErrorOptions

Volitelné parametry pro AuthenticationRequiredError
AuthorityValidationOptions

Poskytuje možnosti konfigurace způsobu, jakým knihovna identit provádí ověřování při ověřovacích požadavcích na ID Microsoft Entra.
AuthorizationCodeCredentialOptions

Možnosti pro AuthorizationCodeCredential
AzureCliCredentialOptions

Možnosti AzureCliCredential
AzureDeveloperCliCredentialOptions

Možnosti AzureDeveloperCliCredential
AzurePipelinesCredentialOptions

Volitelné parametry pro třídu AzurePipelinesCredential.
AzurePowerShellCredentialOptions

Možnosti azurePowerShellCredential
BrokerAuthOptions

Možnosti konfigurace pro InteractiveBrowserCredential pro podporu ověřování zprostředkovatele WAM
BrokerDisabledOptions

Parametry při zakázání ověřování zprostředkovatele WAM
BrokerEnabledOptions

Parametry při povolení ověřování zprostředkovatele WAM
BrowserCustomizationOptions

Možnosti sdílené konfigurace pro přizpůsobení prohlížeče
ClientAssertionCredentialOptions

Možnosti ClientAssertionCredential
ClientCertificateCredentialOptions

Volitelné parametry pro ClientCertificateCredential třída.
ClientCertificatePEMCertificate

Požadované možnosti konfigurace pro ClientCertificateCredentials obsahem řetězce certifikátu PEM
ClientCertificatePEMCertificatePath

Požadované možnosti konfigurace pro ClientCertificateCredentials cestou k certifikátu PEM.
ClientSecretCredentialOptions

Volitelné parametry pro ClientSecretCredential třídy.
CredentialPersistenceOptions

Možnosti sdílené konfigurace pro přihlašovací údaje, které podporují ukládání trvalých tokenů do mezipaměti.
DefaultAzureCredentialClientIdOptions

Poskytuje možnosti konfigurace DefaultAzureCredential třídy. Tato varianta podporuje managedIdentityClientId a ne managedIdentityResourceId, protože je podporována pouze jedna z obou variant.
DefaultAzureCredentialOptions

Poskytuje možnosti konfigurace DefaultAzureCredential třídy.
DefaultAzureCredentialResourceIdOptions

Poskytuje možnosti konfigurace DefaultAzureCredential třídy. Tato varianta podporuje managedIdentityResourceId a ne managedIdentityClientId, protože je podporována pouze jedna z obou variant.
DeviceCodeCredentialOptions

Definuje možnosti pro InteractiveBrowserCredential třídy pro Node.js.
DeviceCodeInfo

Poskytuje kód uživatele a identifikátor URI ověření, kde musí být kód zadán. Poskytuje také zprávu, která se zobrazí uživateli, který obsahuje pokyny s těmito podrobnostmi.
EnvironmentCredentialOptions

Umožňuje ověřování pro MICROSOFT Entra ID v závislosti na dostupných proměnných prostředí. Definuje možnosti pro EnvironmentCredential třídy.
ErrorResponse

Další podrobnosti najdete v oficiální dokumentaci:

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

POZNÁMKA: Tato dokumentace je určená pro podporu OAuth v1, ale stejné podrobnosti o odpovědi na chybu se stále vztahují na verzi 2.
GetBearerTokenProviderOptions

Možnosti konfigurace zprostředkovatele tokenu.
GetTokenOptions

Definuje možnosti pro TokenCredential.getToken.
InteractiveBrowserCredentialInBrowserOptions

Definuje společné možnosti pro InteractiveBrowserCredential třídy.
InteractiveBrowserCredentialNodeOptions

Definuje společné možnosti pro InteractiveBrowserCredential třídy.
InteractiveCredentialOptions

Běžné možnosti konstruktoru pro přihlašovací údaje identity, které vyžadují interakci uživatele.
ManagedIdentityCredentialClientIdOptions

Možnosti pro odeslání konstruktoru ManagedIdentityCredential. Tato varianta podporuje clientId a ne resourceId, protože je podporována pouze jedna z obou variant.
ManagedIdentityCredentialObjectIdOptions

Možnosti pro odeslání konstruktoru ManagedIdentityCredential. Tato varianta podporuje objectId jako argument konstruktoru.
ManagedIdentityCredentialResourceIdOptions

Možnosti pro odeslání konstruktoru ManagedIdentityCredential. Tato varianta podporuje resourceId a ne clientId, protože je podporována pouze jedna z obou variant.
MultiTenantTokenCredentialOptions

Možnosti pro aplikace s více tenanty, které umožňují další povolené tenanty.
OnBehalfOfCredentialAssertionOptions

Definuje parametry pro ověření OnBehalfOfCredential kontrolním výrazem.
OnBehalfOfCredentialCertificateOptions

Definuje parametry pro ověření OnBehalfOfCredential pomocí certifikátu.
OnBehalfOfCredentialSecretOptions

Definuje parametry pro ověření OnBehalfOfCredential tajným kódem.
TokenCachePersistenceOptions

Parametry, které v přihlašovacích údajích identity povolují trvalost mezipaměti tokenů
TokenCredential

Představuje přihlašovací údaje schopné poskytnout ověřovací token.
TokenCredentialOptions

Poskytuje možnosti konfigurace způsobu, jakým knihovna Identit provádí žádosti o ověření na ID Microsoft Entra.
UsernamePasswordCredentialOptions

Definuje možnosti pro třídu UsernamePasswordCredential.
VisualStudioCodeCredentialOptions

Poskytuje možnosti konfigurace přihlašovacích údajů editoru Visual Studio Code.
WorkloadIdentityCredentialOptions

Možnosti pro WorkloadIdentityCredential

Aliasy typu

BrokerOptions

Parametry, které umožňují ověřování zprostředkovatele WAM v InteractiveBrowserCredential.
BrowserLoginStyle

(Funkce jen pro prohlížeč) Styl přihlášení, který se má použít v ověřovacím toku:

  • "redirect" přesměruje uživatele na ověřovací stránku a po dokončení ověřování je přesměruje zpět na stránku.
  • Automaticky otevírané okno otevře nové okno prohlížeče prostřednictvím toku přesměrování. Stávající okno prohlížeče uživatele neopustí aktuální stránku.
ClientCertificateCredentialPEMConfiguration

Požadované možnosti konfigurace pro ClientCertificateCredential, s obsahem řetězce certifikátu PEM nebo cestou k certifikátu PEM.
DeviceCodePromptCallback

Definuje podpis zpětného volání, který se předá do DeviceCodeCredential pro účely zobrazení podrobností ověřování uživateli.
IdentityPlugin

Typ modulu plug-in Azure Identity, funkce, která přijímá kontext modulu plug-in.
OnBehalfOfCredentialOptions

Volitelné parametry pro třídu OnBehalfOfCredential.

Výčty

AzureAuthorityHosts

Seznam známých hostitelů autorit Azure

Funkce

deserializeAuthenticationRecord(string)

Deserializuje dříve serializovaný ověřovací záznam z řetězce do objektu.

Vstupní řetězec musí obsahovat následující vlastnosti:

  • "autorita"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "uživatelské jméno"
  • "version"

Pokud se verze, kterou obdržíme, nepodporuje, vyvolá se chyba.

V tuto chvíli je jedinou dostupnou verzí: 1.0, která je vždy nastavena při serializaci ověřovacího záznamu.
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

Vrátí zpětné volání, které poskytuje nosný token. Nosný token lze například použít k ověření požadavku následujícím způsobem:

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}`);
getDefaultAzureCredential()

Vrátí novou instanci DefaultAzureCredential.
serializeAuthenticationRecord(AuthenticationRecord)

Serializuje AuthenticationRecord do řetězce.

Výstup serializovaného ověřovacího záznamu bude obsahovat následující vlastnosti:

  • "autorita"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "uživatelské jméno"
  • "version"

Chcete-li později převést tento řetězec na serializovaný AuthenticationRecord, použijte exportovanou funkci deserializeAuthenticationRecord().
useIdentityPlugin(IdentityPlugin)

Rozšíření identity Azure o další funkce Předejte modul plug-in z balíčku modulu plug-in, například:

  • @azure/identity-cache-persistence: poskytuje trvalé ukládání tokenů do mezipaměti
  • @azure/identity-vscode: poskytuje závislosti VisualStudioCodeCredential a umožňuje

Příklad:

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,
  },
});

Podrobnosti funkce

deserializeAuthenticationRecord(string)

Deserializuje dříve serializovaný ověřovací záznam z řetězce do objektu.

Vstupní řetězec musí obsahovat následující vlastnosti:

  • "autorita"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "uživatelské jméno"
  • "version"

Pokud se verze, kterou obdržíme, nepodporuje, vyvolá se chyba.

V tuto chvíli je jedinou dostupnou verzí: 1.0, která je vždy nastavena při serializaci ověřovacího záznamu.

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Parametry

serializedRecord

string

Záznam ověřování, který byl dříve serializován do řetězce.

Návraty

AuthenticationRecord

Ověřovacízáznam.

getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

Vrátí zpětné volání, které poskytuje nosný token. Nosný token lze například použít k ověření požadavku následujícím způsobem:

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

Přihlašovací údaje použité k ověření požadavku.

scopes

string | string[]

Obory vyžadované pro nosný token.

options
GetBearerTokenProviderOptions

Možnosti konfigurace zprostředkovatele tokenu

Návraty

() => Promise<string>

zpětné volání, které poskytuje nosný token.

getDefaultAzureCredential()

Vrátí novou instanci DefaultAzureCredential.

function getDefaultAzureCredential(): TokenCredential

Návraty

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Serializuje AuthenticationRecord do řetězce.

Výstup serializovaného ověřovacího záznamu bude obsahovat následující vlastnosti:

  • "autorita"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "uživatelské jméno"
  • "version"

Chcete-li později převést tento řetězec na serializovaný AuthenticationRecord, použijte exportovanou funkci deserializeAuthenticationRecord().

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Parametry

record
AuthenticationRecord

Návraty

string

useIdentityPlugin(IdentityPlugin)

Rozšíření identity Azure o další funkce Předejte modul plug-in z balíčku modulu plug-in, například:

  • @azure/identity-cache-persistence: poskytuje trvalé ukládání tokenů do mezipaměti
  • @azure/identity-vscode: poskytuje závislosti VisualStudioCodeCredential a umožňuje

Příklad:

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

modul plug-in pro registraci