Partilhar via

InteractiveBrowserCredentialNodeOptions interface

  • Referência
Pacote:
@azure/identity

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

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions,BrowserCustomizationOptions,BrokerAuthOptions

Propriedades

clientId

O ID de cliente (aplicação) de um Registo de Aplicações no inquilino.
loginHint

loginHint permite que um nome de utilizador seja pré-selecionado para inícios de sessão interativos. Definir esta opção ignora o pedido de seleção da conta e tenta iniciar sessão imediatamente com a conta especificada.
redirectUri

Obtém o URI de redirecionamento da aplicação. Deve ser igual ao valor no portal de registo de aplicações. A predefinição é window.location.href. Este campo já não é necessário para Node.js.
tenantId

O ID de inquilino (diretório) Microsoft Entra.

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
authenticationRecord

Resultado de uma autenticação anterior que pode ser utilizada para obter as credenciais em cache de cada conta individual. Isto é necessário para fornecer caso a aplicação pretenda trabalhar com mais do que uma conta por par ID de Cliente e ID de Inquilino.

Este registo pode ser obtido ao chamar para o método da authenticate() credencial, da seguinte forma:

const authenticationRecord = await credential.authenticate();
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".
brokerOptions

Opções para permitir a autenticação de mediador ao utilizar o InteractiveBrowserCredential
browserCustomizationOptions

Opções de configuração partilhadas para personalização do browser
disableAutomaticAuthentication

Faz com que getToken seja emitida se for necessária uma autenticação manual. Os programadores terão de ligar para para authenticate() controlar quando efetuar a autenticação manual.
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 de Propriedade

clientId

O ID de cliente (aplicação) de um Registo de Aplicações no inquilino.

clientId?: string

Valor de Propriedade

string

loginHint

loginHint permite que um nome de utilizador seja pré-selecionado para inícios de sessão interativos. Definir esta opção ignora o pedido de seleção da conta e tenta iniciar sessão imediatamente com a conta especificada.

loginHint?: string

Valor de Propriedade

string

redirectUri

Obtém o URI de redirecionamento da aplicação. Deve ser igual ao valor no portal de registo de aplicações. A predefinição é window.location.href. Este campo já não é necessário para Node.js.

redirectUri?: string | () => string

Valor de Propriedade

string | () => string

tenantId

O ID de inquilino (diretório) Microsoft Entra.

tenantId?: string

Valor de Propriedade

string

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

additionalPolicies

Políticas adicionais a incluir no pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de Propriedade

AdditionalPolicyConfig[]

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

authenticationRecord

Resultado de uma autenticação anterior que pode ser utilizada para obter as credenciais em cache de cada conta individual. Isto é necessário para fornecer caso a aplicação pretenda trabalhar com mais do que uma conta por par ID de Cliente e ID de Inquilino.

Este registo pode ser obtido ao chamar para o método da authenticate() credencial, da seguinte forma:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Valor de Propriedade

AuthenticationRecord

Herdado deInteractiveCredentialOptions.authenticationRecord

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

brokerOptions

Opções para permitir a autenticação de mediador ao utilizar o InteractiveBrowserCredential

brokerOptions?: BrokerOptions

Valor de Propriedade

BrokerOptions

Herdado deBrokerAuthOptions.brokerOptions

browserCustomizationOptions

Opções de configuração partilhadas para personalização do browser

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

Valor de Propriedade

{ errorMessage?: string, successMessage?: string }

Herdado deBrowserCustomizationOptions.browserCustomizationOptions

disableAutomaticAuthentication

Faz com que getToken seja emitida se for necessária uma autenticação manual. Os programadores terão de ligar para para authenticate() controlar quando efetuar a autenticação manual.

disableAutomaticAuthentication?: boolean

Valor de Propriedade

boolean

Herdado deInteractiveCredentialOptions.disableAutomaticAuthentication

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

httpClient

O HttpClient que será utilizado para enviar pedidos HTTP.

httpClient?: HttpClient

Valor de Propriedade

HttpClient

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

proxyOptions

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

proxyOptions?: ProxySettings

Valor de Propriedade

ProxySettings

Herdado deInteractiveCredentialOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

Valor de Propriedade

RedirectPolicyOptions

Herdado deInteractiveCredentialOptions.redirectOptions

retryOptions

Opções que controlam como repetir pedidos falhados.

retryOptions?: PipelineRetryOptions

Valor de Propriedade

PipelineRetryOptions

Herdado deInteractiveCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Valor de Propriedade

TelemetryOptions

Herdado deInteractiveCredentialOptions.telemetryOptions

tlsOptions

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

tlsOptions?: TlsSettings

Valor de Propriedade

TlsSettings

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