InteractiveBrowserCredentialNodeOptions interface
Define as opções comuns para a classe InteractiveBrowserCredential.
- Extends
Propriedades
client |
A ID do Cliente do aplicativo Microsoft Entra no qual os usuários entrarão. Recomenda-se que os desenvolvedores registrem seus aplicativos e atribuam funções apropriadas. Para mais informações, visite https://aka.ms/identity/AppRegistrationAndRoleAssignment. Se não for especificado, os usuários se autenticarão em um aplicativo de desenvolvimento do Azure, o que não é recomendado para cenários de produção. |
login |
loginHint permite que um nome de usuário seja pré-selecionado para logins interativos. Definir esta opção ignora o prompt de seleção de conta e imediatamente tenta fazer login com a conta especificada. |
redirect |
Obtém o URI de redirecionamento do aplicativo. Este valor deve ser igual ao do portal de registo da candidatura. O padrão é |
tenant |
A ID do locatário (diretório) do Microsoft Entra. |
Propriedades Herdadas
additionally |
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. |
additional |
Políticas adicionais a serem incluídas no pipeline HTTP. |
allow |
Defina como true se a solicitação for enviada por HTTP em vez de HTTPS |
authentication |
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 par de ID de Cliente e ID de Locatário. Esse registro pode ser recuperado chamando para o método
|
authority |
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". |
broker |
Opções para permitir a autenticação do broker ao usar InteractiveBrowserCredential |
browser |
Opções de configuração compartilhada para personalização do navegador |
disable |
Faz com que o getToken seja lançado se uma autenticação manual for necessária.
Os desenvolvedores precisarão ligar para |
disable |
O campo determina se a descoberta de instância é executada ao tentar autenticar.
Definir isso como |
http |
O HttpClient que será usado para enviar solicitações HTTP. |
logging |
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. |
proxy |
Opções para configurar um proxy para solicitações de saída. |
redirect |
Opções de como as respostas de redirecionamento são tratadas. |
retry |
Opções que controlam como repetir solicitações com falha. |
telemetry |
Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída. |
tls |
Opções para configurar a autenticação TLS |
token |
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 Exemplo:
|
user |
Opções para adicionar detalhes do agente do usuário às solicitações de saída. |
Detalhes de Propriedade
clientId
A ID do Cliente do aplicativo Microsoft Entra no qual os usuários entrarão. Recomenda-se que os desenvolvedores registrem seus aplicativos e atribuam funções apropriadas. Para mais informações, visite https://aka.ms/identity/AppRegistrationAndRoleAssignment. Se não for especificado, os usuários se autenticarão em um aplicativo de desenvolvimento do Azure, o que não é recomendado para cenários de produção.
clientId?: string
Valor de Propriedade
string
loginHint
loginHint permite que um nome de usuário seja pré-selecionado para logins interativos. Definir esta opção ignora o prompt de seleção de conta e imediatamente tenta fazer login com a conta especificada.
loginHint?: string
Valor de Propriedade
string
redirectUri
Obtém o URI de redirecionamento do aplicativo. Este valor deve ser igual ao do portal de registo da candidatura. O padrão é window.location.href
.
Este campo já não é obrigatório para Node.js.
redirectUri?: string | () => string
Valor de Propriedade
string | () => string
tenantId
A ID do locatário (diretório) do Microsoft Entra.
tenantId?: string
Valor de Propriedade
string
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 deInteractiveCredentialOptions.additionallyAllowedTenants
additionalPolicies
Políticas adicionais a serem incluídas no pipeline HTTP.
additionalPolicies?: AdditionalPolicyConfig[]
Valor de Propriedade
allowInsecureConnection
Defina como true se a solicitação for enviada por HTTP em vez de HTTPS
allowInsecureConnection?: boolean
Valor de Propriedade
boolean
herdado de InteractiveCredentialOptions.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 par de ID de Cliente e ID de Locatário.
Esse registro pode ser recuperado chamando para o método authenticate()
da credencial, da seguinte maneira:
const authenticationRecord = await credential.authenticate();
authenticationRecord?: AuthenticationRecord
Valor de Propriedade
herdado de InteractiveCredentialOptions.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 AzureAuthorityHosts. O padrão é "https://login.microsoftonline.com".
authorityHost?: string
Valor de Propriedade
string
brokerOptions
Opções para permitir a autenticação do broker ao usar InteractiveBrowserCredential
brokerOptions?: BrokerOptions
Valor de Propriedade
herdado deBrokerAuthOptions.brokerOptions
browserCustomizationOptions
Opções de configuração compartilhada para personalização do navegador
browserCustomizationOptions?: { errorMessage?: string, successMessage?: string }
Valor de Propriedade
{ errorMessage?: string, successMessage?: string }
herdado deBrowserCustomizationOptions.browserCustomizationOptions
disableAutomaticAuthentication
Faz com que o getToken seja lançado se uma autenticação manual for necessária.
Os desenvolvedores precisarão ligar para authenticate()
para controlar quando autenticar manualmente.
disableAutomaticAuthentication?: boolean
Valor de Propriedade
boolean
herdado de InteractiveCredentialOptions.disableAutomaticAuthentication
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 https://login.microsoft.com/ autoridade para validar a autoridade.
disableInstanceDiscovery?: boolean
Valor de Propriedade
boolean
herdado de InteractiveCredentialOptions.disableInstanceDiscovery
httpClient
O HttpClient que será usado para enviar solicitações HTTP.
httpClient?: HttpClient
Valor de Propriedade
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 }
proxyOptions
Opções para configurar um proxy para solicitações de saída.
proxyOptions?: ProxySettings
Valor de Propriedade
redirectOptions
Opções de como as respostas de redirecionamento são tratadas.
redirectOptions?: RedirectPolicyOptions
Valor de Propriedade
retryOptions
Opções que controlam como repetir solicitações com falha.
retryOptions?: PipelineRetryOptions
Valor de Propriedade
telemetryOptions
Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.
telemetryOptions?: TelemetryOptions
Valor de Propriedade
tlsOptions
Opções para configurar a autenticação TLS
tlsOptions?: TlsSettings
Valor de Propriedade
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 { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);
const credential = new DeviceCodeCredential({
tokenCachePersistenceOptions: {
enabled: true,
},
});
tokenCachePersistenceOptions?: TokenCachePersistenceOptions
Valor de Propriedade
herdado deCredentialPersistenceOptions.tokenCachePersistenceOptions
userAgentOptions
Opções para adicionar detalhes do agente do usuário às solicitações de saída.
userAgentOptions?: UserAgentPolicyOptions