Compartir a través de

@azure/identity package

  • Referencia

Clases

AggregateAuthenticationError

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

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

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

Habilita la autenticación para Microsoft Entra ID mediante un código de autorización que se obtuvo a través del flujo de código de autorización, que se describe con más detalle en la documentación de Microsoft Entra ID:

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

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

Azure Developer CLI es una herramienta de interfaz de línea de comandos que permite a los desarrolladores crear, administrar e implementar recursos en Azure. Se basa en la CLI de Azure y proporciona funcionalidad adicional específica para los desarrolladores de Azure. Permite a los usuarios autenticarse como un usuario o una entidad de servicio en Microsoft Entra ID. AzureDeveloperCliCredential se autentica en un entorno de desarrollo y adquiere un token en nombre del usuario o la entidad de servicio que ha iniciado sesión en la Azure Developer CLI. Actúa como el Azure Developer CLI ha iniciado sesión en el usuario o la entidad de servicio y ejecuta un comando de la CLI de Azure debajo para autenticar la aplicación en Microsoft Entra ID.

Configuración de AzureDeveloperCliCredential

Para usar esta credencial, el desarrollador debe autenticarse localmente en Azure Developer CLI mediante uno de los siguientes comandos:

  1. Ejecute "azd auth login" en Azure Developer CLI para autenticarse 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 determinado período de tiempo, en función de la validez del token de actualización de su organización. Por lo general, este período de validez es de unas semanas o unos meses. AzureDeveloperCliCredential le pedirá que vuelva a iniciar sesión.
AzurePowerShellCredential

Esta credencial usará la información del usuario que ha iniciado sesión actualmente desde el módulo Azure PowerShell. Para ello, leerá el token de acceso de usuario y expirará el tiempo con Azure PowerShell comando.Get-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

Permite probar varias TokenCredential implementaciones en orden hasta que uno de los métodos getToken devuelva un token de acceso.
ClientAssertionCredential

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

Permite la autenticación para Microsoft Entra ID mediante un certificado codificado en PEM asignado 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/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad
ClientSecretCredential

Habilita la autenticación para Microsoft Entra ID mediante un secreto de cliente que se generó 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
CredentialUnavailableError

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.
DefaultAzureCredential

Proporciona una configuración chainedTokenCredential predeterminada que debe funcionar para la mayoría de las aplicaciones que usan el SDK de Azure.
DeviceCodeCredential

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

Permite la autenticación Microsoft Entra ID mediante un secreto de cliente o certificado, o como usuario con un nombre de usuario y una contraseña.
InteractiveBrowserCredential

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

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, App Service instancias, aplicaciones Azure Functions, Azure Kubernetes Services, instancias de Azure Service Fabric y dentro de azure Cloud Shell.

Puede encontrar más información sobre la configuración de identidades administradas aquí: https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
OnBehalfOfCredential

Habilita la autenticación para Microsoft Entra ID mediante el flujo En nombre de .
UsernamePasswordCredential

Permite la autenticación para Microsoft Entra ID con el nombre de usuario y la contraseña de un 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.
VisualStudioCodeCredential

Se conecta a Azure mediante la credencial proporcionada por la extensión de VSCode "Cuenta de Azure". 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é.

Se trata de un problema conocido que esta credencial no funciona con las versiones de la extensión de la cuenta de Azure más recientes que 0.9.11. Está en curso una corrección a largo plazo de este problema. Mientras tanto, considere la posibilidad de autenticarse con AzureCliCredential.
WorkloadIdentityCredential

La autenticación de identidad de carga de trabajo es una característica de Azure que permite a las aplicaciones que se ejecutan en máquinas virtuales (VM) acceder a otros recursos de Azure sin necesidad de una entidad de servicio o una identidad administrada. 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 segundo plano, la autenticación de identidad de carga de trabajo usa el concepto de credenciales de cuenta de servicio (SACs), que Azure crea automáticamente y almacena de forma segura en la máquina virtual. Mediante la autenticación de identidad de carga de trabajo, puede evitar la necesidad de administrar e rotar las entidades de servicio o las identidades administradas para cada aplicación de cada máquina virtual. Además, dado que Azure crea y administra automáticamente las SACs, no es necesario preocuparse por almacenar y proteger las credenciales confidenciales. WorkloadIdentityCredential admite la autenticación Id. de carga de trabajo de Microsoft Entra en Azure Kubernetes y adquiere un token mediante las SACs disponibles en el entorno de Azure Kubernetes. Consulte Id. de carga de trabajo de Microsoft Entra para obtener más información.

Interfaces

AccessToken

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

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

Parámetros opcionales para AuthenticationRequiredError
AuthorityValidationOptions

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

Opciones de AuthorizationCodeCredential
AzureCliCredentialOptions

