Dela via

EnvironmentCredential class

  • Referens
Paket:
@azure/identity

Aktiverar autentisering till Microsoft Entra-ID med hjälp av en klienthemlighet eller ett certifikat, eller som en användare med användarnamn och lösenord.

Konstruktorer

EnvironmentCredential(EnvironmentCredentialOptions)

Skapar en instans av klassen EnvironmentCredential och bestämmer vilka autentiseringsuppgifter som ska användas beroende på tillgängliga miljövariabler.

Obligatoriska miljövariabler:

  • AZURE_TENANT_ID: Microsoft Entra-klientorganisationens (katalog)-ID.
  • AZURE_CLIENT_ID: Klient-ID (program) för en appregistrering i klientorganisationen.

Om du ställer in AZURE_TENANT_ID kan du även ange ytterligare tillåtna klienter

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: För program med flera klientorganisationer anger ytterligare klienter för vilka autentiseringsuppgifterna kan hämta token med en enskild semikolonavgränsad sträng. Använd * för att tillåta alla klienter.

Miljövariabler som används för autentisering av klientautentiseringsuppgifter:

  • AZURE_CLIENT_SECRET: En klienthemlighet som genererades för appregistreringen.
  • AZURE_CLIENT_CERTIFICATE_PATH: Sökvägen till ett PEM-certifikat som ska användas under autentiseringen i stället för klienthemligheten.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (valfritt) lösenord för certifikatfilen.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (valfritt) anger att certifikatkedjan ska anges i x5c-huvudet för att stödja ämnesnamn/utfärdarbaserad autentisering.

Alternativt kan användare tillhandahålla miljövariabler för användarnamn och lösenordsautentisering:

  • AZURE_USERNAME: Användarnamn att autentisera med.
  • AZURE_PASSWORD: Lösenord att autentisera med.

Om miljövariablerna som krävs för att utföra autentiseringen saknas genereras en CredentialUnavailableError. Om autentiseringen misslyckas, eller om det finns ett okänt fel, utlöses en AuthenticationError-.

Metoder

getToken(string | string[], GetTokenOptions)

Autentiserar med Microsoft Entra-ID och returnerar en åtkomsttoken om det lyckas.

Konstruktorinformation

EnvironmentCredential(EnvironmentCredentialOptions)

Skapar en instans av klassen EnvironmentCredential och bestämmer vilka autentiseringsuppgifter som ska användas beroende på tillgängliga miljövariabler.

Obligatoriska miljövariabler:

  • AZURE_TENANT_ID: Microsoft Entra-klientorganisationens (katalog)-ID.
  • AZURE_CLIENT_ID: Klient-ID (program) för en appregistrering i klientorganisationen.

Om du ställer in AZURE_TENANT_ID kan du även ange ytterligare tillåtna klienter

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: För program med flera klientorganisationer anger ytterligare klienter för vilka autentiseringsuppgifterna kan hämta token med en enskild semikolonavgränsad sträng. Använd * för att tillåta alla klienter.

Miljövariabler som används för autentisering av klientautentiseringsuppgifter:

  • AZURE_CLIENT_SECRET: En klienthemlighet som genererades för appregistreringen.
  • AZURE_CLIENT_CERTIFICATE_PATH: Sökvägen till ett PEM-certifikat som ska användas under autentiseringen i stället för klienthemligheten.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (valfritt) lösenord för certifikatfilen.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (valfritt) anger att certifikatkedjan ska anges i x5c-huvudet för att stödja ämnesnamn/utfärdarbaserad autentisering.

Alternativt kan användare tillhandahålla miljövariabler för användarnamn och lösenordsautentisering:

  • AZURE_USERNAME: Användarnamn att autentisera med.
  • AZURE_PASSWORD: Lösenord att autentisera med.

Om miljövariablerna som krävs för att utföra autentiseringen saknas genereras en CredentialUnavailableError. Om autentiseringen misslyckas, eller om det finns ett okänt fel, utlöses en AuthenticationError-.

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Parametrar

options
EnvironmentCredentialOptions

Alternativ för att konfigurera klienten som gör autentiseringsbegäran.

Metodinformation

getToken(string | string[], GetTokenOptions)

Autentiserar med Microsoft Entra-ID och returnerar en åtkomsttoken om det lyckas.

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

Parametrar

scopes

string | string[]

Listan över omfång som token ska ha åtkomst till.

options
GetTokenOptions

Valfria parametrar. Se GetTokenOptions.

Returer

Promise<AccessToken>