DefaultAzureCredential class

Pacchetto:

@azure/identity

Fornisce un predefinito ChainedTokenCredential configurazione che funziona per la maggior parte delle applicazioni che usano le librerie client di Azure SDK. Per altre informazioni, vedere Panoramica di DefaultAzureCredential.

Verranno provati i tipi di credenziali seguenti, in ordine:

• EnvironmentCredential
• WorkloadIdentityCredential
• ManagedIdentityCredential
• VisualStudioCodeCredential
• AzureCliCredential
• AzurePowerShellCredential
• AzureDeveloperCliCredential
• BrokerCredential (una credenziale abilitata per il broker che richiede @azure/identity-broker è installata)

Per altre informazioni su come tentano l'autenticazione, vedere la documentazione di questi tipi di credenziali.

Nell'esempio seguente viene illustrato come utilizzare l'opzione requiredEnvVars per assicurarsi che vengano impostate determinate variabili di ambiente prima che venga creata un'istanza DefaultAzureCredential . Se una delle variabili di ambiente specificate è mancante o vuota, verrà generato un errore, impedendo all'applicazione di continuare l'esecuzione senza la configurazione necessaria. Viene inoltre illustrato come impostare la AZURE_TOKEN_CREDENTIALS variabile di ambiente per controllare quali credenziali sono incluse nella catena.

import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential({
  requiredEnvVars: [
    "AZURE_CLIENT_ID",
    "AZURE_TENANT_ID",
    "AZURE_CLIENT_SECRET",
    "AZURE_TOKEN_CREDENTIALS",
  ],
});

Extends

ChainedTokenCredential

Costruttori

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)	Crea un'istanza della classe DefaultAzureCredential con DefaultAzureCredentialClientIdOptions.
DefaultAzureCredential(DefaultAzureCredentialOptions)	Crea un'istanza della classe DefaultAzureCredential con DefaultAzureCredentialOptions.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)	Crea un'istanza della classe DefaultAzureCredential con DefaultAzureCredentialResourceIdOptions.

Metodi ereditati

getToken(string | string[], GetTokenOptions)

Restituisce il primo token di accesso restituito da una delle implementazioni di TokenCredential concatenati. Genera un AggregateAuthenticationError quando una o più credenziali generano un AuthenticationError e nessuna credenziale ha restituito un token di accesso. Questo metodo viene chiamato automaticamente dalle librerie client di Azure SDK. È possibile chiamare direttamente questo metodo, ma è anche necessario gestire la memorizzazione nella cache dei token e l'aggiornamento dei token.

Dettagli costruttore

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

Crea un'istanza della classe DefaultAzureCredential con DefaultAzureCredentialClientIdOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)

Parametri

options

DefaultAzureCredentialClientIdOptions

Parametri facoltativi. Vedere DefaultAzureCredentialClientIdOptions.

DefaultAzureCredential(DefaultAzureCredentialOptions)

Crea un'istanza della classe DefaultAzureCredential con DefaultAzureCredentialOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)

Parametri

options

DefaultAzureCredentialOptions

Parametri facoltativi. Vedere DefaultAzureCredentialOptions.

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

Crea un'istanza della classe DefaultAzureCredential con DefaultAzureCredentialResourceIdOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)

Parametri

options

DefaultAzureCredentialResourceIdOptions

Parametri facoltativi. Vedere DefaultAzureCredentialResourceIdOptions.

Dettagli dei metodi ereditati

getToken(string | string[], GetTokenOptions)

Restituisce il primo token di accesso restituito da una delle implementazioni di TokenCredential concatenati. Genera un AggregateAuthenticationError quando una o più credenziali generano un AuthenticationError e nessuna credenziale ha restituito un token di accesso.

Questo metodo viene chiamato automaticamente dalle librerie client di Azure SDK. È possibile chiamare direttamente questo metodo, ma è anche necessario gestire la memorizzazione nella cache dei token e l'aggiornamento dei token.

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

Le opzioni usate per configurare le richieste che questa TokenCredential implementazione potrebbe effettuare.

Restituisce

Promise<AccessToken>

ereditato dachainedTokenCredential.getToken