Condividi tramite

EnvironmentCredential class

Pacchetto:
@azure/identity

Abilita l'autenticazione all'ID Microsoft Entra utilizzando un segreto client o un certificato.

Costruttori

EnvironmentCredential(EnvironmentCredentialOptions)

Crea un'istanza della classe EnvironmentCredential e decide quali credenziali usare a seconda delle variabili di ambiente disponibili.

Variabili di ambiente obbligatorie:

  • AZURE_TENANT_ID: ID tenant (directory) di Microsoft Entra.
  • AZURE_CLIENT_ID: ID client (applicazione) di una registrazione dell'app nel tenant.

Se si imposta il AZURE_TENANT_ID, è anche possibile impostare i tenant consentiti

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: per le applicazioni multi-tenant, specifica tenant aggiuntivi per i quali le credenziali possono acquisire token con una singola stringa delimitata da punto e virgola. Usare * per consentire tutti i tenant.

Variabili di ambiente usate per l'autenticazione delle credenziali client:

  • AZURE_CLIENT_SECRET: segreto client generato per la registrazione dell'app.
  • AZURE_CLIENT_CERTIFICATE_PATH: percorso di un certificato PEM da usare durante l'autenticazione, anziché il segreto client.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (facoltativa) password per il file di certificato.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (facoltativo) indica che la catena di certificati deve essere impostata nell'intestazione x5c per supportare l'autenticazione basata su nome soggetto/autorità di certificazione.

L'autenticazione con nome utente e password è deprecata, poiché non supporta l'autenticazione a più fattori (MFA). Per altri dettagli, vedere https://aka.ms/azsdk/identity/mfa. Gli utenti possono comunque fornire variabili di ambiente per questo metodo di autenticazione:

  • AZURE_USERNAME: nome utente con cui eseguire l'autenticazione.
  • AZURE_PASSWORD: password con cui eseguire l'autenticazione.

Se mancano le variabili di ambiente necessarie per eseguire l'autenticazione, verrà generata una CredentialUnavailableError. Se l'autenticazione non riesce o se si verifica un errore sconosciuto, verrà generata una AuthenticationError.

Metodi

getToken(string | string[], GetTokenOptions)

Esegue l'autenticazione con Microsoft Entra ID e restituisce un token di accesso in caso di esito positivo.

Dettagli costruttore

EnvironmentCredential(EnvironmentCredentialOptions)

Crea un'istanza della classe EnvironmentCredential e decide quali credenziali usare a seconda delle variabili di ambiente disponibili.

Variabili di ambiente obbligatorie:

  • AZURE_TENANT_ID: ID tenant (directory) di Microsoft Entra.
  • AZURE_CLIENT_ID: ID client (applicazione) di una registrazione dell'app nel tenant.

Se si imposta il AZURE_TENANT_ID, è anche possibile impostare i tenant consentiti

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: per le applicazioni multi-tenant, specifica tenant aggiuntivi per i quali le credenziali possono acquisire token con una singola stringa delimitata da punto e virgola. Usare * per consentire tutti i tenant.

Variabili di ambiente usate per l'autenticazione delle credenziali client:

  • AZURE_CLIENT_SECRET: segreto client generato per la registrazione dell'app.
  • AZURE_CLIENT_CERTIFICATE_PATH: percorso di un certificato PEM da usare durante l'autenticazione, anziché il segreto client.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (facoltativa) password per il file di certificato.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (facoltativo) indica che la catena di certificati deve essere impostata nell'intestazione x5c per supportare l'autenticazione basata su nome soggetto/autorità di certificazione.

L'autenticazione con nome utente e password è deprecata, poiché non supporta l'autenticazione a più fattori (MFA). Per altri dettagli, vedere https://aka.ms/azsdk/identity/mfa. Gli utenti possono comunque fornire variabili di ambiente per questo metodo di autenticazione:

  • AZURE_USERNAME: nome utente con cui eseguire l'autenticazione.
  • AZURE_PASSWORD: password con cui eseguire l'autenticazione.

Se mancano le variabili di ambiente necessarie per eseguire l'autenticazione, verrà generata una CredentialUnavailableError. Se l'autenticazione non riesce o se si verifica un errore sconosciuto, verrà generata una AuthenticationError.

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Parametri

options
EnvironmentCredentialOptions

Opzioni per la configurazione del client che effettua la richiesta di autenticazione.

Dettagli metodo

getToken(string | string[], GetTokenOptions)

Esegue l'autenticazione con Microsoft Entra ID e restituisce un token di accesso in caso di esito positivo.

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

Parametri

scopes

string | string[]

Elenco di ambiti per i quali il token avrà accesso.

options
GetTokenOptions

Parametri facoltativi. Vedere GetTokenOptions.

Restituisce

Promise<AccessToken>