@azure/identity package

Osztályok

AggregateAuthenticationError

Egy errors tömböt tartalmaz, amely AuthenticationError-példányt tartalmaz a ChainedTokenCredentialhitelesítő adatainak hitelesítési hibáihoz.
AuthenticationError

Részleteket ad az Azure Active Directory-val történő hitelesítési hibáról. A errorResponse mező további részleteket tartalmaz az adott hibáról.
AuthenticationRequiredError

A jogkivonat csendes lekérése után a hitelesítés kényszerítésére használt hiba.
AuthorizationCodeCredential

Lehetővé teszi a hitelesítést a Microsoft Entra ID-hez egy hitelesítési kód segítségével, amelyet az engedélyezési kód folyamatán keresztül szereztek meg, és amelyet részletesebben a Microsoft Entra ID dokumentációban részletesebben ismertetünk:

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

Ez a hitelesítő adatok a jelenleg bejelentkezett felhasználói bejelentkezési adatokat használják az Azure CLI ('az') parancssoros eszközön keresztül. Ehhez a felhasználói hozzáférési tokent olvassa és lejárati időt tölt az Azure CLI parancs "az account get-access-token" használatával.
AzureDeveloperCliCredential

Az Azure Developer CLI egy parancssoros felületfelület, amely lehetővé teszi a fejlesztők számára, hogy erőforrásokat hozzanak létre, kezeljenek és telepítsenek az Azure-ban. Ez az Azure CLI ráépül, és további funkciókat kínál az Azure fejlesztőknek. Lehetővé teszi a felhasználók számára, hogy felhasználóként és/vagy szolgáltatási alapként hitelesítsék a Microsoft Entra ID ellen. Az AzureDeveloperCliCredential hitelesítést ad egy fejlesztői környezetben, és egy tokent szerez a bejelentkezett felhasználó vagy szolgáltatási fő nevében az Azure Developer CLI-ben. Ez az Azure Developer CLI-jaként működik, amely bejelentkezett felhasználói vagy szolgáltatási alapfel, és alatta egy Azure CLI parancsot hajt végre, hogy hitelesítse az alkalmazást a Microsoft Entra ID-vel szemben.

Az AzureDeveloperCliCredential konfigurálása

Ehhez a hitelesítő képesedéshez a fejlesztőnek helyben hitelesítenie kell a Azure Developer CLI-ben az alábbi parancsok egyikével:

  1. Fussd be az "azd auth login" alkalmazást az Azure Developer CLI-ben, hogy interaktívan autentikálj felhasználóként.
  2. Futtassa az "azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID" parancsot a szolgáltatásnévként való hitelesítéshez.

Előfordulhat, hogy meg kell ismételnie ezt a folyamatot egy bizonyos idő elteltével, a frissítési jogkivonat érvényességétől függően a szervezetben. A frissítési jogkivonat érvényességi ideje általában néhány hét és néhány hónap. Az AzureDeveloperCliCredential kérni fogja, hogy jelentkezzen be újra.
AzurePipelinesCredential

Ez a hitelesítés Azure Pipelines-ben szolgáltatáskapcsolatokkal való használatra készült, mint a munkaterhelés identitásföderációjának előkészítése.
AzurePowerShellCredential

Ez a hitelesítés az Azure PowerShell modulból jelenleg bejelentkezett felhasználói adatokat fogja felhasználni. Ehhez a felhasználói hozzáférési tokent olvassa, és lejárati időt tölt Azure PowerShell parancs Get-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

Több TokenCredential implementáció kipróbálását teszi lehetővé, amíg az egyik getToken metódus nem ad vissza hozzáférési jogkivonatot. További információ: ChainedTokenCredential áttekintés.
ClientAssertionCredential

A szolgáltatásnév hitelesítése JWT-állítással.
ClientCertificateCredential

Lehetővé teszi a Microsoft Entra ID hitelesítését egy PEM-kódolt tanúsítvány segítségével, amelyet egy alkalmazásregisztrációhoz rendelnek. A tanúsítványhitelesítés konfigurálásáról további információt itt talál:

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

Lehetővé teszi a hitelesítést a Microsoft Entra ID-hez egy App Registration (alkalmazásregisztrációhoz generált kliens titkos) segítségével. Az ügyfélkód konfigurálásáról további információt itt talál:

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

