@azure/identity package

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í autentizace pomocí 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 autentizaci Microsoft Entra ID pomocí autorizačního kódu získaného prostřednictvím procesu autorizačního kódu, podrobněji popsaného v dokumentaci Microsoft Entra ID:

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

Toto přihlašovací číslo bude využívat aktuálně přihlášené uživatelské přihlašovací údaje prostřednictvím nástroje příkazového řádku Azure CLI ('az'). K tomu přečtete uživatelský přístupový token a vyprší čas pomocí příkazu Azure CLI "az account get-access-token".
AzureDeveloperCliCredential

Azure Developer CLI je nástroj pro příkazovou řádku, který umožňuje vývojářům vytvářet, spravovat a nasazovat zdroje v Azure. Je postaven na Azure CLI a poskytuje další funkce specifické pro vývojáře Azure. Umožňuje uživatelům autentizovat se jako uživatel a/nebo principal služby proti Microsoft Entra ID. AzureDeveloperCliCredential se autentizuje ve vývojovém prostředí a získává token jménem přihlášeného uživatele nebo principala služby v Azure Developer CLI. Funguje jako Azure Developer CLI pro přihlášeného uživatele nebo principála služby a pod ním vykonává příkaz Azure CLI k autentizaci aplikace podle Microsoft Entra ID.

Konfigurace AzureDeveloperCliCredential

Pro použití tohoto přihlašovacího oprávnění musí vývojář lokálně autentizovat v Azure Developer CLI pomocí jednoho z níže uvedených příkazů:

  1. Spusť "azd auth login" v Azure Developer CLI pro interaktivní autentizaci 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

Tento přihlašovací list je navržen pro použití v Azure Pipelines s připojením ke službám jako nastavení pro federaci identit zátěže.
AzurePowerShellCredential

Tato přihlašovací karta bude používat aktuálně přihlášené uživatelské informace z modulu Azure PowerShell. K tomu přečte uživatelský přístupový token a čas vypršení Azure PowerShell příkazem 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. Další informace naleznete v tématu ChainedTokenCredential přehled.
ClientAssertionCredential

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

Umožňuje autentizaci k Microsoft Entra ID pomocí certifikátu kódovaného PEM, který je přiřazen k App Registration. Další informace o konfiguraci ověřování certifikátů najdete tady:

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

Umožňuje autentizaci k Microsoft Entra ID pomocí klientského tajemství vytvořené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á funguje pro většinu aplikací používajících Azure SDK klientské knihovny. Další informace naleznete v tématu DefaultAzureCredential přehled.

V tomto pořadí se budou zkoušit následující typy přihlašovacích údajů:

Další informace o tom, jak se pokouší o ověření, najdete v dokumentaci těchto typů přihlašovacích údajů.

Následující příklad ukazuje, jak použít tuto requiredEnvVars možnost k zajištění toho, aby určité proměnné prostředí byly nastaveny před vytvořením instance.DefaultAzureCredential Pokud některá ze zadaných proměnných prostředí chybí nebo je prázdná, bude vyvolána chyba, která zabrání aplikaci pokračovat v provádění bez potřebné konfigurace. Ukazuje také, jak nastavit proměnnou AZURE_TOKEN_CREDENTIALS prostředí pro řízení, které přihlašovací údaje jsou zahrnuty do řetězce.

import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential({
  requiredEnvVars: [
    "AZURE_CLIENT_ID",
    "AZURE_TENANT_ID",
    "AZURE_CLIENT_SECRET",
    "AZURE_TOKEN_CREDENTIALS",
  ],
});
DeviceCodeCredential

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

Umožňuje autentizaci k Microsoft Entra ID pomocí klientského tajemství nebo certifikátu.
InteractiveBrowserCredential

Umožňuje autentizaci Microsoft Entra ID přímo v webovém prohlížeči pomocí interaktivního přihlašovacího procesu.
ManagedIdentityCredential

Pokusí se o ověření pomocí spravované identity dostupné v prostředí nasazení. Tento typ autentizace funguje ve Azure VM, instancích App Service, Azure Functions aplikacích, Azure Kubernetes Services, Azure Service Fabric instancích a uvnitř Azure Cloud Shell.

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

Umožňuje autentizaci Microsoft Entra ID pomocí On Behalf Of flow.
UsernamePasswordCredential

Umožňuje autentizaci k 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řipojuje se k Azure pomocí uživatelského účtu přihlášeného přes rozšíření Azure Resources ve Visual Studio Code. 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.
WorkloadIdentityCredential

Ověřování identity zátěže je funkce v Azure, která umožňuje aplikacím běžícím na virtuálních strojích (VM) přistupovat k dalším zdrojům Azure bez nutnosti principu služby 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. Pod povrchem autentizace identity zátěže využívá koncept přihlašovacích údajů servisních účtů (SAC), které jsou automaticky vytvářeny Azure a bezpečně uloženy ve VM. 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. Navíc, protože SAC jsou vytvářeny automaticky a spravovány Azure, nemusíte se starat o ukládání a zabezpečení samotných citlivých přihlašovacích údajů. WorkloadIdentityCredential podporuje autentizaci ID úloh Microsoft Entra na Azure Kubernetes a získává token pomocí SAC dostupných v prostředí Azure Kubernetes. Pro více informací viz ID úloh 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

Nabízí možnosti nastavit, jak knihovna Identity provádí ověřování autority během autentizačních požadavků na Microsoft Entra ID.
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 autentizaci k 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/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

Nabízí možnosti nastavit, jak knihovna Identity provádí autentizační požadavky na Microsoft Entra ID.
UsernamePasswordCredentialOptions

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

Nabízí možnosti nastavení přihlašovacího data pro 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.
DefaultAzureCredentialEnvVars

Běžně podporované proměnné prostředí pro třídu DefaultAzureCredential .
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 pluginu Azure Identity, funkce přijímající kontext pluginu.
OnBehalfOfCredentialOptions

Volitelné parametry pro třídu OnBehalfOfCredential.

Výčty

AzureAuthorityHosts

Seznam známých hostitelů Azure authority

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"
  • "ID tenanta"
  • "uživatelské jméno"
  • "verze"

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"
  • "ID tenanta"
  • "uživatelské jméno"
  • "verze"

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

Rozšiřte Azure Identity 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,
  },
});

Proměnné

AggregateAuthenticationErrorName

Hodnota Error.name AggregateAuthenticationError
AuthenticationErrorName

Error.name hodnota autentizační chyby
CredentialUnavailableErrorName

Hodnota Error.name CredentialsNedostupné
logger

AzureLogger používaný pro všechny klienty v rámci identity balíčku

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"
  • "ID tenanta"
  • "uživatelské jméno"
  • "verze"

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"
  • "ID tenanta"
  • "uživatelské jméno"
  • "verze"

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šiřte Azure Identity 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

Podrobnosti proměnné

AggregateAuthenticationErrorName

Hodnota Error.name AggregateAuthenticationError

AggregateAuthenticationErrorName: "AggregateAuthenticationError"

Typ

"AggregateAuthenticationError"

AuthenticationErrorName

Error.name hodnota autentizační chyby

AuthenticationErrorName: "AuthenticationError"

Typ

"AuthenticationError"

CredentialUnavailableErrorName

Hodnota Error.name CredentialsNedostupné

CredentialUnavailableErrorName: "CredentialUnavailableError"

Typ

"CredentialUnavailableError"

logger

AzureLogger používaný pro všechny klienty v rámci identity balíčku

logger: AzureLogger

Typ

AzureLogger