EnvironmentCredential class
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.
Konstruktorok
Environment |
Létrehozza az 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:
Másik lehetőségként a felhasználók környezeti változókat is megadhatnak a felhasználónév- és jelszóhitelesítéshez:
Ha a hitelesítés végrehajtásához szükséges környezeti változók hiányoznak, egy CredentialUnavailableError hibaüzenet jelenik meg. Ha a hitelesítés sikertelen, vagy ismeretlen hiba történik, a rendszer egy AuthenticationError hibát jelez. |
Metódusok
get |
Hitelesítés Microsoft Entra ID, és sikeres esetben egy hozzáférési jogkivonatot ad vissza. |
Konstruktor adatai
EnvironmentCredential(EnvironmentCredentialOptions)
Létrehozza az 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
: Egy 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 olyan további bérlőket határoz meg, amelyekhez a hitelesítő adatok jogkivonatokat szerezhetnek be egyetlen pontosvesszővel tagolt sztringgel. 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 titkos ügyfélkód.AZURE_CLIENT_CERTIFICATE_PATH
: A hitelesítés során használandó PEM-tanúsítvány elérési útja az ügyfél titkos kódja helyett.AZURE_CLIENT_CERTIFICATE_PASSWORD
: (nem kötelező) a tanúsítványfájl jelszava.
Másik lehetőségként a felhasználók környezeti változókat is megadhatnak a felhasználónév- és jelszóhitelesítéshez:
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 hibaüzenet jelenik meg. Ha a hitelesítés sikertelen, vagy ismeretlen hiba történik, a rendszer egy AuthenticationError hibát jelez.
new EnvironmentCredential(options?: EnvironmentCredentialOptions)
Paraméterek
- options
- EnvironmentCredentialOptions
A hitelesítési kérést küldő ügyfél konfigurálásának beállításai.
Metódus adatai
getToken(string | string[], GetTokenOptions)
Hitelesítés Microsoft Entra ID, é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
Választható paraméterek. Lásd: GetTokenOptions.
Válaszok
Promise<AccessToken>