Compartilhar 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 o cabeçalho x5c para autorização de nome SubjectName e Emissor. Defina essa opção para enviar o certificado público codificado em 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 de 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 desabilitará 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 definam configurações para opções de política de registro em log, permitam o registro em log de informações da conta e informações de identificação pessoal para o atendimento 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 para fornecer à camada de persistência (se houver uma disponível) ao armazenar credenciais.

Primeiro, você deve registrar um plug-in do provedor de persistência. Consulte o @azure/identity-cache-persistence pacote 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 de usuário a solicitações de saída.

Detalhes da propriedade

sendCertificateChain

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

sendCertificateChain?: boolean

Valor da propriedade

boolean

Detalhes das 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.

additionallyAllowedTenants?: string[]

Valor da propriedade

string[]

Herdado deMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Valor da propriedade

AdditionalPolicyConfig[]

Herdado deMultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

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

allowInsecureConnection?: boolean

Valor da propriedade

boolean

Herdado deMultiTenantTokenCredentialOptions.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 de AzureAuthorityHosts. O padrão é "https://login.microsoftonline.com".

authorityHost?: string

Valor da propriedade

string

Herdado deMultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

O campo determina se a descoberta de instância é executada ao tentar autenticar. Definir isso como true desabilitará 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 da propriedade

boolean

Herdado deAuthorityValidationOptions.disableInstanceDiscovery

httpClient

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

httpClient?: HttpClient

Valor da propriedade

HttpClient

Herdado deMultiTenantTokenCredentialOptions.httpClient

loggingOptions

Permite que os usuários definam configurações para opções de política de registro em log, permitam o registro em log de informações da conta e informações de identificação pessoal para o atendimento ao cliente.

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

Valor da propriedade

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

Herdado deMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

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

proxyOptions?: ProxySettings

Valor da propriedade

ProxySettings

Herdado deMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

Valor da propriedade

RedirectPolicyOptions

Herdado deMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

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

retryOptions?: PipelineRetryOptions

Valor da 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 da propriedade

TelemetryOptions

Herdado deMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

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

tlsOptions?: TlsSettings

Valor da propriedade

TlsSettings

Herdado deMultiTenantTokenCredentialOptions.tlsOptions

tokenCachePersistenceOptions

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

Primeiro, você deve registrar um plug-in do provedor de persistência. Consulte o @azure/identity-cache-persistence pacote 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 da propriedade

TokenCachePersistenceOptions

Herdado deCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Valor da propriedade

UserAgentPolicyOptions

Herdado deMultiTenantTokenCredentialOptions.userAgentOptions