Compartir a través de

InteractiveBrowserCredentialNodeOptions interface

  • Referencia
Paquete:
@azure/identity

Define las opciones comunes de la clase InteractiveBrowserCredential.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions,BrowserCustomizationOptions,BrokerAuthOptions

Propiedades

clientId

Identificador de cliente (aplicación) de un registro de aplicación en el inquilino.
loginHint

loginHint permite seleccionar previamente un nombre de usuario para los inicios de sesión interactivos. Al establecer esta opción, se omite el símbolo del sistema de selección de la cuenta e intenta iniciar sesión inmediatamente con la cuenta especificada.
redirectUri

Obtiene el URI de redireccionamiento de la aplicación. Debe ser igual que el valor en el portal de registro de aplicaciones. Tiene como valor predeterminado window.location.href. Este campo ya no es necesario para Node.js.
tenantId

Identificador de inquilino (directorio) de Microsoft Entra.

Propiedades heredadas

additionallyAllowedTenants

Para las aplicaciones multiinquilino, especifica inquilinos adicionales para los que la credencial puede adquirir tokens. Agregue el valor de carácter comodín "*" para permitir que la credencial adquiera tokens para cualquier inquilino que esté instalada la aplicación.
additionalPolicies

Directivas adicionales que se van a incluir en la canalización HTTP.
allowInsecureConnection

Se establece en true si la solicitud se envía a través de HTTP en lugar de HTTPS.
authenticationRecord

Resultado de una autenticación anterior que se puede usar para recuperar las credenciales almacenadas en caché de cada cuenta individual. Esto es necesario para proporcionar en caso de que la aplicación quiera trabajar con más de una cuenta por identificador de cliente y par id. de inquilino.

Este registro se puede recuperar llamando al método de authenticate() la credencial, como se indica a continuación:

const authenticationRecord = await credential.authenticate();
authorityHost

Host de autoridad que se va a usar para las solicitudes de autenticación. Los valores posibles están disponibles a través de AzureAuthorityHosts. El valor predeterminado es «https://login.microsoftonline.com"».
brokerOptions

Opciones para permitir la autenticación de agente al usar InteractiveBrowserCredential
browserCustomizationOptions

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

Inicia getToken si es necesario realizar una autenticación manual. Los desarrolladores deberán llamar a para authenticate() controlar cuándo autenticarse manualmente.
disableInstanceDiscovery

El campo determina si se realiza la detección de instancias al intentar autenticarse. Si se establece en true , se deshabilitará completamente la detección de instancias y la validación de autoridad. Como resultado, es fundamental asegurarse de que el host de autoridad configurado sea válido y confiable. Esta funcionalidad está pensada para su uso en escenarios en los que no se puede acceder al punto de conexión de metadatos, como en nubes privadas o Azure Stack. El proceso de detección de instancias implica recuperar los metadatos de autoridad de https://login.microsoft.com/ para validar la autoridad.
httpClient

HttpClient que se usará para enviar solicitudes HTTP.
loggingOptions

Permite a los usuarios configurar las opciones de directiva de registro, permitir el registro de la información de la cuenta y la información de identificación personal para el soporte al cliente.
proxyOptions

Opciones para configurar un proxy para las solicitudes salientes.
redirectOptions

Opciones para controlar las respuestas de redireccionamiento.
retryOptions

Opciones que controlan cómo reintentar las solicitudes con error.
telemetryOptions

Opciones para establecer información de seguimiento y telemetría comunes en las solicitudes salientes.
tlsOptions

Opciones para configurar la autenticación TLS
tokenCachePersistenceOptions

Opciones para proporcionar a la capa de persistencia (si hay alguna disponible) al almacenar credenciales.

Primero debe registrar un complemento de proveedor de persistencia. Consulte el @azure/identity-cache-persistence paquete en NPM.

Ejemplo:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});
userAgentOptions

Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

Detalles de las propiedades

clientId

Identificador de cliente (aplicación) de un registro de aplicación en el inquilino.

clientId?: string

Valor de propiedad

string

loginHint

loginHint permite seleccionar previamente un nombre de usuario para los inicios de sesión interactivos. Al establecer esta opción, se omite el símbolo del sistema de selección de la cuenta e intenta iniciar sesión inmediatamente con la cuenta especificada.

loginHint?: string

Valor de propiedad

string

redirectUri

Obtiene el URI de redireccionamiento de la aplicación. Debe ser igual que el valor en el portal de registro de aplicaciones. Tiene como valor predeterminado window.location.href. Este campo ya no es necesario para Node.js.

redirectUri?: string | () => string

Valor de propiedad

string | () => string

tenantId

Identificador de inquilino (directorio) de Microsoft Entra.

tenantId?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

additionallyAllowedTenants