Ez azt jelzi, hogy a láncolt hitelesítő adatokban kipróbált hitelesítő adatok nem használhatók hitelesítő adatként. Ahelyett, hogy ezt hibaként kezelné, amely leállítja a láncot, a lánc folytatódik
DefaultAzureCredential

Alapértelmezett ChainedTokenCredential konfigurációt biztosít, amely a legtöbb Azure SDK klienskönyvtárat használó alkalmazásnál működik. További információt a DefaultAzureCredential áttekintésében talál.

A rendszer a következő hitelesítőadat-típusokat próbálja meg a következő sorrendben:

A hitelesítő adatok típusainak dokumentációjában további információt talál a hitelesítés megkísérlésének módjáról.

Az alábbi példa bemutatja, hogyan használható a requiredEnvVars beállítás annak biztosítására, hogy bizonyos környezeti változók be legyenek állítva a DefaultAzureCredential példányosítás előtt. Ha a megadott környezeti változók bármelyike hiányzik vagy üres, a rendszer hibát jelez, amely megakadályozza, hogy az alkalmazás a szükséges konfiguráció nélkül folytassa a végrehajtást. Azt is bemutatja, hogyan állíthatja be a környezeti változót AZURE_TOKEN_CREDENTIALS a láncban szereplő hitelesítő adatok szabályozására.

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

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

Lehetővé teszi a hitelesítést Microsoft Entra ID egy eszközkód használatával, amelyet a felhasználó beírhat https://microsoft.com/devicelogin be.
EnvironmentCredential

Lehetővé teszi a Microsoft Entra ID hitelesítését kliens-titok vagy tanúsítvány használatával.
InteractiveBrowserCredential

Lehetővé teszi a Microsoft Entra ID hitelesítését a böngészőn belül az interaktív bejelentkezési folyamat segítségével.
ManagedIdentityCredential

Az üzembe helyezési környezetben elérhető felügyelt identitással kísérli meg a hitelesítést. Ez a hitelesítési típus Azure VM-ekben, App Service instance-okban, Azure Functions alkalmazásokban, Azure Kubernetes Services-ben, Azure Service Fabric instance-okban és az Azure Cloud Shell-en belül működik.

A felügyelt identitások konfigurálásáról további információt itt talál: https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview
OnBehalfOfCredential

Lehetővé teszi a hitelesítést Microsoft Entra ID On Of Of Flow használatával.
UsernamePasswordCredential

Lehetővé teszi a Microsoft Entra ID hitelesítését a felhasználó felhasználónevével és jelszavával. Ez a hitelesítő adatok magas fokú megbízhatóságot igényelnek, ezért csak akkor érdemes használni, ha más, biztonságosabb hitelesítő adatokat nem lehet használni.
VisualStudioCodeCredential

Csatlakozik Azure-hez a Azure Resources kiterjesztésen keresztül betöltött felhasználói fiókkal Visual Studio Code-ben. Miután a felhasználó bejelentkezett a bővítményen keresztül, ez a hitelesítő adat ugyanazzal a frissítési jogkivonattal rendelkezhet, amelyet a bővítmény gyorsítótárazott.
WorkloadIdentityCredential

A Workload Identity hitelesítés egy olyan funkció az Azure-ban, amely lehetővé teszi a virtuális gépeken (VM-ken) futó alkalmazások számára, hogy más Azure erőforrásokhoz férjenek hozzá szolgáltatási alap vagy menedzselt identitás nélkül. A számítási feladatok identitásának hitelesítésével az alkalmazások saját identitásukkal hitelesítik magukat, nem pedig megosztott szolgáltatásnév vagy felügyelt identitás használatával. A Workload Identity hitelesítés a Service Account Credentials (SACs) koncepcióját használja, amelyeket automatikusan az Azure hoz létre és biztonságosan tárol a VM-ben. A Számítási feladat identitásának hitelesítésével elkerülheti, hogy minden egyes virtuális gépen minden alkalmazáshoz kezelni és elforgatni kell a szolgáltatásnevek vagy a felügyelt identitások kezelését és elforgatását. Továbbá, mivel a SAC-eket automatikusan létrehozzák és az Azure kezeli, nem kell aggódni az érzékeny adatok tárolása és biztonsága miatt. A WorkloadIdentityCredential támogatja a Microsoft Entra Számítási feladat ID hitelesítést az Azure Kubernetes-en, és az Azure Kubernetes környezetben elérhető SAC-okkal szerez meg egy tokent. További információért lásd a Microsoft Entra Számítási feladat ID oldalt.

Interfészek

AccessToken

