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:
- EnvironmentCredential-
- WorkloadIdentityCredential-
- ManagedIdentityCredential-
- VisualStudioCodeCredential
- AzureCliCredential-
- AzurePowerShellCredential-
- AzureDeveloperCliCredential-
Raadpleeg de documentatie van deze referentietypen voor meer informatie over hoe ze verificatie proberen uit te voeren.
Referenties selecteren
Stel de AZURE_TOKEN_CREDENTIALS van de omgevingsvariabele in om een subset van de referentieketen te selecteren. DefaultAzureCredential probeert alleen de opgegeven referentie(s), maar het andere gedrag blijft hetzelfde. Geldige waarden voor AZURE_TOKEN_CREDENTIALS zijn de naam van één type in de bovenstaande keten, bijvoorbeeld 'EnvironmentCredential' of 'AzureCliCredential', en de volgende speciale waarden:
- "dev": probeer [VisualStudioCodeCredential], [AzureCliCredential], [AzurePowerShellCredential] en [AzureDeveloperCliCredential], in die volgorde
- "prod": probeer [EnvironmentCredential], [WorkloadIdentityCredential] en [ManagedIdentityCredential], in die volgorde
- Uitbreiding
Constructors
| Default |
Hiermee maakt u een exemplaar van de klasse DefaultAzureCredential met DefaultAzureCredentialClientIdOptions. |
| Default |
Hiermee maakt u een exemplaar van de klasse DefaultAzureCredential met DefaultAzureCredentialOptions. |
| Default |
Hiermee maakt u een exemplaar van de klasse DefaultAzureCredential met DefaultAzureCredentialResourceIdOptions. |
Overgenomen methoden
| get |
Retourneert het eerste toegangstoken dat wordt geretourneerd door een van de gekoppelde 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
Optionele parameters. Zie DefaultAzureCredentialClientIdOptions-.
DefaultAzureCredential(DefaultAzureCredentialOptions)
Hiermee maakt u een exemplaar van de klasse DefaultAzureCredential met DefaultAzureCredentialOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)Parameters
- options
- DefaultAzureCredentialOptions
Optionele parameters. Zie DefaultAzureCredentialOptions-.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)
Hiermee maakt u een exemplaar van de klasse DefaultAzureCredential met DefaultAzureCredentialResourceIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)Parameters
Optionele parameters. Zie DefaultAzureCredentialResourceIdOptions.
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-