Share via

UsernamePasswordCredentialOptions interface

  • Referência
Pacote:
@azure/identity

Define as opções para a classe UsernamePasswordCredential .

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

Propriedades Herdadas

additionallyAllowedTenants

Para aplicações multi-inquilino, especifica inquilinos adicionais para os quais a credencial pode adquirir tokens. Adicione o valor de caráter universal "*" para permitir que a credencial adquira tokens para qualquer inquilino em que a aplicação esteja instalada.
additionalPolicies

Políticas adicionais a incluir no pipeline HTTP.
allowInsecureConnection

Definir como verdadeiro se o pedido for enviado através de HTTP em vez de HTTPS
authorityHost

O anfitrião da autoridade a utilizar para pedidos de autenticação. Os valores possíveis estão disponíveis através de AzureAuthorityHosts. A predefinição é "https://login.microsoftonline.com".
disableInstanceDiscovery

O campo determina se a deteção de instâncias é efetuada ao tentar autenticar. Definir esta opção como true irá desativar completamente a deteção de instâncias e a validação da autoridade. Como resultado, é crucial garantir que o anfitrião de autoridade configurado é válido e fidedigno. Esta funcionalidade destina-se a ser utilizada em cenários em que não é possível alcançar o ponto final de metadados, como em clouds privadas ou no Azure Stack. O processo de deteção de instâncias implica a obtenção de metadados de autoridade de https://login.microsoft.com/ para validar a autoridade.
httpClient

O HttpClient que será utilizado para enviar pedidos HTTP.
loggingOptions

Permite que os utilizadores configurem definições para opções de política de registo, permitir informações de conta de registo e informações pessoais identificáveis para o suporte ao cliente.
proxyOptions

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

Opções para a forma como as respostas de redirecionamento são processadas.
retryOptions

Opções que controlam como repetir pedidos falhados.
telemetryOptions

Opções para definir informações comuns de telemetria e rastreio para pedidos enviados.
tlsOptions

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

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

Primeiro, tem de registar um plug-in do fornecedor de persistência. Veja 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 utilizador aos pedidos de saída.

Detalhes da Propriedade Herdada

additionallyAllowedTenants

Para aplicações multi-inquilino, especifica inquilinos adicionais para os quais a credencial pode adquirir tokens. Adicione o valor de caráter universal "*" para permitir que a credencial adquira tokens para qualquer inquilino em que a aplicação esteja instalada.

additionallyAllowedTenants?: string[]

Valor de Propriedade

string[]

Herdado deMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

Políticas adicionais a incluir no pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de Propriedade

AdditionalPolicyConfig[]

Herdado deMultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

Definir como verdadeiro se o pedido for enviado através de HTTP em vez de HTTPS

allowInsecureConnection?: boolean

Valor de Propriedade

boolean

Herdado deMultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

O anfitrião da autoridade a utilizar para pedidos de autenticação. Os valores possíveis estão disponíveis através de AzureAuthorityHosts. A predefinição é "https://login.microsoftonline.com".

authorityHost?: string

Valor de Propriedade

string

Herdado deMultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

O campo determina se a deteção de instâncias é efetuada ao tentar autenticar. Definir esta opção como true irá desativar completamente a deteção de instâncias e a validação da autoridade. Como resultado, é crucial garantir que o anfitrião de autoridade configurado é válido e fidedigno. Esta funcionalidade destina-se a ser utilizada em cenários em que não é possível alcançar o ponto final de metadados, como em clouds privadas ou no Azure Stack. O processo de deteção de instâncias implica a obtenção de metadados de autoridade de https://login.microsoft.com/ para validar a autoridade.

disableInstanceDiscovery?: boolean

Valor de Propriedade

boolean

Herdado deAuthorityValidationOptions.disableInstanceDiscovery

httpClient

O HttpClient que será utilizado para enviar pedidos HTTP.

httpClient?: HttpClient

Valor de Propriedade

HttpClient

Herdado deMultiTenantTokenCredentialOptions.httpClient

loggingOptions

Permite que os utilizadores configurem definições para opções de política de registo, permitir informações de conta de registo e informações pessoais identificáveis para o suporte ao cliente.

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

Valor de Propriedade

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

Herdado deMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

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

proxyOptions?: ProxySettings

Valor de Propriedade

ProxySettings

Herdado deMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Opções para a forma como as respostas de redirecionamento são processadas.

redirectOptions?: RedirectPolicyOptions

Valor de Propriedade

RedirectPolicyOptions

Herdado deMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

Opções que controlam como repetir pedidos falhados.

retryOptions?: PipelineRetryOptions

Valor de Propriedade

PipelineRetryOptions

Herdado deMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

Opções para definir informações comuns de telemetria e rastreio para pedidos enviados.

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

tokenCachePersistenceOptions

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

Primeiro, tem de registar um plug-in do fornecedor de persistência. Veja 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 de Propriedade

TokenCachePersistenceOptions

Herdado deCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Opções para adicionar detalhes do agente de utilizador aos pedidos de saída.

userAgentOptions?: UserAgentPolicyOptions

Valor de Propriedade

UserAgentPolicyOptions

Herdado deMultiTenantTokenCredentialOptions.userAgentOptions