InteractiveCredentialOptions interface

Paquete:

@azure/identity

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

Extends

MultiTenantTokenCredentialOptions,AuthorityValidationOptions

Propiedades

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();

disableAutomaticAuthentication

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

Propiedades heredadas

additionallyAllowedTenants	Para las aplicaciones multiinquilino, especifica inquilinos adicionales para los que la credencial puede adquirir tokens. Agregue el valor 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.
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"».
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
userAgentOptions	Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

Detalles de las propiedades

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

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

Detalles de las propiedades heredadas

additionallyAllowedTenants

Para las aplicaciones multiinquilino, especifica inquilinos adicionales para los que la credencial puede adquirir tokens. Agregue el valor 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 deMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Valor de propiedad

AdditionalPolicyConfig[]

Heredado deMultiTenantTokenCredentialOptions.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 deMultiTenantTokenCredentialOptions.allowInsecureConnection

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 deMultiTenantTokenCredentialOptions.authorityHost

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 deAuthorityValidationOptions.disableInstanceDiscovery

httpClient

HttpClient que se usará para enviar solicitudes HTTP.

httpClient?: HttpClient

Valor de propiedad

HttpClient

Heredado deMultiTenantTokenCredentialOptions.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 deMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

Opciones para configurar un proxy para las solicitudes salientes.

proxyOptions?: ProxySettings

Valor de propiedad

ProxySettings

Heredado deMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Opciones para controlar las respuestas de redireccionamiento.

redirectOptions?: RedirectPolicyOptions

Valor de propiedad

RedirectPolicyOptions

Heredado deMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

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

retryOptions?: PipelineRetryOptions

Valor de propiedad

PipelineRetryOptions

Heredado deMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Valor de propiedad

TelemetryOptions

Heredado deMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Opciones para configurar la autenticación TLS

tlsOptions?: TlsSettings

Valor de propiedad

TlsSettings

Heredado deMultiTenantTokenCredentialOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Valor de propiedad

UserAgentPolicyOptions

Heredado deMultiTenantTokenCredentialOptions.userAgentOptions