Lejárati idővel rendelkező hozzáférési jogkivonatot jelöl.
AuthenticationRecord

A gyorsítótárban lévő jogkivonatok megkereséséhez használandó rekord.
AuthenticationRequiredErrorOptions

Választható paraméterek a AuthenticationRequiredError
AuthorityValidationOptions

Lehetőséget ad arra, hogy beállítsuk, hogyan végezi az Identitáskönyvtár a hitelesítési lekérdezések során a Microsoft Entra ID-t érintő hitelesítési igények során.
AuthorizationCodeCredentialOptions

A AuthorizationCodeCredential beállításai
AzureCliCredentialOptions

Az AzureCliCredential beállításai
AzureDeveloperCliCredentialOptions

Az AzureDeveloperCliCredential beállításai
AzurePipelinesCredentialOptions

Az AzurePipelinesCredential osztály választható paraméterei.
AzurePowerShellCredentialOptions

Az AzurePowerShellCredential beállításai
BrokerAuthOptions

Az InteractiveBrowserCredential konfigurációs beállításai a WAM Broker-hitelesítés támogatásához.
BrokerDisabledOptions

Paraméterek, ha a WAM-közvetítő hitelesítése le van tiltva.
BrokerEnabledOptions

Paraméterek, ha a WAM-közvetítő hitelesítése engedélyezve van.
BrowserCustomizationOptions

Megosztott konfigurációs beállítások a böngésző testreszabásához
ClientAssertionCredentialOptions

Az ClientAssertionCredential beállításai
ClientCertificateCredentialOptions

A ClientCertificateCredential osztály választható paraméterei.
ClientCertificatePEMCertificate

Az ClientCertificateCredentialszükséges konfigurációs beállításai PEM-tanúsítvány sztringtartalmával
ClientCertificatePEMCertificatePath

A PEM-tanúsítvány elérési útjával rendelkező ClientCertificateCredentialszükséges konfigurációs beállításai.
ClientSecretCredentialOptions

Az ClientSecretCredential osztály választható paraméterei.
CredentialPersistenceOptions

Az állandó jogkivonatok gyorsítótárazását támogató hitelesítő adatok megosztott konfigurációs beállításai.
DefaultAzureCredentialClientIdOptions

Az DefaultAzureCredential osztály konfigurálására szolgál. Ez a változat managedIdentityClientId és nem managedIdentityResourceIdtámogatja, mivel mindkettő közül csak az egyik támogatott.
DefaultAzureCredentialOptions

Az DefaultAzureCredential osztály konfigurálására szolgál.
DefaultAzureCredentialResourceIdOptions

Az DefaultAzureCredential osztály konfigurálására szolgál. Ez a változat managedIdentityResourceId és nem managedIdentityClientIdtámogatja, mivel mindkettő közül csak az egyik támogatott.
DeviceCodeCredentialOptions

A Node.jsInteractiveBrowserCredential osztályának beállításait határozza meg.
DeviceCodeInfo

Megadja a felhasználói kódot és az ellenőrző URI-t, ahol a kódot be kell írni. Emellett egy üzenetet is megjelenít a felhasználó számára, amely az alábbi részleteket tartalmazó utasítást tartalmazza.
EnvironmentCredentialOptions

Lehetővé teszi a hitelesítést a Microsoft Entra ID-re a rendelkezésre álló környezeti változók függvényében. Meghatározza a EnvironmentCredential osztály beállításait.
ErrorResponse

További részletekért tekintse meg a hivatalos dokumentációt:

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

MEGJEGYZÉS: Ez a dokumentáció az 1- es verziós OAuth-támogatáshoz készült, de a hibaválasz részletei továbbra is érvényesek a 2- es verzióra.
GetBearerTokenProviderOptions

A jogkivonat-szolgáltató konfigurálására vonatkozó beállítások.
GetTokenOptions

Meghatározza a TokenCredential.getToken beállításait.
InteractiveBrowserCredentialInBrowserOptions

Meghatározza az InteractiveBrowserCredential osztály gyakori beállításait.
InteractiveBrowserCredentialNodeOptions

Meghatározza az InteractiveBrowserCredential osztály gyakori beállításait.
InteractiveCredentialOptions

Az identitás hitelesítő adatainak gyakori konstruktorbeállításai, amelyek felhasználói beavatkozást igényelnek.
ManagedIdentityCredentialClientIdOptions

