@azure/identity package

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

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.

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

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

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.

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.

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.

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}

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.

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

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/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

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

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

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:

• EnvironmentCredential
• WorkloadIdentityCredential
• ManagedIdentityCredential
• AzureCliCredential
• AzurePowerShellCredential
• AzureDeveloperCliCredential

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.

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.

Engedélyezi a Microsoft Entra-azonosító hitelesítését ügyfélkód vagy tanúsítvány használatával, illetve felhasználónévvel és jelszóval rendelkező felhasználóként.

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.

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/en-us/azure/active-directory/managed-identities-azure-resources/overview

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

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.

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.

Ez egy ismert probléma,, hogy ez a hitelesítő adat nem működik Azure-fiókbővítmény újabb verzióival, mint 0.9.11. A probléma hosszú távú megoldása folyamatban van. Addig is fontolja meg az AzureCliCredentialhitelesítését.

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.

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

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

Választható paraméterek a AuthenticationRequiredError

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.

A AuthorizationCodeCredential beállításai

Az AzureCliCredential beállításai

Az AzureDeveloperCliCredential beállításai

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

Az AzurePowerShellCredential beállításai

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

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

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

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

Az ClientAssertionCredential beállításai

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

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

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

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

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

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.

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

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.

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

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.

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.

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áshoz készült, de a hibaválasz részletei továbbra is érvényesek a 2- es verzióra.

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

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

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

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

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

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.

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

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.

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

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

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

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

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

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

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.

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

Lehetőséget biztosít a Visual Studio Code hitelesítő adatainak konfigurálására.

A WorkloadIdentityCredential beállításai

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

(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

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.

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.

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

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

Ismert Azure-szolgáltatói gazdagépek listája

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

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

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

Sztringgé szerializál egy 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 ezt a sztringet később szerializált AuthenticationRecordszeretné konvertálni, használja az exportált függvényt deserializeAuthenticationRecord().

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