@azure/identity package

  • Referencia

Osztályok

AggregateAuthenticationError

errors Egy AuthenticationError-példányt tartalmazó tömböt biztosít a chainedTokenCredential hitelesítő adataiból eredő hitelesítési hibákhoz.
AuthenticationError

Az Azure Active Directoryval való hitelesítés sikertelenségével kapcsolatos részletek. A errorResponse mező további részleteket tartalmaz az adott hibáról.
AuthenticationRequiredError

Hiba történt a hitelesítés kényszerítéséhez egy jogkivonat csendes lekérése után.
AuthorizationCodeCredential

Lehetővé teszi, hogy a hitelesítés az engedélyezési kód folyamatán keresztül beszerzett engedélyezési kóddal Microsoft Entra ID, amelyről részletesebben a Microsoft Entra ID dokumentációjában olvashat:

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

Ez a hitelesítő adat az Azure CLI (az) parancssori eszközén keresztül fogja használni a jelenleg bejelentkezett felhasználói bejelentkezési adatokat. Ehhez beolvassa a felhasználói hozzáférési jogkivonatot, és lejár az "az account get-access-token" Azure CLI-paranccsal.
AzureDeveloperCliCredential

Azure Developer CLI egy parancssori felületi eszköz, amellyel a fejlesztők erőforrásokat hozhatnak létre, kezelhetnek és helyezhetnek üzembe az Azure-ban. Az Azure CLI-n alapul, és további, az Azure-fejlesztőkre jellemző funkciókat biztosít. Lehetővé teszi, hogy a felhasználók felhasználóként és/vagy szolgáltatásnévként hitelesítsék magukat Microsoft Entra ID. Az AzureDeveloperCliCredential egy fejlesztési környezetben hitelesíti magát, és jogkivonatot szerez be a bejelentkezett felhasználó vagy szolgáltatásnév nevében a Azure Developer CLI. Ez a Azure Developer CLI bejelentkezett felhasználóként vagy szolgáltatásnévként működik, és alatta végrehajt egy Azure CLI-parancsot az alkalmazás hitelesítéséhez Microsoft Entra ID.

Az AzureDeveloperCliCredential konfigurálása

A hitelesítő adatok használatához a fejlesztőnek helyileg kell hitelesítenie Azure Developer CLI az alábbi parancsok egyikével:

  1. Futtassa az "azd auth login" (azd auth login) parancsot a Azure Developer CLI a felhasználóként történő interaktív hitelesítéshez.
  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 között van. Az AzureDeveloperCliCredential kérni fogja, hogy jelentkezzen be újra.
AzurePowerShellCredential

Ez a hitelesítő adat a Azure PowerShell modulból származó, jelenleg bejelentkezett felhasználói adatokat fogja használni. Ehhez beolvassa a felhasználói hozzáférési jogkivonatot, és Azure PowerShell paranccsal lejár az idő.Get-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

Lehetővé teszi több TokenCredential implementáció kipróbálását sorrendben, amíg az egyik getToken metódus nem ad vissza hozzáférési jogkivonatot.
ClientAssertionCredential

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

Lehetővé teszi a hitelesítést egy alkalmazásregisztrációhoz rendelt PEM-kódolású tanúsítvány használatával Microsoft Entra ID. A tanúsítványhitelesítés konfigurálásáról további információt itt talál:

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

Engedélyezi a hitelesítést egy alkalmazásregisztrációhoz létrehozott ügyfélkód használatával Microsoft Entra ID. 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 rendszer elkapja, és a lánc folytatódik
DefaultAzureCredential

Alapértelmezett ChainedTokenCredential konfigurációt biztosít, amely az Azure SDK-t használó legtöbb alkalmazás esetében használható.
DeviceCodeCredential

Engedélyezi a hitelesítést, hogy Microsoft Entra ID a felhasználó által beírt https://microsoft.com/devicelogineszközkóddal.
EnvironmentCredential

