Condividi tramite

DeviceCodeCredentialOptions interface

  • Riferimento
Pacchetto:
@azure/identity

Definisce le opzioni per la classe InteractiveBrowserCredential per Node.js.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

Proprietà

clientId

ID client dell'applicazione Microsoft Entra a cui gli utenti accederanno. È consigliabile che gli sviluppatori registrino le applicazioni e assegnino ruoli appropriati. Per altre informazioni, vedere https://aka.ms/identity/AppRegistrationAndRoleAssignment. Se non specificato, gli utenti eseguiranno l'autenticazione in un'applicazione di sviluppo di Azure, che non è consigliata per gli scenari di produzione.
tenantId

ID tenant di Microsoft Entra (directory).
userPromptCallback

Funzione di callback che verrà richiamata per visualizzare DeviceCodeInfo all'utente. Se lasciato non assegnato, le informazioni sul codice del dispositivo verranno automaticamente registrati e le istruzioni di autenticazione nella console.

Proprietà ereditate

additionallyAllowedTenants

Per le applicazioni multi-tenant, specifica tenant aggiuntivi per i quali le credenziali possono acquisire token. Aggiungere il valore jolly "*" per consentire alle credenziali di acquisire i token per qualsiasi tenant installato dall'applicazione.
additionalPolicies

Criteri aggiuntivi da includere nella pipeline HTTP.
allowInsecureConnection

Impostare su true se la richiesta viene inviata tramite HTTP invece di HTTPS
authenticationRecord

Risultato di un'autenticazione precedente che può essere usata per recuperare le credenziali memorizzate nella cache di ogni singolo account. Questa operazione è necessaria per fornire nel caso in cui l'applicazione voglia usare più account per ID client e coppia ID tenant.

Questo record può essere recuperato chiamando il metodo authenticate() delle credenziali, come indicato di seguito:

const authenticationRecord = await credential.authenticate();
authorityHost

Host dell'autorità da usare per le richieste di autenticazione. I valori possibili sono disponibili tramite AzureAuthorityHosts. Il valore predefinito è "https://login.microsoftonline.com".
disableAutomaticAuthentication

Genera un'eccezione getToken se è necessaria un'autenticazione manuale. Gli sviluppatori dovranno chiamare per authenticate() per controllare quando eseguire l'autenticazione manuale.
disableInstanceDiscovery

Il campo determina se l'individuazione dell'istanza viene eseguita durante il tentativo di autenticazione. L'impostazione di questa opzione su true disabilita completamente sia l'individuazione dell'istanza che la convalida dell'autorità. Di conseguenza, è fondamentale assicurarsi che l'host dell'autorità configurata sia valido e affidabile. Questa funzionalità è destinata all'uso in scenari in cui non è possibile raggiungere l'endpoint dei metadati, ad esempio nei cloud privati o in Azure Stack. Il processo di individuazione dell'istanza comporta il recupero dei metadati dell'autorità da https://login.microsoft.com/ per convalidare l'autorità.
httpClient

HttpClient che verrà usato per inviare richieste HTTP.
loggingOptions

Consente agli utenti di configurare le impostazioni per le opzioni dei criteri di registrazione, consentire la registrazione delle informazioni sull'account e le informazioni personali per il supporto tecnico.
proxyOptions

Opzioni per configurare un proxy per le richieste in uscita.
redirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.
retryOptions

Opzioni che controllano come ripetere le richieste non riuscite.
telemetryOptions

Opzioni per impostare dati di telemetria comuni e informazioni di traccia alle richieste in uscita.
tlsOptions

Opzioni per la configurazione dell'autenticazione TLS
tokenCachePersistenceOptions

Opzioni da fornire al livello di persistenza (se disponibile) durante l'archiviazione delle credenziali.

È prima necessario registrare un plug-in del provider di persistenza. Vedere il pacchetto @azure/identity-cache-persistence in Monitoraggio prestazioni rete.

Esempio:

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

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

Opzioni per l'aggiunta dei dettagli dell'agente utente alle richieste in uscita.

Dettagli proprietà

clientId

ID client dell'applicazione Microsoft Entra a cui gli utenti accederanno. È consigliabile che gli sviluppatori registrino le applicazioni e assegnino ruoli appropriati. Per altre informazioni, vedere https://aka.ms/identity/AppRegistrationAndRoleAssignment. Se non specificato, gli utenti eseguiranno l'autenticazione in un'applicazione di sviluppo di Azure, che non è consigliata per gli scenari di produzione.

clientId?: string

Valore della proprietà

string

tenantId

ID tenant di Microsoft Entra (directory).

tenantId?: string

Valore della proprietà

string

userPromptCallback

Funzione di callback che verrà richiamata per visualizzare DeviceCodeInfo all'utente. Se lasciato non assegnato, le informazioni sul codice del dispositivo verranno automaticamente registrati e le istruzioni di autenticazione nella console.

