Compartilhar via

DeviceCodeCredentialOptions interface

  • Referência
Pacote:
@azure/identity

Define opções para a classe InteractiveBrowserCredential para Node.js.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

Propriedades

clientId

ID do cliente do aplicativo Microsoft Entra no qual os usuários entrarão. É recomendável que os desenvolvedores registrem seus aplicativos e atribuam funções apropriadas. Para obter 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.
tenantId

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

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

Propriedades herdadas

additionallyAllowedTenants

Para aplicativos multilocatários, 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

Definir 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 ID do locatário.

Esse registro pode ser recuperado chamando o método authenticate() da 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".
disableAutomaticAuthentication

Faz o getToken ser lançado se uma autenticação manual for necessária. Os desenvolvedores precisarão chamar authenticate() para controlar quando autenticar manualmente.
disableInstanceDiscovery

O campo determina se a descoberta de instância é executada ao tentar se 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 atingido, 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, permitir informações de conta de log e informações de identificação pessoal para o suporte 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 do 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 pacote @azure/identity-cache-persistence no NPM.

Exemplo:

import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);
const credential = new DeviceCodeCredential({
  tokenCachePersistenceOptions: {
    enabled: true,
  },
});
userAgentOptions

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

Detalhes da propriedade

clientId

ID do cliente do aplicativo Microsoft Entra no qual os usuários entrarão. É recomendável que os desenvolvedores registrem seus aplicativos e atribuam funções apropriadas. Para obter 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 da propriedade

string

tenantId

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

tenantId?: string

Valor da propriedade

string

userPromptCallback

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

userPromptCallback?: DeviceCodePromptCallback

Valor da propriedade

DeviceCodePromptCallback

Detalhes das propriedades herdadas

additionallyAllowedTenants

Para aplicativos multilocatários, 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

Definir 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 ID do locatário.

Esse registro pode ser recuperado chamando o método authenticate() da 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

disableAutomaticAuthentication

Faz o getToken ser lançado se uma autenticação manual for necessária. Os desenvolvedores precisarão chamar 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 se 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 atingido, 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, permitir informações de conta de log e informações de identificação pessoal para o suporte 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 do 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 pacote @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 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