DefaultAzureCredential class

Paquete:

@azure/identity

Proporciona una configuración predeterminada de ChainedTokenCredential que funciona para la mayoría de las aplicaciones que usan bibliotecas cliente de Azure SDK. Para obtener más información, vea Información general sobre DefaultAzureCredential.

Se probarán los siguientes tipos de credenciales en orden:

• EnvironmentCredential
• WorkloadIdentityCredential
• managedIdentityCredential
• VisualStudioCodeCredential
• azureCliCredential
• azurePowerShellCredential
• azureDeveloperCliCredential
• BrokerCredential (se instala una credencial habilitada para broker que requiere @azure/identity-broker )

Consulte la documentación de estos tipos de credenciales para obtener más información sobre cómo intentan realizar la autenticación.

En el ejemplo siguiente se muestra cómo usar la requiredEnvVars opción para asegurarse de que se establecen determinadas variables de entorno antes de crear una instancia de the DefaultAzureCredential . Si falta alguna de las variables de entorno especificadas o está vacía, se producirá un error, lo que impedirá que la aplicación continúe ejecutándose sin la configuración necesaria. También muestra cómo establecer la variable de AZURE_TOKEN_CREDENTIALS entorno para controlar qué credenciales se incluyen en la cadena.

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

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

Extends

ChainedTokenCredential

Constructores

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)	Crea una instancia de la clase DefaultAzureCredential con DefaultAzureCredentialClientIdOptions.
DefaultAzureCredential(DefaultAzureCredentialOptions)	Crea una instancia de la clase DefaultAzureCredential con DefaultAzureCredentialOptions.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)	Crea una instancia de la clase DefaultAzureCredential con DefaultAzureCredentialResourceIdOptions.

Métodos heredados

getToken(string | string[], GetTokenOptions)

Devuelve el primer token de acceso devuelto por una de las implementaciones de TokenCredential encadenadas. Produce un AggregateAuthenticationError cuando una o varias credenciales inician una AuthenticationError y no se han devuelto un token de acceso. Las bibliotecas cliente del SDK de Azure llaman automáticamente a este método. Puede llamar directamente a este método, pero también debe controlar el almacenamiento en caché de tokens y la actualización de tokens.

Detalles del constructor

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

Crea una instancia de la clase DefaultAzureCredential con DefaultAzureCredentialClientIdOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)

Parámetros

options

DefaultAzureCredentialClientIdOptions

Parámetros opcionales. Consulte DefaultAzureCredentialClientIdOptions.

DefaultAzureCredential(DefaultAzureCredentialOptions)

Crea una instancia de la clase DefaultAzureCredential con DefaultAzureCredentialOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)

Parámetros

options

DefaultAzureCredentialOptions

Parámetros opcionales. Consulte DefaultAzureCredentialOptions.

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

Crea una instancia de la clase DefaultAzureCredential con DefaultAzureCredentialResourceIdOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)

Parámetros

options

DefaultAzureCredentialResourceIdOptions

Parámetros opcionales. Consulte DefaultAzureCredentialResourceIdOptions.

Detalles de los métodos heredados

getToken(string | string[], GetTokenOptions)

Devuelve el primer token de acceso devuelto por una de las implementaciones de TokenCredential encadenadas. Produce un AggregateAuthenticationError cuando una o varias credenciales inician una AuthenticationError y no se han devuelto un token de acceso.

Las bibliotecas cliente del SDK de Azure llaman automáticamente a este método. Puede llamar directamente a este método, pero también debe controlar el almacenamiento en caché de tokens y la actualización de tokens.

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

Parámetros

scopes

string | string[]

Lista de ámbitos para los que el token tendrá acceso.

options

GetTokenOptions

Las opciones que se usan para configurar las solicitudes que puede realizar esta implementación de TokenCredential.

Devoluciones

Promise<AccessToken>

heredado deChainedTokenCredential.getToken