Compartir a través de

ClientCertificateCredentialOptions interface

  • Referencia
Paquete:
@azure/identity

Parámetros opcionales para la clase ClientCertificateCredential .

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

Propiedades

sendCertificateChain

Opción para incluir el encabezado x5c para SubjectName y la autorización del nombre del emisor. Establezca esta opción para enviar un certificado público codificado en base64 en el encabezado de aserción de cliente como una notificación x5c.

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.
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 la autoridad. Como resultado, es fundamental asegurarse de que el host de autoridad configurado sea válido y de confianza. 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 la recuperación de 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 técnico 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 solicitudes con error.
telemetryOptions

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

Opciones para configurar la autenticación TLS
tokenCachePersistenceOptions

Opciones para proporcionar al nivel 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

sendCertificateChain

Opción para incluir el encabezado x5c para SubjectName y la autorización del nombre del emisor. Establezca esta opción para enviar un certificado público codificado en base64 en el encabezado de aserción de cliente como una notificación x5c.

sendCertificateChain?: 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 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 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 la autoridad. Como resultado, es fundamental asegurarse de que el host de autoridad configurado sea válido y de confianza. 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 la recuperación de 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 técnico 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 solicitudes con error.

retryOptions?: PipelineRetryOptions

Valor de propiedad

PipelineRetryOptions

Heredado deMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

Opciones para establecer la telemetría común y la información de seguimiento 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

tokenCachePersistenceOptions

Opciones para proporcionar al nivel 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 deMultiTenantTokenCredentialOptions.userAgentOptions