A ManagedIdentityCredential konstruktoron küldendő beállítások. Ez a változat clientId és nem resourceIdtámogatja, mivel mindkettő közül csak az egyik támogatott.
ManagedIdentityCredentialObjectIdOptions

A ManagedIdentityCredential konstruktoron küldendő beállítások. Ez a változat konstruktor argumentumként támogatja a objectId.
ManagedIdentityCredentialResourceIdOptions

A ManagedIdentityCredential konstruktoron küldendő beállítások. Ez a változat resourceId és nem clientIdtámogatja, mivel mindkettő közül csak az egyik támogatott.
MultiTenantTokenCredentialOptions

Több-bérlős alkalmazások beállításai, amelyek lehetővé teszik a további bérlők használatát.
OnBehalfOfCredentialAssertionOptions

Meghatározza azokat a paramétereket, amelyekkel az OnBehalfOfCredential egy helyességi feltétellel hitelesítheti.
OnBehalfOfCredentialCertificateOptions

Meghatározza a OnBehalfOfCredential tanúsítványsal való hitelesítéséhez szükséges paramétereket.
OnBehalfOfCredentialSecretOptions

Meghatározza azokat a paramétereket, amelyekkel titkos kóddal hitelesítheti az OnBehalfOfCredential.
TokenCachePersistenceOptions

Olyan paraméterek, amelyek engedélyezik a tokengyorsítótár-adatmegőrzést az identitás hitelesítő adataiban.
TokenCredential

Hitelesítési jogkivonat megadására alkalmas hitelesítő adatokat jelöl.
TokenCredentialOptions

Lehetőséget ad arra, hogy beállítsák, hogyan keresi az Identity könyvtár hitelesítési kéréseket a Microsoft Entra ID-re.
UsernamePasswordCredentialOptions

Meghatározza a UsernamePasswordCredential osztály beállításait.
VisualStudioCodeCredentialOptions

Lehetőséget ad a Visual Studio Code jogosultság konfigurálására.
WorkloadIdentityCredentialOptions

A WorkloadIdentityCredential beállításai

Típusaliasok

BrokerOptions

A WAM-közvetítő hitelesítését engedélyező paraméterek az InteractiveBrowserCredentialban.
BrowserLoginStyle

(Csak böngészős funkció) A hitelesítési folyamatban használandó "bejelentkezési stílus":

  • Az "átirányítás" átirányítja a felhasználót a hitelesítési lapra, majd visszairányítja őket a lapra a hitelesítés befejezése után.
  • Az "előugró ablak" új böngészőablakot nyit meg az átirányítási folyamat elindításával. A felhasználó meglévő böngészőablaka nem hagyja el az aktuális lapot
ClientCertificateCredentialPEMConfiguration

Az ClientCertificateCredentialszükséges konfigurációs beállításai egy PEM-tanúsítvány sztringtartalmával vagy egy PEM-tanúsítvány elérési útjával.
DefaultAzureCredentialEnvVars

A DefaultAzureCredential osztály általánosan támogatott környezeti változói.
DeviceCodePromptCallback

Meghatározza egy visszahívás aláírását, amelyet a rendszer átad a DeviceCodeCredentialnak a hitelesítési adatok felhasználónak való megjelenítése céljából.
IdentityPlugin

Az Azure Identity plugin típusa, amely egy plugin kontextust fogad el.
OnBehalfOfCredentialOptions

Az OnBehalfOfCredential osztály választható paraméterei.

Enumerációk

AzureAuthorityHosts

Az ismert Azure hatósági hosztok listája

Függvények

deserializeAuthenticationRecord(string)

Deszerializál egy korábban szerializált hitelesítési rekordot egy sztringből egy objektumba.

A bemeneti sztringnek a következő tulajdonságokat kell tartalmaznia:

  • "hatóság"
  • "homeAccountId"
  • "clientId"
  • "bérlői azonosító"
  • "felhasználónév"
  • "verzió"

Ha a kapott verzió nem támogatott, hibaüzenet jelenik meg.

Jelenleg az egyetlen elérhető verzió a következő: "1.0", amely mindig a hitelesítési rekord szerializálásakor van beállítva.
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

Visszahívást ad vissza, amely egy tulajdonosi jogkivonatot biztosít. A tulajdonosi jogkivonat például a következők szerint hitelesíthető:

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()

A DefaultAzureCredentialúj példányát adja vissza.
serializeAuthenticationRecord(AuthenticationRecord)

Sztringgé szerializál egy AuthenticationRecord.

