DeviceCodeCredentialOptions interface

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

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

tenantId?: string

Valor de Propriedade

Uma função de retorno de chamada que será invocada para mostrar DeviceCodeInfo para o usuário. Se não for atribuído, registraremos automaticamente as informações do código do dispositivo e as instruções de autenticação no console.

userPromptCallback?: DeviceCodePromptCallback

Valor de Propriedade

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

herdado deInteractiveCredentialOptions.additionallyAllowedTenants

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

additionalPolicies?: AdditionalPolicyConfig[]

Valor de Propriedade

herdado deInteractiveCredentialOptions.additionalPolicies

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

allowInsecureConnection?: boolean

Valor de Propriedade

herdado de InteractiveCredentialOptions.allowInsecureConnection

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

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

herdado de InteractiveCredentialOptions.authorityHost

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

herdado de InteractiveCredentialOptions.disableAutomaticAuthentication

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

herdado de InteractiveCredentialOptions.disableInstanceDiscovery

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

httpClient?: HttpClient

Valor de Propriedade

herdado de InteractiveCredentialOptions.httpClient

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

herdado de InteractiveCredentialOptions.loggingOptions

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

proxyOptions?: ProxySettings

Valor de Propriedade

herdado de InteractiveCredentialOptions.proxyOptions

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

redirectOptions?: RedirectPolicyOptions

Valor de Propriedade

herdado de InteractiveCredentialOptions.redirectOptions

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

retryOptions?: PipelineRetryOptions

Valor de Propriedade

herdado de InteractiveCredentialOptions.retryOptions

Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.

telemetryOptions?: TelemetryOptions

Valor de Propriedade

herdado deInteractiveCredentialOptions.telemetryOptions

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

tlsOptions?: TlsSettings

Valor de Propriedade

herdado de InteractiveCredentialOptions.tlsOptions

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

Opções para adicionar detalhes do agente do usuário às solicitações de saída.

userAgentOptions?: UserAgentPolicyOptions

Valor de Propriedade

herdado de InteractiveCredentialOptions.userAgentOptions