Partilhar via

ClientCertificateCredentialOptions interface

  • Referência
Pacote:
@azure/identity

Parâmetros opcionais para a classe ClientCertificateCredential.

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

Propriedades

sendCertificateChain

Opção para incluir cabeçalho x5c para autorização de nome de assunto e emissor. Defina esta opção para enviar certificado público codificado base64 no cabeçalho de asserção do cliente como uma declaração x5c

Propriedades Herdadas

additionallyAllowedTenants

Para aplicativos multilocatário, especifica locatários adicionais para os quais a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário que o aplicativo esteja instalado.
additionalPolicies

Políticas adicionais a serem incluídas no pipeline HTTP.
allowInsecureConnection

Defina como true se a solicitação for enviada por HTTP em vez de HTTPS
authorityHost

O host de autoridade a ser usado para solicitações de autenticação. Os valores possíveis estão disponíveis por meio AzureAuthorityHosts. O padrão é "https://login.microsoftonline.com".
disableInstanceDiscovery

O campo determina se a descoberta de instância é executada ao tentar autenticar. Definir isso como true desativará completamente a descoberta de instância e a validação de autoridade. Como resultado, é crucial garantir que o host de autoridade configurado seja válido e confiável. Essa funcionalidade destina-se ao uso em cenários em que o ponto de extremidade de metadados não pode ser alcançado, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de autoridade de https://login.microsoft.com/ para validar a autoridade.
httpClient

O HttpClient que será usado para enviar solicitações HTTP.
loggingOptions

Permite que os usuários configurem configurações para registrar opções de política, permitir o registro de informações de conta e informações de identificação pessoal para suporte ao cliente.
proxyOptions

Opções para configurar um proxy para solicitações de saída.
redirectOptions

Opções de como as respostas de redirecionamento são tratadas.
retryOptions

Opções que controlam como repetir solicitações com falha.
telemetryOptions

Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.
tlsOptions

Opções para configurar a autenticação TLS
tokenCachePersistenceOptions

Opções a serem fornecidas à camada de persistência (se houver uma disponível) ao armazenar credenciais.

Você deve primeiro registrar um plug-in de provedor de persistência. Consulte o pacote de @azure/identity-cache-persistence no NPM.

Exemplo:

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

Opções para adicionar detalhes do agente do usuário às solicitações de saída.

Detalhes de Propriedade

sendCertificateChain

Opção para incluir cabeçalho x5c para autorização de nome de assunto e emissor. Defina esta opção para enviar certificado público codificado base64 no cabeçalho de asserção do cliente como uma declaração x5c

sendCertificateChain?: boolean

Valor de Propriedade

boolean

Detalhes da Propriedade Herdada

additionallyAllowedTenants

Para aplicativos multilocatário, especifica locatários adicionais para os quais a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário que o aplicativo esteja instalado.

additionallyAllowedTenants?: string[]

Valor de Propriedade

string[]

herdado deMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

Políticas adicionais a serem incluídas no pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de Propriedade

AdditionalPolicyConfig[]

herdado deMultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

Defina como true se a solicitação for enviada por HTTP em vez de HTTPS

allowInsecureConnection?: boolean

Valor de Propriedade

boolean

herdado de MultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

O host de autoridade a ser usado para solicitações de autenticação. Os valores possíveis estão disponíveis por meio AzureAuthorityHosts. O padrão é "https://login.microsoftonline.com".

authorityHost?: string

Valor de Propriedade

string

herdado de MultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

O campo determina se a descoberta de instância é executada ao tentar autenticar. Definir isso como true desativará completamente a descoberta de instância e a validação de autoridade. Como resultado, é crucial garantir que o host de autoridade configurado seja válido e confiável. Essa funcionalidade destina-se ao uso em cenários em que o ponto de extremidade de metadados não pode ser alcançado, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de autoridade de https://login.microsoft.com/ para validar a autoridade.

disableInstanceDiscovery?: boolean

Valor de Propriedade

boolean

herdado doAuthorityValidationOptions.disableInstanceDiscovery

httpClient

O HttpClient que será usado para enviar solicitações HTTP.

httpClient?: HttpClient

Valor de Propriedade

HttpClient

herdado de MultiTenantTokenCredentialOptions.httpClient

loggingOptions

Permite que os usuários configurem configurações para registrar opções de política, permitir o registro de informações de conta e informações de identificação pessoal para suporte ao cliente.

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

Valor de Propriedade

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

herdado de MultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

Opções para configurar um proxy para solicitações de saída.

proxyOptions?: ProxySettings

Valor de Propriedade

ProxySettings

herdado deMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Opções de como as respostas de redirecionamento são tratadas.

redirectOptions?: RedirectPolicyOptions

Valor de Propriedade

RedirectPolicyOptions

herdado de MultiTenantTokenCredentialOptions.redirectOptions

retryOptions

Opções que controlam como repetir solicitações com falha.

retryOptions?: PipelineRetryOptions

Valor de Propriedade

PipelineRetryOptions

herdado deMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.

telemetryOptions?: TelemetryOptions

Valor de Propriedade

TelemetryOptions

herdado deMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Opções para configurar a autenticação TLS

tlsOptions?: TlsSettings

Valor de Propriedade

TlsSettings

herdado de MultiTenantTokenCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Opções a serem fornecidas à camada de persistência (se houver uma disponível) ao armazenar credenciais.

Você deve primeiro registrar um plug-in de provedor de persistência. Consulte o pacote de @azure/identity-cache-persistence no NPM.

Exemplo:

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 Propriedade

TokenCachePersistenceOptions

herdado deCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Opções para adicionar detalhes do agente do usuário às solicitações de saída.

userAgentOptions?: UserAgentPolicyOptions

Valor de Propriedade

UserAgentPolicyOptions

herdado deMultiTenantTokenCredentialOptions.userAgentOptions