A szerializált hitelesítési rekord kimenete a következő tulajdonságokat tartalmazza:

  • "hatóság"
  • "homeAccountId"
  • "clientId"
  • "bérlői azonosító"
  • "felhasználónév"
  • "verzió"

Ha ezt a sztringet később szerializált AuthenticationRecordszeretné konvertálni, használja az exportált függvényt deserializeAuthenticationRecord().
useIdentityPlugin(IdentityPlugin)

Az Azure Identity további funkciókkal bővítse. Beépülő modul átadása beépülő modulcsomagból, például:

  • @azure/identity-cache-persistence: állandó jogkivonat-gyorsítótárazást biztosít
  • @azure/identity-vscode: biztosítja a VisualStudioCodeCredential függőségeit, és engedélyezi azt

Példa:

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

Változók

AggregateAuthenticationErrorName

Az AggregateAuthenticationError Error.name értéke
AuthenticationErrorName

Az AuthenticationError Error.name értéke
CredentialUnavailableErrorName

Az Credential Error.name értékeUnavailable
logger

Az AzureLogger, amelyet az identitáscsomag összes kliensére használnak

Függvény adatai

deserializeAuthenticationRecord(string)

Deszerializál egy korábban szerializált hitelesítési rekordot egy sztringből egy objektumba.

A bemeneti sztringnek a következő tulajdonságokat kell tartalmaznia:

  • "hatóság"
  • "homeAccountId"
  • "clientId"
  • "bérlői azonosító"
  • "felhasználónév"
  • "verzió"

Ha a kapott verzió nem támogatott, hibaüzenet jelenik meg.

Jelenleg az egyetlen elérhető verzió a következő: "1.0", amely mindig a hitelesítési rekord szerializálásakor van beállítva.

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Paraméterek

serializedRecord

string

A korábban sztringgé szerializált hitelesítési rekord.

Válaszok

AuthenticationRecord

AuthenticationRecord elemre.

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

Visszahívást ad vissza, amely egy tulajdonosi jogkivonatot biztosít. A tulajdonosi jogkivonat például a következők szerint hitelesíthető:

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>

Paraméterek

credential
TokenCredential

A kérelem hitelesítéséhez használt hitelesítő adat.

scopes

string | string[]

A tulajdonosi jogkivonathoz szükséges hatókörök.

options
GetBearerTokenProviderOptions

A jogkivonat-szolgáltató konfigurálására vonatkozó beállítások.

Válaszok

() => Promise<string>

egy visszahívás, amely egy tulajdonosi jogkivonatot biztosít.

getDefaultAzureCredential()

A DefaultAzureCredentialúj példányát adja vissza.

function getDefaultAzureCredential(): TokenCredential

Válaszok

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Sztringgé szerializál egy AuthenticationRecord.

A szerializált hitelesítési rekord kimenete a következő tulajdonságokat tartalmazza:

  • "hatóság"
  • "homeAccountId"
  • "clientId"
  • "bérlői azonosító"
  • "felhasználónév"
  • "verzió"

Ha ezt a sztringet később szerializált AuthenticationRecordszeretné konvertálni, használja az exportált függvényt deserializeAuthenticationRecord().

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Paraméterek

record
AuthenticationRecord

Válaszok

string

useIdentityPlugin(IdentityPlugin)

Az Azure Identity további funkciókkal bővítse. Beépülő modul átadása beépülő modulcsomagból, például:

  • @azure/identity-cache-persistence: állandó jogkivonat-gyorsítótárazást biztosít
  • @azure/identity-vscode: biztosítja a VisualStudioCodeCredential függőségeit, és engedélyezi azt

Példa:

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)

Paraméterek

plugin
IdentityPlugin

a regisztrálandó beépülő modul

Változó részletei

AggregateAuthenticationErrorName

Az AggregateAuthenticationError Error.name értéke

AggregateAuthenticationErrorName: "AggregateAuthenticationError"

Típus

"AggregateAuthenticationError"

AuthenticationErrorName

Az AuthenticationError Error.name értéke

AuthenticationErrorName: "AuthenticationError"

Típus

"AuthenticationError"

CredentialUnavailableErrorName

Az Credential Error.name értékeUnavailable

CredentialUnavailableErrorName: "CredentialUnavailableError"

Típus

"CredentialUnavailableError"

logger

Az AzureLogger, amelyet az identitáscsomag összes kliensére használnak

logger: AzureLogger

Típus

AzureLogger