@azure/identity package
Osztályok
AggregateAuthenticationError |
Egy |
AuthenticationError |
Az Azure Active Directoryval való hitelesítés sikertelenségével kapcsolatos részleteket tartalmaz. A |
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ásaA 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:
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ő, |
ChainedTokenCredential |
Több |
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: |
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: |
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. |
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-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. |
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/en-us/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 |
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 AzureCliCredential |
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 |
AzureDeveloperCliCredentialOptions |
Az AzureDeveloperCliCredential |
AzurePipelinesCredentialOptions |
Az AzurePipelinesCredential osztály |
AzurePowerShellCredentialOptions |
Az AzurePowerShellCredential |
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 |
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 |
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: 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 |
ManagedIdentityCredentialObjectIdOptions |
A ManagedIdentityCredential konstruktoron küldendő beállítások.
Ez a változat konstruktor argumentumként támogatja a |
ManagedIdentityCredentialResourceIdOptions |
A ManagedIdentityCredential konstruktoron küldendő beállítások.
Ez a változat |
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":
|
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. |
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
deserialize |
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:
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. |
get |
Visszahívást ad vissza, amely egy tulajdonosi jogkivonatot biztosít. A tulajdonosi jogkivonat például a következők szerint hitelesíthető:
|
get |
A DefaultAzureCredential |
serialize |
Sztringgé szerializál egy A szerializált hitelesítési rekord kimenete a következő tulajdonságokat tartalmazza:
Ha ezt a sztringet később szerializált |
use |
Az Azure Identity kiterjesztése további funkciókkal. Beépülő modul átadása beépülő modulcsomagból, például:
Példa:
|
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 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.
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
function getDefaultAzureCredential(): TokenCredential
Válaszok
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"
- "tenantId"
- "felhasználónév"
- "verzió"
Ha ezt a sztringet később szerializált AuthenticationRecord
szeretné 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 aVisualStudioCodeCredential
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