Condividi tramite

EnvironmentCredential class

  • Riferimento
Pacchetto:
@azure/identity

Consente l'autenticazione per Microsoft Entra ID usando un segreto client o un certificato oppure come utente con un nome utente e una password.

Costruttori

EnvironmentCredential(EnvironmentCredentialOptions)

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

Variabili di ambiente necessarie:

  • AZURE_TENANT_ID: ID Microsoft Entra tenant (directory).
  • AZURE_CLIENT_ID: ID client (applicazione) di una registrazione 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 punti 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: (facoltativo) password per il file di certificato.

In alternativa, gli utenti possono fornire variabili di ambiente per l'autenticazione di nome utente e password:

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

Se le variabili di ambiente necessarie per eseguire l'autenticazione sono mancanti, verrà generato un errore CredentialUnavailableError . Se l'autenticazione ha esito negativo o se si verifica un errore sconosciuto, verrà generato un authenticationError .

Metodi

getToken(string | string[], GetTokenOptions)

Esegue l'autenticazione con Microsoft Entra ID e restituisce un token di accesso se ha 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 necessarie:

  • AZURE_TENANT_ID: ID Microsoft Entra tenant (directory).
  • AZURE_CLIENT_ID: ID client (applicazione) di una registrazione 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 punti 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: (facoltativo) password per il file di certificato.

In alternativa, gli utenti possono fornire variabili di ambiente per l'autenticazione di nome utente e password:

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

Se le variabili di ambiente necessarie per eseguire l'autenticazione sono mancanti, verrà generato un errore CredentialUnavailableError . Se l'autenticazione ha esito negativo o se si verifica un errore sconosciuto, verrà generato un 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 se ha 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>