Opciones de AzureCliCredential
AzureDeveloperCliCredentialOptions

Opciones de AzureDeveloperCliCredential
AzurePowerShellCredentialOptions

Opciones de AzurePowerShellCredential
BrokerAuthOptions

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

Parámetros cuando se deshabilita la autenticación del agente wam.
BrokerEnabledOptions

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

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

Opciones de ClientAssertionCredential
ClientCertificateCredentialOptions

Parámetros opcionales para la clase ClientCertificateCredential .
ClientCertificatePEMCertificate

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

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

Parámetros opcionales para la clase ClientSecretCredential .
CredentialPersistenceOptions

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

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

Proporciona opciones para configurar la clase DefaultAzureCredential .
DefaultAzureCredentialResourceIdOptions

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

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

Proporciona el código de usuario y el URI de comprobació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.
EnvironmentCredentialOptions

Habilita la autenticación para Microsoft Entra ID en función de las variables de entorno disponibles. Define las opciones de la clase EnvironmentCredential.
ErrorResponse

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

https://learn.microsoft.com/en-us/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 v2.
GetBearerTokenProviderOptions

Las opciones para configurar el proveedor de tokens.
GetTokenOptions

Define las opciones de TokenCredential.getToken.
InteractiveBrowserCredentialInBrowserOptions

Define las opciones comunes de la clase InteractiveBrowserCredential.
InteractiveBrowserCredentialNodeOptions

Define las opciones comunes de la clase InteractiveBrowserCredential.
InteractiveCredentialOptions

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

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

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

Opciones para aplicaciones multiinquilino que permiten además inquilinos.
OnBehalfOfCredentialCertificateOptions

Define los parámetros para autenticar OnBehalfOfCredential con un certificado.
OnBehalfOfCredentialSecretOptions

Define los parámetros para autenticar OnBehalfOfCredential con un secreto.
TokenCachePersistenceOptions

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

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

Proporciona opciones para configurar cómo la biblioteca de identidades realiza solicitudes de autenticación para Microsoft Entra ID.
UsernamePasswordCredentialOptions

Define las opciones de la clase UsernamePasswordCredential .
VisualStudioCodeCredentialOptions

Proporciona opciones para configurar la credencial de Visual Studio Code.
WorkloadIdentityCredentialOptions

Opciones de WorkloadIdentityCredential

Alias de tipos

BrokerOptions

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

(Característica de 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 redireccionamiento que se inicia. La ventana del explorador existente del usuario no deja la página actual
ClientCertificateCredentialPEMConfiguration

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

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

El tipo de un complemento de Identidad de Azure, una función que acepta un contexto de complemento.
OnBehalfOfCredentialOptions

Parámetros opcionales para la clase OnBehalfOfCredential .

Enumeraciones

AzureAuthorityHosts

Una lista de hosts de autoridad de Azure conocidos

Funciones

deserializeAuthenticationRecord(string)

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"
  • "version"

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.
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

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 } from "@azure/identity";

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}`);
getDefaultAzureCredential()

Devuelve una nueva instancia de DefaultAzureCredential.
serializeAuthenticationRecord(AuthenticationRecord)

Serializa un objeto AuthenticationRecord en una cadena.

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

  • "autoridad"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "nombre de usuario"
  • "version"

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

Amplíe la identidad de Azure 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 { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

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

Detalles de la función

deserializeAuthenticationRecord(string)

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"
  • "version"

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.

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Parámetros

serializedRecord

string

Registro de autenticación serializado previamente en una cadena.

Devoluciones

AuthenticationRecord

AuthenticationRecord.

getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

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 } from "@azure/identity";

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}`);

function getBearerTokenProvider(credential: TokenCredential, scopes: string | string[], options?: GetBearerTokenProviderOptions): () => Promise<string>

Parámetros

credential
TokenCredential

Credencial usada para autenticar la solicitud.

scopes

string | string[]

Ámbitos necesarios para el token de portador.

options
GetBearerTokenProviderOptions

Opciones para configurar el proveedor de tokens.

Devoluciones

() => Promise<string>

devolución de llamada que proporciona un token de portador.

getDefaultAzureCredential()

Devuelve una nueva instancia de DefaultAzureCredential.

function getDefaultAzureCredential(): TokenCredential

Devoluciones

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Serializa un objeto AuthenticationRecord en una cadena.

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

  • "autoridad"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "nombre de usuario"
  • "version"

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

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Parámetros

record
AuthenticationRecord

Devoluciones

string

useIdentityPlugin(IdentityPlugin)

Amplíe la identidad de Azure 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 { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

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

function useIdentityPlugin(plugin: IdentityPlugin)

Parámetros

plugin
IdentityPlugin

complemento que se va a registrar