InteractiveBrowserCredentialNodeOptions interface

Pacote:

@azure/identity

Define as opções comuns para a classe InteractiveBrowserCredential.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions,BrowserCustomizationOptions,BrokerAuthOptions

Propriedades

clientId	A ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.
loginHint	loginHint permite que um nome de usuário seja pré-selecionado para logons interativos. Definir essa opção ignora o prompt de seleção de conta e tenta logon imediatamente com a conta especificada.
redirectUri	Obtém o URI de redirecionamento do aplicativo. Isso deve ser o mesmo que o valor no portal de registro do aplicativo. Assume o padrão de window.location.href. Esse campo não é mais necessário para Node.js.
tenantId	A ID do locatário Microsoft Entra (diretório).

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
authenticationRecord	Resultado de uma autenticação anterior que pode ser usada para recuperar as credenciais armazenadas em cache de cada conta individual. Isso é necessário para fornecer caso o aplicativo queira trabalhar com mais de uma conta por ID do cliente e par de IDs de locatário. Esse registro pode ser recuperado chamando para o método da authenticate() credencial, da seguinte maneira: const authenticationRecord = await credential.authenticate();
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".
brokerOptions	Opções para permitir a autenticação do agente ao usar InteractiveBrowserCredential
browserCustomizationOptions	Opções de configuração compartilhadas para personalização do navegador
disableAutomaticAuthentication	Faz com que getToken gere se uma autenticação manual for necessária. Os desenvolvedores precisarão chamar para authenticate() para controlar quando autenticar manualmente.
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

clientId

A ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.

clientId?: string

Valor da propriedade

string

loginHint

loginHint permite que um nome de usuário seja pré-selecionado para logons interativos. Definir essa opção ignora o prompt de seleção de conta e tenta logon imediatamente com a conta especificada.

loginHint?: string

Valor da propriedade

string

redirectUri

Obtém o URI de redirecionamento do aplicativo. Isso deve ser o mesmo que o valor no portal de registro do aplicativo. Assume o padrão de window.location.href. Esse campo não é mais necessário para Node.js.

redirectUri?: string | () => string

Valor da propriedade

string | () => string

tenantId

A ID do locatário Microsoft Entra (diretório).

tenantId?: string

Valor da propriedade

string

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 deInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Valor da propriedade

AdditionalPolicyConfig[]

Herdado deInteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

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

allowInsecureConnection?: boolean

Valor da propriedade

boolean

Herdado deInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Resultado de uma autenticação anterior que pode ser usada para recuperar as credenciais armazenadas em cache de cada conta individual. Isso é necessário para fornecer caso o aplicativo queira trabalhar com mais de uma conta por ID do cliente e par de IDs de locatário.

Esse registro pode ser recuperado chamando para o método da authenticate() credencial, da seguinte maneira:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Valor da propriedade

AuthenticationRecord

Herdado deInteractiveCredentialOptions.authenticationRecord

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

brokerOptions

Opções para permitir a autenticação do agente ao usar InteractiveBrowserCredential

brokerOptions?: BrokerOptions

Valor da propriedade

BrokerOptions

Herdado deBrokerAuthOptions.brokerOptions

browserCustomizationOptions

Opções de configuração compartilhadas para personalização do navegador

browserCustomizationOptions?: { errorMessage?: string, successMessage?: string }

Valor da propriedade

{ errorMessage?: string, successMessage?: string }

Herdado deBrowserCustomizationOptions.browserCustomizationOptions

disableAutomaticAuthentication

Faz com que getToken gere se uma autenticação manual for necessária. Os desenvolvedores precisarão chamar para authenticate() para controlar quando autenticar manualmente.

disableAutomaticAuthentication?: boolean

Valor da propriedade

boolean

Herdado deInteractiveCredentialOptions.disableAutomaticAuthentication

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

httpClient

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

httpClient?: HttpClient

Valor da propriedade

HttpClient

Herdado deInteractiveCredentialOptions.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 deInteractiveCredentialOptions.loggingOptions

proxyOptions

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

proxyOptions?: ProxySettings

Valor da propriedade

ProxySettings

Herdado deInteractiveCredentialOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

Valor da propriedade

RedirectPolicyOptions

Herdado deInteractiveCredentialOptions.redirectOptions

retryOptions

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

retryOptions?: PipelineRetryOptions

Valor da propriedade

PipelineRetryOptions

Herdado deInteractiveCredentialOptions.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 deInteractiveCredentialOptions.telemetryOptions

tlsOptions

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

tlsOptions?: TlsSettings

Valor da propriedade

TlsSettings

Herdado deInteractiveCredentialOptions.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 deInteractiveCredentialOptions.userAgentOptions