EnvironmentCredential class
Engedélyezi a Microsoft Entra ID hitelesítését titkos ügyfélkód vagy tanúsítvány használatával.
Konstruktorok
| Environment |
Létrehozza a EnvironmentCredential osztály egy példányát, és az elérhető környezeti változóktól függően dönti el, hogy milyen hitelesítő adatokat használjon. Szükséges környezeti változók:
Ha beállítja a AZURE_TENANT_ID, akkor a további engedélyezett bérlőket is beállíthatja
Az ügyfél hitelesítő adatainak hitelesítéséhez használt környezeti változók:
A felhasználónév- és jelszóhitelesítés elavult, mivel nem támogatja a többtényezős hitelesítést (MFA). További részletekért lásd a https://aka.ms/azsdk/identity/mfa. A felhasználók továbbra is megadhatnak környezeti változókat ehhez a hitelesítési módszerhez:
Ha a hitelesítés végrehajtásához szükséges környezeti változók hiányoznak, egy CredentialUnavailableError fog dobni. Ha a hitelesítés sikertelen, vagy ismeretlen hiba történik, a rendszer AuthenticationError küld. |
Metódusok
| get |
Hitelesít a Microsoft Entra-azonosítóval, és sikeres esetben egy hozzáférési jogkivonatot ad vissza. |
Konstruktor adatai
EnvironmentCredential(EnvironmentCredentialOptions)
Létrehozza a EnvironmentCredential osztály egy példányát, és az elérhető környezeti változóktól függően dönti el, hogy milyen hitelesítő adatokat használjon.
Szükséges környezeti változók:
-
AZURE_TENANT_ID: A Microsoft Entra-bérlő (címtár) azonosítója. -
AZURE_CLIENT_ID: Az alkalmazásregisztráció ügyfél-(alkalmazás-) azonosítója a bérlőben.
Ha beállítja a AZURE_TENANT_ID, akkor a további engedélyezett bérlőket is beállíthatja
-
AZURE_ADDITIONALLY_ALLOWED_TENANTS: Több-bérlős alkalmazások esetén további bérlőket határoz meg, amelyekhez a hitelesítő adatok egyetlen pontosvesszővel tagolt sztringgel szerezhetnek jogkivonatokat. Használja a * lehetőséget az összes bérlő engedélyezéséhez.
Az ügyfél hitelesítő adatainak hitelesítéséhez használt környezeti változók:
-
AZURE_CLIENT_SECRET: Az alkalmazásregisztrációhoz létrehozott ügyfélkód. -
AZURE_CLIENT_CERTIFICATE_PATH: A hitelesítés során használni kívánt PEM-tanúsítvány elérési útja az ügyfélkód helyett. -
AZURE_CLIENT_CERTIFICATE_PASSWORD: (nem kötelező) jelszó a tanúsítványfájlhoz. -
AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (nem kötelező) azt jelzi, hogy a tanúsítványláncot x5c fejlécben kell beállítani a tulajdonosnév/kiállítóalapú hitelesítés támogatásához.
A felhasználónév- és jelszóhitelesítés elavult, mivel nem támogatja a többtényezős hitelesítést (MFA). További részletekért lásd a https://aka.ms/azsdk/identity/mfa. A felhasználók továbbra is megadhatnak környezeti változókat ehhez a hitelesítési módszerhez:
-
AZURE_USERNAME: A hitelesítéshez használt felhasználónév. -
AZURE_PASSWORD: Jelszó a hitelesítéshez.
Ha a hitelesítés végrehajtásához szükséges környezeti változók hiányoznak, egy CredentialUnavailableError fog dobni. Ha a hitelesítés sikertelen, vagy ismeretlen hiba történik, a rendszer AuthenticationError küld.
new EnvironmentCredential(options?: EnvironmentCredentialOptions)Paraméterek
- options
- EnvironmentCredentialOptions
A hitelesítési kérelmet küldő ügyfél konfigurálásának beállításai.
Metódus adatai
getToken(string | string[], GetTokenOptions)
Hitelesít a Microsoft Entra-azonosítóval, és sikeres esetben egy hozzáférési jogkivonatot ad vissza.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>Paraméterek
- scopes
-
string | string[]
Azon hatókörök listája, amelyekhez a jogkivonatnak hozzáférése lesz.
- options
- GetTokenOptions
Nem kötelező paraméterek. Lásd: GetTokenOptions.
Válaszok
Promise<AccessToken>