Megosztás a következőn keresztül:

@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

Az Azure Active Directoryval való hitelesítés sikertelenségével kapcsolatos részleteket tartalmaz. 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

Engedélyezi a Hitelesítést a Microsoft Entra ID-hez az engedélyezési kód folyamatán keresztül beszerzett engedélyezési kód használatával, amelyet a Microsoft Entra ID dokumentációjában részletesebben ismertetünk:

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ével 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

Az 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-re épül, és további, azure-fejlesztőknek szóló funkciókat biztosít. Lehetővé teszi a felhasználók számára, hogy felhasználóként és/vagy szolgáltatásnévként hitelesítsék magukat Microsoft Entra-azonosító. Az AzureDeveloperCliCredential egy fejlesztői környezetben hitelesít, és jogkivonatot szerez be a bejelentkezett felhasználó vagy szolgáltatásnév nevében az Azure Developer CLI-ben. Úgy működik, mint az Azure Developer CLI, amely bejelentkezett a felhasználóba vagy szolgáltatásnévbe, és alatta végrehajt egy Azure CLI-parancsot az alkalmazás Microsoft Entra-azonosítóval való hitelesítéséhez.

Az AzureDeveloperCliCredential konfigurálása

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

  1. Futtassa az "azd auth login" (azd auth login) parancsot az Azure Developer CLI-ben az interaktív hitelesítéshez 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

Ezt a hitelesítő adatot úgy tervezték, hogy szolgáltatáskapcsolatokkal rendelkező Azure Pipelinesban használható legyen a számítási feladatok identitás-összevonásának beállításaként.
AzurePowerShellCredential

Ez a hitelesítő adat az 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 az Azure PowerShell-paranccsal lejár az idő, 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

Engedélyezi a Microsoft Entra ID-hitelesítést egy alkalmazásregisztrációhoz rendelt PEM-kódolt tanúsítvány használatával. 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

Engedélyezi a Microsoft Entra-azonosító hitelesítését egy alkalmazásregisztrációhoz létrehozott ügyfélkód használatával. 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 az Azure SDK-ügyfélkódtárakat használó legtöbb alkalmazáshoz használható. 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

Engedélyezi a Microsoft Entra ID-hitelesítést egy olyan eszközkód használatával, amelyet a felhasználó be tud írni https://microsoft.com/devicelogin.
EnvironmentCredential

Engedélyezi a Microsoft Entra ID hitelesítését titkos ügyfélkód vagy tanúsítvány használatával.
InteractiveBrowserCredential

Engedélyezi a Microsoft Entra-azonosító hitelesítését a webböngészőben az interaktív bejelentkezési folyamat használatával.
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, Azure Kubernetes Servicesben, Azure Service Fabric-példányokban és az Azure Cloud Shellben 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

Engedélyezi a Microsoft Entra-azonosító hitelesítését a Folyamat nevébenhasználatával.
UsernamePasswordCredential

Engedélyezi a Microsoft Entra-azonosító hitelesítését egy 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

A Visual Studio Code Azure Resources bővítményén keresztül bejelentkezett felhasználói fiókkal 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.
WorkloadIdentityCredential

A számítási feladatok identitásának hitelesítése az Azure egyik funkciója, amely lehetővé teszi, hogy a virtuális gépeken (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á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 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 kezelni és elforgatni kell a szolgáltatásnevek vagy a felügyelt identitások kezelését és elforgatását. 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 a Microsoft Entra számítási feladatok azonosítójának hitelesítését az Azure Kubernetesben, és az Azure Kubernetes-környezetben elérhető SAC-k használatával szerez be egy jogkivonatot. További információért tekintse meg Microsoft Entra számítási feladatok azonosítóját.

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ővé teszi annak konfigurálását, hogy az identitástár hogyan hajtja végre a hitelesítést a Microsoft Entra ID-nak küldött hitelesítési kérések 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

Engedélyezi a Microsoft Entra-azonosító hitelesítését a rendelkezésre álló környezeti változóktól függően. 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

Megadja annak konfigurálását, hogy az identitástár hogyan küld hitelesítési kéréseket a Microsoft Entra ID-nak.
UsernamePasswordCredentialOptions

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

Lehetőséget biztosít a Visual Studio Code hitelesítő adatainak 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 beépülő modul típusa, amely egy beépülő modul környezetét elfogadó függvény.
OnBehalfOfCredentialOptions

Az OnBehalfOfCredential osztály választható 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"
  • "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 kiterjesztése további funkciókkal. 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,
  },
});

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 kiterjesztése további funkciókkal. 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