@azure/identity package

Proporciona una matriz de errors que contiene instancia de AuthenticationError para los errores de autenticación de las credenciales de un ChainedTokenCredential.

Proporciona detalles sobre un fallo al autenticarse con Azure Active Directory. El campo errorResponse contiene más detalles sobre el error específico.

Error usado para aplicar la autenticación después de intentar recuperar un token de forma silenciosa.

Permite la autenticación de Microsoft Entra ID utilizando un código de autorización obtenido a través del flujo de código de autorización, descrito con más detalle en la documentación de Microsoft Entra ID:

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow

Esta credencial utilizará la información de inicio de sesión del usuario actualmente registrada a través de la herramienta de línea de comandos CLI de Azure ('az'). Para ello, leerá el token de acceso de usuario y el tiempo de caducidad con el comando de CLI de Azure "az account get-access-token".

Azure Developer CLI es una herramienta de interfaz de línea de comandos que permite a los desarrolladores crear, gestionar y desplegar recursos en Azure. Está construido sobre la CLI de Azure y ofrece funcionalidades adicionales específicas para desarrolladores de Azure. Permite a los usuarios autenticarse como usuario y/o como principal de servicio contra Microsoft Entra ID. El AzureDeveloperClidential se autentica en un entorno de desarrollo y adquiere un token en nombre del usuario o principal del servicio iniciado sesión en la CLI de Azure Developer. Actúa como el usuario o principal de servicio conectado por la CLI de Azure Developer y ejecuta un comando de CLI de Azure debajo para autenticar la aplicación frente a Microsoft Entra ID.

Configuración de AzureDeveloperCliCredential

Para usar esta credencial, el desarrollador necesita autenticarse localmente en la CLI de Azure Developer usando uno de los comandos siguientes:

1. Ejecuta "azd auth login" en la CLI de Azure Developer para autenticarte de forma interactiva como usuario.
2. Ejecute "azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID" para autenticarse como entidad de servicio.

Es posible que tenga que repetir este proceso después de un período de tiempo determinado, en función de la validez del token de actualización de la organización. Por lo general, el período de validez del token de actualización es de unas semanas a unos meses. AzureDeveloperCliCredential le pedirá que vuelva a iniciar sesión.

Esta credencial está diseñada para usarse en Azure Pipelines con conexiones de servicio como una configuración para la federación de identidades de carga de trabajo.

Esta credencial utilizará la información de usuario actualmente registrada del módulo de Azure PowerShell. Para ello, leerá el token de acceso de usuario y la fecha de caducidad con Azure PowerShell comando Get-AzAccessToken -ResourceUrl {ResourceScope}

Permite probar varias implementaciones de TokenCredential en orden hasta que uno de los métodos getToken devuelva un token de acceso. Para obtener más información, consulte Información general sobre ChainedTokenCredential.

Autentica una entidad de servicio con una aserción de JWT.

Permite la autenticación a Microsoft Entra ID usando un certificado codificado en PEM que se asigna a un Registro de Aplicaciones. Puede encontrar más información sobre cómo configurar la autenticación de certificados aquí:

https://learn.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

Permite la autenticación a Microsoft Entra ID usando un secreto de cliente generado para un registro de aplicaciones. Puede encontrar más información sobre cómo configurar un secreto de cliente aquí:

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

Esto significa que la credencial que se intentó en una credencial encadenada no estaba disponible para usarse como credencial. En lugar de tratar esto como un error que debe detener la cadena, se detecta y la cadena continúa.

Proporciona una configuración predeterminada ChainedTokenCredential que funciona para la mayoría de aplicaciones que utilizan bibliotecas SDK de Azure cliente. Para obtener más información, consulte 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",
  ],
});

Permite la autenticación Microsoft Entra ID usando un código de dispositivo que el usuario puede introducir en https://microsoft.com/devicelogin.

Permite la autenticación a Microsoft Entra ID usando un secreto o certificado de cliente.

Permite la autenticación de Microsoft Entra ID dentro del navegador web mediante el flujo de inicio de sesión interactivo.

Intenta la autenticación mediante una identidad administrada disponible en el entorno de implementación. Este tipo de autenticación funciona en máquinas virtuales de Azure, instancias de App Service, aplicaciones de Azure Functions, servicios de Azure Kubernetes, instancias de Azure Service Fabric y dentro de Azure Cloud Shell.

Puede encontrar más información sobre cómo configurar identidades administradas aquí: https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview

Permite la autenticación Microsoft Entra ID usando el En nombre de flow.