Para las aplicaciones multiinquilino, especifica inquilinos adicionales para los que la credencial puede adquirir tokens. Agregue el valor de carácter comodín "*" para permitir que la credencial adquiera tokens para cualquier inquilino que esté instalada la aplicación.

additionallyAllowedTenants?: string[]

Valor de propiedad

string[]

Heredado deInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

Directivas adicionales que se van a incluir en la canalización HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de propiedad

AdditionalPolicyConfig[]

Heredado deInteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

Se establece en true si la solicitud se envía a través de HTTP en lugar de HTTPS.

allowInsecureConnection?: boolean

Valor de propiedad

boolean

Heredado deInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Resultado de una autenticación anterior que se puede usar para recuperar las credenciales almacenadas en caché de cada cuenta individual. Esto es necesario para proporcionar en caso de que la aplicación quiera trabajar con más de una cuenta por identificador de cliente y par id. de inquilino.

Este registro se puede recuperar llamando al método de authenticate() la credencial, como se indica a continuación:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Valor de propiedad

AuthenticationRecord

Heredado deInteractiveCredentialOptions.authenticationRecord

authorityHost

Host de autoridad que se va a usar para las solicitudes de autenticación. Los valores posibles están disponibles a través de AzureAuthorityHosts. El valor predeterminado es «https://login.microsoftonline.com"».

authorityHost?: string

Valor de propiedad

string

Heredado deInteractiveCredentialOptions.authorityHost

brokerOptions

Opciones para permitir la autenticación de agente al usar InteractiveBrowserCredential

brokerOptions?: BrokerOptions

Valor de propiedad

BrokerOptions

Heredado deBrokerAuthOptions.brokerOptions

browserCustomizationOptions

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

browserCustomizationOptions?: { errorMessage?: string, successMessage?: string }

Valor de propiedad

{ errorMessage?: string, successMessage?: string }

Heredado deBrowserCustomizationOptions.browserCustomizationOptions

disableAutomaticAuthentication

Inicia getToken si es necesario realizar una autenticación manual. Los desarrolladores deberán llamar a para authenticate() controlar cuándo autenticarse manualmente.

disableAutomaticAuthentication?: boolean

Valor de propiedad

boolean

Heredado deInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

El campo determina si se realiza la detección de instancias al intentar autenticarse. Si se establece en true , se deshabilitará completamente la detección de instancias y la validación de autoridad. Como resultado, es fundamental asegurarse de que el host de autoridad configurado sea válido y confiable. Esta funcionalidad está pensada para su uso en escenarios en los que no se puede acceder al punto de conexión de metadatos, como en nubes privadas o Azure Stack. El proceso de detección de instancias implica recuperar los metadatos de autoridad de https://login.microsoft.com/ para validar la autoridad.

disableInstanceDiscovery?: boolean

Valor de propiedad

boolean

Heredado deInteractiveCredentialOptions.disableInstanceDiscovery

httpClient

HttpClient que se usará para enviar solicitudes HTTP.

httpClient?: HttpClient

Valor de propiedad

HttpClient

Heredado deInteractiveCredentialOptions.httpClient

loggingOptions

Permite a los usuarios configurar las opciones de directiva de registro, permitir el registro de la información de la cuenta y la información de identificación personal para el soporte al cliente.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Valor de propiedad

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Heredado deInteractiveCredentialOptions.loggingOptions

proxyOptions

Opciones para configurar un proxy para las solicitudes salientes.

proxyOptions?: ProxySettings

Valor de propiedad

ProxySettings

Heredado deInteractiveCredentialOptions.proxyOptions

redirectOptions

Opciones para controlar las respuestas de redireccionamiento.

redirectOptions?: RedirectPolicyOptions

Valor de propiedad

RedirectPolicyOptions

Heredado deInteractiveCredentialOptions.redirectOptions

retryOptions

Opciones que controlan cómo reintentar las solicitudes con error.

retryOptions?: PipelineRetryOptions

Valor de propiedad

PipelineRetryOptions

Heredado deInteractiveCredentialOptions.retryOptions

telemetryOptions

Opciones para establecer información de seguimiento y telemetría comunes en las solicitudes salientes.

telemetryOptions?: TelemetryOptions

Valor de propiedad

TelemetryOptions

Heredado deInteractiveCredentialOptions.telemetryOptions

tlsOptions

Opciones para configurar la autenticación TLS

tlsOptions?: TlsSettings

Valor de propiedad

TlsSettings

Heredado deInteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Opciones para proporcionar a la capa de persistencia (si hay alguna disponible) al almacenar credenciales.

Primero debe registrar un complemento de proveedor de persistencia. Consulte el @azure/identity-cache-persistence paquete en NPM.

Ejemplo:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Valor de propiedad

TokenCachePersistenceOptions

Heredado deCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

userAgentOptions?: UserAgentPolicyOptions

Valor de propiedad

UserAgentPolicyOptions

Heredado deInteractiveCredentialOptions.userAgentOptions