userPromptCallback?: DeviceCodePromptCallback

Valore della proprietà

DeviceCodePromptCallback

Dettagli proprietà ereditate

additionallyAllowedTenants

Per le applicazioni multi-tenant, specifica tenant aggiuntivi per i quali le credenziali possono acquisire token. Aggiungere il valore jolly "*" per consentire alle credenziali di acquisire i token per qualsiasi tenant installato dall'applicazione.

additionallyAllowedTenants?: string[]

Valore della proprietà

string[]

ereditato daInteractiveCredentialOptions.additionalAllowedTenants

additionalPolicies

Criteri aggiuntivi da includere nella pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valore della proprietà

AdditionalPolicyConfig[]

ereditato daInteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

Impostare su true se la richiesta viene inviata tramite HTTP invece di HTTPS

allowInsecureConnection?: boolean

Valore della proprietà

boolean

ereditato daInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Risultato di un'autenticazione precedente che può essere usata per recuperare le credenziali memorizzate nella cache di ogni singolo account. Questa operazione è necessaria per fornire nel caso in cui l'applicazione voglia usare più account per ID client e coppia ID tenant.

Questo record può essere recuperato chiamando il metodo authenticate() delle credenziali, come indicato di seguito:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Valore della proprietà

AuthenticationRecord

ereditato daInteractiveCredentialOptions.authenticationRecord

authorityHost

Host dell'autorità da usare per le richieste di autenticazione. I valori possibili sono disponibili tramite AzureAuthorityHosts. Il valore predefinito è "https://login.microsoftonline.com".

authorityHost?: string

Valore della proprietà

string

ereditato daInteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

Genera un'eccezione getToken se è necessaria un'autenticazione manuale. Gli sviluppatori dovranno chiamare per authenticate() per controllare quando eseguire l'autenticazione manuale.

disableAutomaticAuthentication?: boolean

Valore della proprietà

boolean

Ereditato daInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

Il campo determina se l'individuazione dell'istanza viene eseguita durante il tentativo di autenticazione. L'impostazione di questa opzione su true disabilita completamente sia l'individuazione dell'istanza che la convalida dell'autorità. Di conseguenza, è fondamentale assicurarsi che l'host dell'autorità configurata sia valido e affidabile. Questa funzionalità è destinata all'uso in scenari in cui non è possibile raggiungere l'endpoint dei metadati, ad esempio nei cloud privati o in Azure Stack. Il processo di individuazione dell'istanza comporta il recupero dei metadati dell'autorità da https://login.microsoft.com/ per convalidare l'autorità.

disableInstanceDiscovery?: boolean

Valore della proprietà

boolean

ereditato daInteractiveCredentialOptions.disableInstanceDiscovery

httpClient

HttpClient che verrà usato per inviare richieste HTTP.

httpClient?: HttpClient

Valore della proprietà

HttpClient

ereditato daInteractiveCredentialOptions.httpClient

loggingOptions

Consente agli utenti di configurare le impostazioni per le opzioni dei criteri di registrazione, consentire la registrazione delle informazioni sull'account e le informazioni personali per il supporto tecnico.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Valore della proprietà

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

ereditato daInteractiveCredentialOptions.loggingOptions

proxyOptions

Opzioni per configurare un proxy per le richieste in uscita.

proxyOptions?: ProxySettings

Valore della proprietà

ProxySettings

ereditato daInteractiveCredentialOptions.proxyOptions

redirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.

redirectOptions?: RedirectPolicyOptions

Valore della proprietà

RedirectPolicyOptions

Ereditato daInteractiveCredentialOptions.redirectOptions

retryOptions

Opzioni che controllano come ripetere le richieste non riuscite.

retryOptions?: PipelineRetryOptions

Valore della proprietà

PipelineRetryOptions

Ereditato daInteractiveCredentialOptions.retryOptions

telemetryOptions

Opzioni per impostare dati di telemetria comuni e informazioni di traccia alle richieste in uscita.

telemetryOptions?: TelemetryOptions

Valore della proprietà

TelemetryOptions

ereditato daInteractiveCredentialOptions.telemetryOptions

tlsOptions

Opzioni per la configurazione dell'autenticazione TLS

tlsOptions?: TlsSettings

Valore della proprietà

TlsSettings

ereditato daInteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Opzioni da fornire al livello di persistenza (se disponibile) durante l'archiviazione delle credenziali.

È prima necessario registrare un plug-in del provider di persistenza. Vedere il pacchetto @azure/identity-cache-persistence in Monitoraggio prestazioni rete.

Esempio:

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

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

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Valore della proprietà

TokenCachePersistenceOptions

Ereditato daCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Opzioni per l'aggiunta dei dettagli dell'agente utente alle richieste in uscita.

userAgentOptions?: UserAgentPolicyOptions

Valore della proprietà

UserAgentPolicyOptions

Ereditato daInteractiveCredentialOptions.userAgentOptions