Permite la autenticación a Microsoft Entra ID con el nombre de usuario y la contraseña del usuario. Esta credencial requiere un alto grado de confianza, por lo que solo se debe usar cuando no se pueden usar otros tipos de credenciales más seguros.

Se conecta a Azure usando la cuenta de usuario iniciada a través de la extensión de Recursos de Azure en Visual Studio Code. Una vez que el usuario ha iniciado sesión a través de la extensión, esta credencial puede compartir el mismo token de actualización que la extensión almacena en caché.

La autenticación de identidad de carga de trabajo es una función en Azure que permite a aplicaciones que se ejecutan en máquinas virtuales (VMs) acceder a otros recursos de Azure sin necesidad de un principal de servicio o identidad gestionada. Con la autenticación de identidad de carga de trabajo, las aplicaciones se autentican mediante su propia identidad, en lugar de usar una entidad de servicio compartida o una identidad administrada. En el fondo, la autenticación de Identidad de Carga de Trabajo utiliza el concepto de Credenciales de Cuenta de Servicio (SAC), que son creadas automáticamente por Azure y almacenadas de forma segura en la máquina virtual. Mediante la autenticación de identidad de carga de trabajo, puede evitar la necesidad de administrar y rotar las entidades de servicio o las identidades administradas para cada aplicación de cada máquina virtual. Además, como los SACs se crean automáticamente y gestionan por Azure, no tienes que preocuparte por almacenar y proteger las credenciales sensibles en sí mismos. WorkloadIdentityCredential soporta la autenticación Id. de carga de trabajo de Microsoft Entra en Azure Kubernetes y adquiere un token usando los SACs disponibles en el entorno Azure Kubernetes. Consulte Id. de carga de trabajo de Microsoft Entra para más información.

Representa un token de acceso con una hora de expiración.

Registro que se va a usar para buscar los tokens almacenados en caché en la memoria caché.

Parámetros opcionales para el AuthenticationRequiredError de

Proporciona opciones para configurar cómo la biblioteca de Identidad realiza la validación de autoridad durante las solicitudes de autenticación a Microsoft Entra ID.

Opciones para la AuthorizationCodeCredential de

Opciones del azureCliCredential de

Opciones del AzureDeveloperCliCredential

Parámetros opcionales para la clase de AzurePipelinesCredential.

Opciones del AzurePowerShellCredential

Opciones de configuración para InteractiveBrowserCredential para admitir la autenticación de Agente WAM.

Parámetros cuando la autenticación del agente WAM está deshabilitada.

Parámetros cuando está habilitada la autenticación del agente WAM.

Opciones de configuración compartidas para la personalización del explorador

Opciones para el ClientAssertionCredential de

Parámetros opcionales para la clase ClientCertificateCredential.

Opciones de configuración necesarias para elclientCertificateCredential de , con el contenido de cadena de un certificado PEM

Opciones de configuración necesarias para elclientCertificateCredential de , con la ruta de acceso a un certificado PEM.

Parámetros opcionales para la clase clientSecretCredential de .

Opciones de configuración compartidas para credenciales que admiten el almacenamiento en caché de tokens persistentes.

Proporciona opciones para configurar la clase DefaultAzureCredential. Esta variación admite managedIdentityClientId y no managedIdentityResourceId, ya que solo se admite una de las dos.

Proporciona opciones para configurar la clase DefaultAzureCredential.

Proporciona opciones para configurar la clase DefaultAzureCredential. Esta variación admite managedIdentityResourceId y no managedIdentityClientId, ya que solo se admite una de las dos.

Define las opciones de la clase InteractiveBrowserCredential para Node.js.

Proporciona el código de usuario y el URI de verificación donde se debe escribir el código. También proporciona un mensaje para mostrar al usuario que contiene una instrucción con estos detalles.

Permite la autenticación a Microsoft Entra ID dependiendo de las variables de entorno disponibles. Define las opciones de la clase EnvironmentCredential.

Consulte la documentación oficial para obtener más detalles:

https://learn.microsoft.com/azure/active-directory/develop/v1-protocols-oauth-code#error-response-1

NOTA: Esta documentación es para la compatibilidad con OAuth v1, pero los mismos detalles de respuesta de error se siguen aplicando a la versión 2.

Las opciones para configurar el proveedor de tokens.

Define las opciones de TokenCredential.getToken.

Define las opciones comunes para la clase InteractiveBrowserCredential.

Define las opciones comunes para la clase InteractiveBrowserCredential.