Lehetővé teszi a hitelesítést, hogy titkos ügyfélkóddal vagy tanúsítvánnyal Microsoft Entra ID, vagy felhasználónévvel és jelszóval rendelkező felhasználóként.
InteractiveBrowserCredential

Engedélyezi a webböngészőn belüli Microsoft Entra ID hitelesítést az interaktív bejelentkezési folyamattal.
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-beli virtuális gépeken, App Service-példányokban, Azure Functions-alkalmazásokban, Az Azure Kubernetes Servicesben, az Azure Service Fabric-példányokban és az Azure-Cloud Shell belül működik.

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

Engedélyezi a hitelesítést Microsoft Entra ID a Nevében folyamat használatával.
UsernamePasswordCredential

Engedélyezi a felhasználó felhasználónevével és jelszavával Microsoft Entra ID hitelesítést. Ez a hitelesítő adat magas szintű megbízhatóságot igényel, ezért csak akkor érdemes használni, ha más, biztonságosabb hitelesítőadat-típusokat nem lehet használni.
VisualStudioCodeCredential

Az Azure-hoz az "Azure Account" VSCode-bővítmény által biztosított hitelesítő adatokkal csatlakozik az Azure-hoz. 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.

Ismert probléma, hogy ez a hitelesítő adat nem működik a 0.9.11-nél újabb Azure-fiókbővítmény-verziókkal. A probléma hosszú távú megoldása folyamatban van. Addig is fontolja meg a hitelesítést az AzureCliCredential használatával.
WorkloadIdentityCredential

A számítási feladat identitásának hitelesítése az Azure egyik funkciója, amely lehetővé teszi, hogy a virtuális gépeken futó alkalmazások szolgáltatásnév vagy felügyelt identitás nélkül férjenek hozzá más Azure-erőforrásokhoz. A számításifeladat-identitás hitelesítésével az alkalmazások saját identitásukkal hitelesítik magukat, nem pedig megosztott szolgáltatásnévvel vagy felügyelt identitással. A háttérben a számítási feladatok identitásának hitelesítése a szolgáltatásfiók hitelesítő adatainak (SAC-k) fogalmát használja, amelyeket az Azure automatikusan hoz létre, és biztonságosan tárol a virtuális gépen. 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 kezelnie és elforgatnia kell a szolgáltatásneveket vagy a felügyelt identitásokat. Emellett mivel az Azure automatikusan hozza létre és felügyeli az SAC-ket, nem kell aggódnia a bizalmas hitelesítő adatok tárolása és védelme miatt. A WorkloadIdentityCredential támogatja Microsoft Entra Számítási feladat ID hitelesítést az Azure Kubernetesen, és az Azure Kubernetes-környezetben elérhető SAC-k használatával szerez be egy jogkivonatot. További információért tekintse meg a Microsoft Entra Számítási feladat ID.

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

A AuthenticationRequiredError opcionális paraméterei
AuthorityValidationOptions

Lehetőséget biztosít annak konfigurálására, hogy az identitástár hogyan érvényesíti a hitelesítést a hitelesítési kérések során Microsoft Entra ID.
AuthorizationCodeCredentialOptions

Az AuthorizationCodeCredential beállításai
AzureCliCredentialOptions

Az AzureCliCredential beállításai
AzureDeveloperCliCredentialOptions

Az AzureDeveloperCliCredential beállításai
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

A ClientAssertionCredential beállításai
ClientCertificateCredentialOptions

A ClientCertificateCredential osztály opcionális paraméterei.
ClientCertificatePEMCertificate

A ClientCertificateCredential szükséges konfigurációs beállításai egy PEM-tanúsítvány sztringtartalmával
ClientCertificatePEMCertificatePath

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

A ClientSecretCredential osztály opcionális paraméterei.
CredentialPersistenceOptions

A hitelesítő adatok megosztott konfigurációs beállításai, amelyek támogatják az állandó jogkivonatok gyorsítótárazását.
DefaultAzureCredentialClientIdOptions

A DefaultAzureCredential osztály konfigurálásának lehetőségei. Ez a változat támogatja managedIdentityClientId és nem managedIdentityResourceId, mivel csak az egyik támogatott.
DefaultAzureCredentialOptions

