DeviceCodeCredentialOptions interface

Pacote:

@azure/identity

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

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

Propriedades

clientId	O ID de cliente (aplicação) de um Registo de Aplicações no inquilino.
tenantId	O ID de inquilino (diretório) Microsoft Entra.
userPromptCallback	Uma função de chamada de retorno que será invocada para mostrar DeviceCodeInfo ao utilizador. Se não tiver sido atribuída, registaremos automaticamente as informações do código do dispositivo e as instruções de autenticação na consola do .

Propriedades Herdadas

additionallyAllowedTenants	Para aplicações multi-inquilino, especifica inquilinos adicionais para os quais a credencial pode adquirir tokens. Adicione o valor universal "*" para permitir que a credencial adquira tokens para qualquer inquilino que a aplicação esteja instalada.
additionalPolicies	Políticas adicionais a incluir no pipeline HTTP.
allowInsecureConnection	Defina 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 ID de Cliente e par de 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 de autoridade a utilizar para pedidos de autenticação. Os valores possíveis estão disponíveis através do AzureAuthorityHosts. A predefinição é "https://login.microsoftonline.com".
disableAutomaticAuthentication	Efetua o lançamento getToken se for necessária uma autenticação manual. Os programadores terão de chamar para authenticate() controlar quando autenticar manualmente.
disableInstanceDiscovery	O campo determina se a deteção de instâncias é efetuada ao tentar autenticar. Definir isto 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 para https://login.microsoft.com/ 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 pessoalmente 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

tenantId

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

tenantId?: string

Valor de Propriedade

string

userPromptCallback

Uma função de chamada de retorno que será invocada para mostrar DeviceCodeInfo ao utilizador. Se não tiver sido atribuída, registaremos automaticamente as informações do código do dispositivo e as instruções de autenticação na consola do .

userPromptCallback?: DeviceCodePromptCallback

Valor de Propriedade

DeviceCodePromptCallback

Detalhes da Propriedade Herdada

additionallyAllowedTenants

Para aplicações multi-inquilino, especifica inquilinos adicionais para os quais a credencial pode adquirir tokens. Adicione o valor universal "*" para permitir que a credencial adquira tokens para qualquer inquilino que a aplicação esteja instalada.

additionallyAllowedTenants?: string[]

Valor de Propriedade

string[]

Herdado deInteractiveCredentialOptions.adicionalmenteAllowedTenants

additionalPolicies

Políticas adicionais a incluir no pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de Propriedade

AdditionalPolicyConfig[]

Herdado deInteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

Defina 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 ID de Cliente e par de 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 de autoridade a utilizar para pedidos de autenticação. Os valores possíveis estão disponíveis através do AzureAuthorityHosts. A predefinição é "https://login.microsoftonline.com".

authorityHost?: string

Valor de Propriedade

string

Herdado deInteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

Efetua o lançamento getToken se for necessária uma autenticação manual. Os programadores terão de chamar para authenticate() controlar quando autenticar manualmente.

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 isto 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 para https://login.microsoft.com/ 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 pessoalmente 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