Opciones de constructor comunes para las credenciales de identidad que requieren la interacción del usuario.

Opciones para enviar en el constructor managedIdentityCredential de . Esta variación admite clientId y no resourceId, ya que solo se admite una de las dos.

Opciones para enviar en el constructor managedIdentityCredential de . Esta variación admite objectId como argumento de constructor.

Opciones para enviar en el constructor managedIdentityCredential de . Esta variación admite resourceId y no clientId, ya que solo se admite una de las dos.

Opciones para aplicaciones multiinquilino que permiten además inquilinos.

Define los parámetros para autenticar el onBehalfOfCredential con una aserción.

Define los parámetros para autenticar el onBehalfOfCredential onBehalfOfCredential con un certificado.

Define los parámetros para autenticar el onBehalfOfCredential con un secreto.

Parámetros que habilitan la persistencia de la caché de tokens en las credenciales de identidad.

Representa una credencial capaz de proporcionar un token de autenticación.

Proporciona opciones para configurar cómo la biblioteca de Identidad realiza las solicitudes de autenticación a Microsoft Entra ID.

Define las opciones de la clase UsernamePasswordCredential.

Ofrece opciones para configurar la credencial de Visual Studio Code.

Opciones del WorkloadIdentityCredential de

Parámetros que habilitan la autenticación de agente WAM en InteractiveBrowserCredential.

(Característica solo explorador) El "estilo de inicio de sesión" que se va a usar en el flujo de autenticación:

• "redirect" redirige al usuario a la página de autenticación y, a continuación, los redirige de nuevo a la página una vez completada la autenticación.
• "popup" abre una nueva ventana del explorador a través de con el flujo de redirección iniciado. La ventana del explorador existente del usuario no deja la página actual

Opciones de configuración necesarias para el ClientCertificateCredential, con el contenido de cadena de un certificado PEM o la ruta de acceso a un certificado PEM.

Las variables de entorno comúnmente admitidas para la clase DefaultAzureCredential .

Define la firma de una devolución de llamada que se pasará a DeviceCodeCredential para mostrar los detalles de autenticación al usuario.

El tipo de un plugin de Azure Identity, una función que acepta un contexto de plugin.

Parámetros opcionales para la clase OnBehalfOfCredential.

Lista de hosts de autoridad conocidos de Azure

Deserializa un registro de autenticación serializado previamente de una cadena en un objeto .

La cadena de entrada debe contener las siguientes propiedades:

• "autoridad"
• "homeAccountId"
• "clientId"
• "tenantId"
• "nombre de usuario"
• "versión"

Si la versión que recibimos no es compatible, se producirá un error.

En este momento, la única versión disponible es: "1.0", que siempre se establece cuando se serializa el registro de autenticación.

Devuelve una devolución de llamada que proporciona un token de portador. Por ejemplo, el token de portador se puede usar para autenticar una solicitud de la siguiente manera:

import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
import { createPipelineRequest } from "@azure/core-rest-pipeline";

const credential = new DefaultAzureCredential();
const scope = "https://cognitiveservices.azure.com/.default";
const getAccessToken = getBearerTokenProvider(credential, scope);
const token = await getAccessToken();

// usage
const request = createPipelineRequest({ url: "https://example.com" });
request.headers.set("Authorization", `Bearer ${token}`);

Devuelve una nueva instancia del DefaultAzureCredential.

Serializa un AuthenticationRecord en una cadena.

La salida de un registro de autenticación serializado contendrá las siguientes propiedades:

• "autoridad"
• "homeAccountId"
• "clientId"
• "tenantId"
• "nombre de usuario"
• "versión"

Para convertir más adelante esta cadena en un AuthenticationRecordserializado, use la función exportada deserializeAuthenticationRecord().

Extiende Azure Identity con funcionalidad adicional. Pase un complemento de un paquete de complementos, como:

• @azure/identity-cache-persistence: proporciona almacenamiento en caché de tokens persistente
• @azure/identity-vscode: proporciona las dependencias de VisualStudioCodeCredential y la habilita.

Ejemplo:

import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);
// The plugin has the capability to extend `DeviceCodeCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DeviceCodeCredential({
  tokenCachePersistenceOptions: {
    enabled: true,
  },
});

El valor Error.name de un ErrorAgregateAuthenticationError

El valor Error.name de un ErrorAutenticaciónError

El valor Error.name de una credencialUnavailable

El AzureLogger utilizado para todos los clientes dentro del paquete de identidad