A DefaultAzureCredential osztály konfigurálásának lehetőségei.
DefaultAzureCredentialResourceIdOptions

A DefaultAzureCredential osztály konfigurálásának lehetőségei. Ez a változat támogatja managedIdentityResourceId és nem managedIdentityClientId, mivel csak az egyik támogatott.
DeviceCodeCredentialOptions

A Node.js InteractiveBrowserCredential 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ónak, amely az alábbi részleteket tartalmazó utasítást tartalmazza.
EnvironmentCredentialOptions

Engedélyezi a hitelesítést az elérhető környezeti változóktól függően Microsoft Entra ID. Meghatározza az EnvironmentCredential osztály beállításait.
ErrorResponse

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

https://learn.microsoft.com/en-us/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ásra vonatkozik, de a hibaválasz részletei továbbra is érvényesek a 2-es verzióra.
GetBearerTokenProviderOptions

A jogkivonat-szolgáltató konfigurálásának lehetőségei.
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

Gyakori konstruktor-beállítások az identitás hitelesítő adataihoz, amelyek felhasználói beavatkozást igényelnek.
ManagedIdentityCredentialClientIdOptions

A ManagedIdentityCredential konstruktoron küldendő beállítások. Ez a változat támogatja clientId és nem resourceId, mivel mindkettőt csak az egyik támogatja.
ManagedIdentityCredentialResourceIdOptions

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

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

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

Meghatározza az OnBehalfOfCredential titkos kóddal való hitelesítéséhez használt paramétereket.
TokenCachePersistenceOptions

A tokengyorsítótár-adatmegőrzést engedélyező paraméterek az identitás hitelesítő adataiban.
TokenCredential

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

Itt adhatja meg, hogy az identitástár hogyan küldjön hitelesítési kéréseket Microsoft Entra ID.
UsernamePasswordCredentialOptions

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

A Visual Studio Code hitelesítő adatainak konfigurálására vonatkozó lehetőségeket biztosít.
WorkloadIdentityCredentialOptions

A WorkloadIdentityCredential beállításai

Típusaliasok

BrokerOptions

Paraméterek, amelyek engedélyezik a WAM-közvetítő hitelesítését 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 oldalra, majd a hitelesítés befejezése után visszairányítja őket a lapra.
  • 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

A ClientCertificateCredential szü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.
DeviceCodePromptCallback

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

Az Azure Identity beépülő modul típusa, amely egy beépülő modul környezetét elfogadó függvény.
OnBehalfOfCredentialOptions

Az OnBehalfOfCredential osztály opcionális paraméterei.

Enumerációk

AzureAuthorityHosts

Ismert Azure-szolgáltatói gazdagépek 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"
  • "tenantId"
  • "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 be van állítva a hitelesítési rekord szerializálásakor.
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

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

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

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álja az egyiket AuthenticationRecord .

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

  • "hatóság"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "felhasználónév"
  • "verzió"

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

További funkciókkal bővítheti az Azure Identityt. 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 függőségeit VisualStudioCodeCredential , és engedélyezi azt

Példa:

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

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"
  • "tenantId"
  • "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 be van állítva a hitelesítési rekord szerializálásakor.

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Paraméterek

serializedRecord

string

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

Válaszok

AuthenticationRecord

AuthenticationRecord.

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

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

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

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ának beállításai.

Válaszok

() => Promise<string>

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

getDefaultAzureCredential()

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

function getDefaultAzureCredential(): TokenCredential

Válaszok

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Sztringgé szerializálja az egyiket AuthenticationRecord .

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

  • "hatóság"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "felhasználónév"
  • "verzió"

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

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Paraméterek

record
AuthenticationRecord

Válaszok

string

useIdentityPlugin(IdentityPlugin)

További funkciókkal bővítheti az Azure Identityt. 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 függőségeit VisualStudioCodeCredential , és engedélyezi azt

Példa:

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)

Paraméterek

plugin
IdentityPlugin

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