InteractiveCredentialOptions interface

Pacchetto:

@azure/identity

Opzioni comuni del costruttore per le credenziali di identità che richiedono l'interazione dell'utente.

Extends

MultiTenantTokenCredentialOptions,AuthorityValidationOptions

Proprietà

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();

disableAutomaticAuthentication

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

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.
agent	Opzioni per la configurazione dell'istanza di Agent per le richieste in uscita
allowInsecureConnection	Impostare su true se la richiesta viene inviata tramite HTTP invece di HTTPS
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".
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
userAgentOptions	Opzioni per l'aggiunta dei dettagli dell'agente utente alle richieste in uscita.

Dettagli proprietà

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

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

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 daMultiTenantTokenCredentialOptions.additionalAllowedTenants

additionalPolicies

Criteri aggiuntivi da includere nella pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valore della proprietà

AdditionalPolicyConfig[]

Ereditato daMultiTenantTokenCredentialOptions.additionalPolicies

agent

Opzioni per la configurazione dell'istanza di Agent per le richieste in uscita

agent?: Agent

Valore della proprietà

Agent

Ereditato daMultiTenantTokenCredentialOptions.agent

allowInsecureConnection

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

allowInsecureConnection?: boolean

Valore della proprietà

boolean

Ereditato daMultiTenantTokenCredentialOptions.allowInsecureConnection

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 daMultiTenantTokenCredentialOptions.authorityHost

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 daAuthorityValidationOptions.disableInstanceDiscovery

httpClient

HttpClient che verrà usato per inviare richieste HTTP.

httpClient?: HttpClient

Valore della proprietà

HttpClient

ereditato daMultiTenantTokenCredentialOptions.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 daMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

Opzioni per configurare un proxy per le richieste in uscita.

proxyOptions?: ProxySettings

Valore della proprietà

ProxySettings

Ereditato daMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.

redirectOptions?: RedirectPolicyOptions

Valore della proprietà

RedirectPolicyOptions

Ereditato daMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

Opzioni che controllano come ripetere le richieste non riuscite.

retryOptions?: PipelineRetryOptions

Valore della proprietà

PipelineRetryOptions

Ereditato daMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Valore della proprietà

TelemetryOptions

Ereditato daMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Opzioni per la configurazione dell'autenticazione TLS

tlsOptions?: TlsSettings

Valore della proprietà

TlsSettings

Ereditato daMultiTenantTokenCredentialOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Valore della proprietà

UserAgentPolicyOptions

Ereditato daMultiTenantTokenCredentialOptions.userAgentOptions