Delen via

EnvironmentCredential class

  • Referentie
Pakket:
@azure/identity

Hiermee schakelt u verificatie in voor Microsoft Entra-id met behulp van een clientgeheim of certificaat, of als gebruiker met een gebruikersnaam en wachtwoord.

Constructors

EnvironmentCredential(EnvironmentCredentialOptions)

Hiermee maakt u een exemplaar van de klasse EnvironmentCredential en bepaalt u welke referenties moeten worden gebruikt, afhankelijk van de beschikbare omgevingsvariabelen.

Vereiste omgevingsvariabelen:

  • AZURE_TENANT_ID: de tenant-id (directory) van Microsoft Entra.
  • AZURE_CLIENT_ID: de client-id (toepassing) van een app-registratie in de tenant.

Als u de AZURE_TENANT_ID instelt, kunt u ook de extra toegestane tenants instellen

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: voor toepassingen met meerdere tenants geeft u extra tenants op waarvoor de referentie tokens kan verkrijgen met één door puntkomma's gescheiden tekenreeks. Gebruik * om alle tenants toe te staan.

Omgevingsvariabelen die worden gebruikt voor verificatie van clientreferenties:

  • AZURE_CLIENT_SECRET: een clientgeheim dat is gegenereerd voor de app-registratie.
  • AZURE_CLIENT_CERTIFICATE_PATH: het pad naar een PEM-certificaat dat tijdens de verificatie moet worden gebruikt, in plaats van het clientgeheim.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (optioneel) wachtwoord voor het certificaatbestand.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (optioneel) geeft aan dat de certificaatketen moet worden ingesteld in x5c-header ter ondersteuning van verificatie op basis van onderwerpnaam/verlener.

Gebruikers kunnen ook omgevingsvariabelen opgeven voor verificatie met gebruikersnaam en wachtwoord:

  • AZURE_USERNAME: gebruikersnaam waarmee moet worden geverifieerd.
  • AZURE_PASSWORD: wachtwoord waarmee moet worden geverifieerd.

Als de omgevingsvariabelen die nodig zijn om de verificatie uit te voeren ontbreken, wordt er een CredentialUnavailableError- gegenereerd. Als de verificatie mislukt of als er een onbekende fout optreedt, wordt er een AuthenticationError- gegenereerd.

Methoden

getToken(string | string[], GetTokenOptions)

Verifieert met Microsoft Entra-id en retourneert een toegangstoken als dit lukt.

Constructordetails

EnvironmentCredential(EnvironmentCredentialOptions)

Hiermee maakt u een exemplaar van de klasse EnvironmentCredential en bepaalt u welke referenties moeten worden gebruikt, afhankelijk van de beschikbare omgevingsvariabelen.

Vereiste omgevingsvariabelen:

  • AZURE_TENANT_ID: de tenant-id (directory) van Microsoft Entra.
  • AZURE_CLIENT_ID: de client-id (toepassing) van een app-registratie in de tenant.

Als u de AZURE_TENANT_ID instelt, kunt u ook de extra toegestane tenants instellen

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: voor toepassingen met meerdere tenants geeft u extra tenants op waarvoor de referentie tokens kan verkrijgen met één door puntkomma's gescheiden tekenreeks. Gebruik * om alle tenants toe te staan.

Omgevingsvariabelen die worden gebruikt voor verificatie van clientreferenties:

  • AZURE_CLIENT_SECRET: een clientgeheim dat is gegenereerd voor de app-registratie.
  • AZURE_CLIENT_CERTIFICATE_PATH: het pad naar een PEM-certificaat dat tijdens de verificatie moet worden gebruikt, in plaats van het clientgeheim.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (optioneel) wachtwoord voor het certificaatbestand.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (optioneel) geeft aan dat de certificaatketen moet worden ingesteld in x5c-header ter ondersteuning van verificatie op basis van onderwerpnaam/verlener.

Gebruikers kunnen ook omgevingsvariabelen opgeven voor verificatie met gebruikersnaam en wachtwoord:

  • AZURE_USERNAME: gebruikersnaam waarmee moet worden geverifieerd.
  • AZURE_PASSWORD: wachtwoord waarmee moet worden geverifieerd.

Als de omgevingsvariabelen die nodig zijn om de verificatie uit te voeren ontbreken, wordt er een CredentialUnavailableError- gegenereerd. Als de verificatie mislukt of als er een onbekende fout optreedt, wordt er een AuthenticationError- gegenereerd.

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Parameters

options
EnvironmentCredentialOptions

Opties voor het configureren van de client die de verificatieaanvraag doet.

Methodedetails

getToken(string | string[], GetTokenOptions)

Verifieert met Microsoft Entra-id en retourneert een toegangstoken als dit lukt.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Parameters

scopes

string | string[]

De lijst met bereiken waartoe het token toegang heeft.

options
GetTokenOptions

Optionele parameters. Zie GetTokenOptions-.

Retouren

Promise<AccessToken>