Sdílet prostřednictvím

EnvironmentCredential class

  • Reference
Balíček:
@azure/identity

Umožňuje ověřování pro Microsoft Entra ID pomocí tajného klíče klienta nebo certifikátu nebo jako uživatel s uživatelským jménem a heslem.

Konstruktory

EnvironmentCredential(EnvironmentCredentialOptions)

Vytvoří instanci Třídy EnvironmentCredential a rozhodne, jaké přihlašovací údaje se mají použít v závislosti na dostupných proměnných prostředí.

Požadované proměnné prostředí:

  • AZURE_TENANT_ID: ID tenanta Microsoft Entra (adresáře).
  • AZURE_CLIENT_ID: ID klienta (aplikace) registrace aplikace v tenantovi.

Pokud nastavíte AZURE_TENANT_ID, můžete také nastavit další povolené tenanty.

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: U aplikací s více tenanty určuje další tenanty, pro které mohou přihlašovací údaje získat tokeny s jedním středníkem odděleným řetězcem. Pomocí * povolte všechny tenanty.

Proměnné prostředí používané pro ověřování přihlašovacích údajů klienta:

  • AZURE_CLIENT_SECRET: Tajný klíč klienta vygenerovaný pro registraci aplikace.
  • AZURE_CLIENT_CERTIFICATE_PATH: Cesta k certifikátu PEM, který se má použít při ověřování, místo tajného klíče klienta.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (volitelné) heslo pro soubor certifikátu.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (volitelné) označuje, že řetězec certifikátů by měl být nastaven v hlavičce x5c tak, aby podporoval ověřování na základě názvu subjektu nebo vystavitele.

Případně můžou uživatelé zadat proměnné prostředí pro ověřování uživatelským jménem a heslem:

  • AZURE_USERNAME: Uživatelské jméno pro ověření.
  • AZURE_PASSWORD: Heslo pro ověření.

Pokud chybí proměnné prostředí potřebné k provedení ověřování, vyvolá se CredentialUnavailableError. Pokud se ověření nezdaří nebo pokud dojde k neznámé chybě, vyvolá se AuthenticationError.

Metody

getToken(string | string[], GetTokenOptions)

Ověří se pomocí ID Microsoft Entra a v případě úspěchu vrátí přístupový token.

Podrobnosti konstruktoru

EnvironmentCredential(EnvironmentCredentialOptions)

Vytvoří instanci Třídy EnvironmentCredential a rozhodne, jaké přihlašovací údaje se mají použít v závislosti na dostupných proměnných prostředí.

Požadované proměnné prostředí:

  • AZURE_TENANT_ID: ID tenanta Microsoft Entra (adresáře).
  • AZURE_CLIENT_ID: ID klienta (aplikace) registrace aplikace v tenantovi.

Pokud nastavíte AZURE_TENANT_ID, můžete také nastavit další povolené tenanty.

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: U aplikací s více tenanty určuje další tenanty, pro které mohou přihlašovací údaje získat tokeny s jedním středníkem odděleným řetězcem. Pomocí * povolte všechny tenanty.

Proměnné prostředí používané pro ověřování přihlašovacích údajů klienta:

  • AZURE_CLIENT_SECRET: Tajný klíč klienta vygenerovaný pro registraci aplikace.
  • AZURE_CLIENT_CERTIFICATE_PATH: Cesta k certifikátu PEM, který se má použít při ověřování, místo tajného klíče klienta.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (volitelné) heslo pro soubor certifikátu.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (volitelné) označuje, že řetězec certifikátů by měl být nastaven v hlavičce x5c tak, aby podporoval ověřování na základě názvu subjektu nebo vystavitele.

Případně můžou uživatelé zadat proměnné prostředí pro ověřování uživatelským jménem a heslem:

  • AZURE_USERNAME: Uživatelské jméno pro ověření.
  • AZURE_PASSWORD: Heslo pro ověření.

Pokud chybí proměnné prostředí potřebné k provedení ověřování, vyvolá se CredentialUnavailableError. Pokud se ověření nezdaří nebo pokud dojde k neznámé chybě, vyvolá se AuthenticationError.

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Parametry

options
EnvironmentCredentialOptions

Možnosti konfigurace klienta, který provádí žádost o ověření.

Podrobnosti metody

getToken(string | string[], GetTokenOptions)

Ověří se pomocí ID Microsoft Entra a v případě úspěchu vrátí přístupový token.

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

Parametry

scopes

string | string[]

Seznam oborů, pro které bude mít token přístup.

options
GetTokenOptions

Volitelné parametry. Viz GetTokenOptions.

Návraty

Promise<AccessToken>