InteractiveCredentialOptions interface
Opções comuns do construtor para as credenciais Identity que exigem interação do usuário.
- Extends
Propriedades
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
|
disable |
Faz com que o getToken seja lançado se uma autenticação manual for necessária.
Os desenvolvedores precisarão ligar para |
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 |
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". |
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 |
user |
Opções para adicionar detalhes do agente do usuário às solicitações de saída. |
Detalhes de Propriedade
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
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
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 deMultiTenantTokenCredentialOptions.additionallyAllowedTenants
additionalPolicies
Políticas adicionais a serem incluídas no pipeline HTTP.
additionalPolicies?: AdditionalPolicyConfig[]
Valor de Propriedade
herdado deMultiTenantTokenCredentialOptions.additionalPolicies
allowInsecureConnection
Defina como true se a solicitação for enviada por HTTP em vez de HTTPS
allowInsecureConnection?: boolean
Valor de Propriedade
boolean
herdado de MultiTenantTokenCredentialOptions.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 AzureAuthorityHosts. O padrão é "https://login.microsoftonline.com".
authorityHost?: string
Valor de Propriedade
string
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 autoridade de https://login.microsoft.com/ para validar a autoridade.
disableInstanceDiscovery?: boolean
Valor de Propriedade
boolean
herdado doAuthorityValidationOptions.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
herdado de MultiTenantTokenCredentialOptions.redirectOptions
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
herdado deMultiTenantTokenCredentialOptions.telemetryOptions
tlsOptions
Opções para configurar a autenticação TLS
tlsOptions?: TlsSettings
Valor de Propriedade
userAgentOptions
Opções para adicionar detalhes do agente do usuário às solicitações de saída.
userAgentOptions?: UserAgentPolicyOptions
Valor de Propriedade
herdado deMultiTenantTokenCredentialOptions.userAgentOptions