Delen via


DefaultAzureCredential class

Biedt een standaardconfiguratie ChainedTokenCredential die werkt voor de meeste toepassingen die gebruikmaken van Azure SDK-clientbibliotheken. Zie Overzicht van DefaultAzureCredentialvoor meer informatie.

De volgende referentietypen worden geprobeerd, in volgorde:

Raadpleeg de documentatie van deze referentietypen voor meer informatie over hoe ze verificatie proberen uit te voeren.

In het volgende voorbeeld ziet u hoe u de requiredEnvVars optie kunt gebruiken om ervoor te zorgen dat bepaalde omgevingsvariabelen worden ingesteld voordat deze DefaultAzureCredential wordt geïnstantieerd. Als een van de opgegeven omgevingsvariabelen ontbreekt of leeg is, wordt er een fout gegenereerd, waardoor de toepassing niet kan worden voortgezet zonder de benodigde configuratie. Het laat ook zien hoe u de AZURE_TOKEN_CREDENTIALS omgevingsvariabele instelt om te bepalen welke inloggegevens in de keten worden opgenomen.

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

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

Constructors

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

Hiermee maakt u een exemplaar van de klasse DefaultAzureCredential met DefaultAzureCredentialClientIdOptions.

DefaultAzureCredential(DefaultAzureCredentialOptions)

Hiermee maakt u een exemplaar van de klasse DefaultAzureCredential met DefaultAzureCredentialOptions.

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

Hiermee maakt u een exemplaar van de klasse DefaultAzureCredential met DefaultAzureCredentialResourceIdOptions.

Overgenomen methoden

getToken(string | string[], GetTokenOptions)

Retourneert het eerste toegangstoken dat wordt geretourneerd door een van de gekoppelde TokenCredential implementaties. Hiermee genereert u een AggregateAuthenticationError wanneer een of meer referenties een AuthenticationError- genereert en er geen referenties een toegangstoken hebben geretourneerd.

Deze methode wordt automatisch aangeroepen door Azure SDK-clientbibliotheken. U kunt deze methode rechtstreeks aanroepen, maar u moet ook tokencaching en token vernieuwen afhandelen.

Constructordetails

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

Hiermee maakt u een exemplaar van de klasse DefaultAzureCredential met DefaultAzureCredentialClientIdOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)

Parameters

DefaultAzureCredential(DefaultAzureCredentialOptions)

Hiermee maakt u een exemplaar van de klasse DefaultAzureCredential met DefaultAzureCredentialOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)

Parameters

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

Hiermee maakt u een exemplaar van de klasse DefaultAzureCredential met DefaultAzureCredentialResourceIdOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)

Parameters

Details overgenomen methode

getToken(string | string[], GetTokenOptions)

Retourneert het eerste toegangstoken dat wordt geretourneerd door een van de gekoppelde TokenCredential implementaties. Hiermee genereert u een AggregateAuthenticationError wanneer een of meer referenties een AuthenticationError- genereert en er geen referenties een toegangstoken hebben geretourneerd.

Deze methode wordt automatisch aangeroepen door Azure SDK-clientbibliotheken. U kunt deze methode rechtstreeks aanroepen, maar u moet ook tokencaching en token vernieuwen afhandelen.

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

Parameters

scopes

string | string[]

De lijst met bereiken waartoe het token toegang heeft.

options
GetTokenOptions

De opties die worden gebruikt voor het configureren van aanvragen die deze TokenCredential implementatie kan maken.

Retouren

Promise<AccessToken>

overgenomen vanChainedTokenCredential.getToken-