Compartir a través de

EnvironmentCredential class

  • Referencia
Paquete:
@azure/identity

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.

Constructores

EnvironmentCredential(EnvironmentCredentialOptions)

Crea una instancia de la clase EnvironmentCredential y decide qué credencial usar en función de las variables de entorno disponibles.

Variables de entorno necesarias:

  • AZURE_TENANT_ID: identificador de inquilino de Microsoft Entra (directorio).
  • AZURE_CLIENT_ID: identificador de cliente (aplicación) de un registro de aplicación en el inquilino.

Si establece el AZURE_TENANT_ID, también puede establecer los inquilinos permitidos adicionales.

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: para las aplicaciones multiinquilino, especifica inquilinos adicionales para los que la credencial puede adquirir tokens con una sola cadena delimitada por punto y coma. Use * para permitir todos los inquilinos.

Variables de entorno usadas para la autenticación de credenciales de cliente:

  • AZURE_CLIENT_SECRET: un secreto de cliente que se generó para el registro de aplicaciones.
  • AZURE_CLIENT_CERTIFICATE_PATH: ruta de acceso a un certificado PEM que se va a usar durante la autenticación, en lugar del secreto de cliente.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (opcional) contraseña para el archivo de certificado.

Como alternativa, los usuarios pueden proporcionar variables de entorno para la autenticación de nombre de usuario y contraseña:

  • AZURE_USERNAME: nombre de usuario con el que se va a autenticar.
  • AZURE_PASSWORD: contraseña con la que se va a autenticar.

Si faltan las variables de entorno necesarias para realizar la autenticación, se producirá un credentialUnavailableError . Si se produce un error en la autenticación o si se produce un error desconocido, se producirá un authenticationError .

Métodos

getToken(string | string[], GetTokenOptions)

Se autentica con Microsoft Entra ID y devuelve un token de acceso si se ejecuta correctamente.

Detalles del constructor

EnvironmentCredential(EnvironmentCredentialOptions)

Crea una instancia de la clase EnvironmentCredential y decide qué credencial usar en función de las variables de entorno disponibles.

Variables de entorno necesarias:

  • AZURE_TENANT_ID: identificador de inquilino de Microsoft Entra (directorio).
  • AZURE_CLIENT_ID: identificador de cliente (aplicación) de un registro de aplicación en el inquilino.

Si establece el AZURE_TENANT_ID, también puede establecer los inquilinos permitidos adicionales.

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: para las aplicaciones multiinquilino, especifica inquilinos adicionales para los que la credencial puede adquirir tokens con una sola cadena delimitada por punto y coma. Use * para permitir todos los inquilinos.

Variables de entorno usadas para la autenticación de credenciales de cliente:

  • AZURE_CLIENT_SECRET: un secreto de cliente que se generó para el registro de aplicaciones.
  • AZURE_CLIENT_CERTIFICATE_PATH: ruta de acceso a un certificado PEM que se va a usar durante la autenticación, en lugar del secreto de cliente.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (opcional) contraseña para el archivo de certificado.

Como alternativa, los usuarios pueden proporcionar variables de entorno para la autenticación de nombre de usuario y contraseña:

  • AZURE_USERNAME: nombre de usuario con el que se va a autenticar.
  • AZURE_PASSWORD: contraseña con la que se va a autenticar.

Si faltan las variables de entorno necesarias para realizar la autenticación, se producirá un credentialUnavailableError . Si se produce un error en la autenticación o si se produce un error desconocido, se producirá un authenticationError .

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Parámetros

options
EnvironmentCredentialOptions

Opciones para configurar el cliente que realiza la solicitud de autenticación.

Detalles del método

getToken(string | string[], GetTokenOptions)

Se autentica con Microsoft Entra ID y devuelve un token de acceso si se ejecuta correctamente.

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

Parámetros

scopes

string | string[]

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

options
GetTokenOptions

Parámetros opcionales. Consulte GetTokenOptions.

Devoluciones

Promise<AccessToken>