InteractiveCredentialOptions interface

Pakket:

@azure/identity

Algemene constructoropties voor de identiteitsreferenties waarvoor gebruikersinteractie is vereist.

Extends

MultiTenantTokenCredentialOptions,AuthorityValidationOptions

Eigenschappen

authenticationRecord

Resultaat van een eerdere verificatie die kan worden gebruikt voor het ophalen van de referenties in de cache van elk afzonderlijk account. Dit is nodig om op te geven voor het geval de toepassing met meer dan één account per client-id en tenant-id-paar wil werken. Deze record kan als volgt worden opgehaald door de methode van authenticate() de referentie aan te roepen: const authenticationRecord = await credential.authenticate();

disableAutomaticAuthentication

Hiermee wordt getToken gegenereerd als handmatige verificatie nodig is. Ontwikkelaars moeten aanroepen om authenticate() te bepalen wanneer ze handmatig moeten verifiëren.

Overgenomen eigenschappen

additionallyAllowedTenants	Voor toepassingen met meerdere tenants geeft u extra tenants op waarvoor de referentie tokens kan verkrijgen. Voeg de jokertekenwaarde *toe om de referentie toe te staan tokens te verkrijgen voor elke tenant die de toepassing is geïnstalleerd.
additionalPolicies	Aanvullende beleidsregels die moeten worden opgenomen in de HTTP-pijplijn.
allowInsecureConnection	Ingesteld op waar als de aanvraag wordt verzonden via HTTP in plaats van HTTPS
authorityHost	De instantiehost die moet worden gebruikt voor verificatieaanvragen. Mogelijke waarden zijn beschikbaar via AzureAuthorityHosts. De standaardwaarde is "https://login.microsoftonline.com".
disableInstanceDiscovery	Het veld bepaalt of exemplaardetectie wordt uitgevoerd bij een verificatiepoging. Als u dit instelt op true , wordt zowel exemplaardetectie als instantievalidatie volledig uitgeschakeld. Daarom is het essentieel om ervoor te zorgen dat de geconfigureerde instantiehost geldig en betrouwbaar is. Deze functionaliteit is bedoeld voor gebruik in scenario's waarin het eindpunt voor metagegevens niet kan worden bereikt, zoals in privéclouds of Azure Stack. Het proces van exemplaardetectie omvat het ophalen van instantiemetagegevens van https://login.microsoft.com/ om de instantie te valideren.
httpClient	De HttpClient die wordt gebruikt voor het verzenden van HTTP-aanvragen.
loggingOptions	Hiermee kunnen gebruikers instellingen configureren voor beleidsopties voor logboekregistratie, accountgegevens voor logboekregistratie en persoonsgegevens voor klantondersteuning toestaan.
proxyOptions	Opties voor het configureren van een proxy voor uitgaande aanvragen.
redirectOptions	Opties voor hoe omleidingsreacties worden verwerkt.
retryOptions	Opties die bepalen hoe mislukte aanvragen opnieuw moeten worden geprobeerd.
telemetryOptions	Opties voor het instellen van algemene telemetrie en het traceren van gegevens voor uitgaande aanvragen.
tlsOptions	Opties voor het configureren van TLS-verificatie
userAgentOptions	Opties voor het toevoegen van gebruikersagentgegevens aan uitgaande aanvragen.

Eigenschapdetails

authenticationRecord

Resultaat van een eerdere verificatie die kan worden gebruikt voor het ophalen van de referenties in de cache van elk afzonderlijk account. Dit is nodig om op te geven voor het geval de toepassing met meer dan één account per client-id en tenant-id-paar wil werken.

Deze record kan als volgt worden opgehaald door de methode van authenticate() de referentie aan te roepen:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Waarde van eigenschap

AuthenticationRecord

disableAutomaticAuthentication

Hiermee wordt getToken gegenereerd als handmatige verificatie nodig is. Ontwikkelaars moeten aanroepen om authenticate() te bepalen wanneer ze handmatig moeten verifiëren.

disableAutomaticAuthentication?: boolean

Waarde van eigenschap

boolean

Details van overgenomen eigenschap

additionallyAllowedTenants

Voor toepassingen met meerdere tenants geeft u extra tenants op waarvoor de referentie tokens kan verkrijgen. Voeg de jokertekenwaarde *toe om de referentie toe te staan tokens te verkrijgen voor elke tenant die de toepassing is geïnstalleerd.

additionallyAllowedTenants?: string[]

Waarde van eigenschap

string[]

Overgenomen vanMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

Aanvullende beleidsregels die moeten worden opgenomen in de HTTP-pijplijn.

additionalPolicies?: AdditionalPolicyConfig[]

Waarde van eigenschap

AdditionalPolicyConfig[]

Overgenomen vanMultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

Ingesteld op waar als de aanvraag wordt verzonden via HTTP in plaats van HTTPS

allowInsecureConnection?: boolean

Waarde van eigenschap

boolean

Overgenomen vanMultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

De instantiehost die moet worden gebruikt voor verificatieaanvragen. Mogelijke waarden zijn beschikbaar via AzureAuthorityHosts. De standaardwaarde is "https://login.microsoftonline.com".

authorityHost?: string

Waarde van eigenschap

string

Overgenomen vanMultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

Het veld bepaalt of exemplaardetectie wordt uitgevoerd bij een verificatiepoging. Als u dit instelt op true , wordt zowel exemplaardetectie als instantievalidatie volledig uitgeschakeld. Daarom is het essentieel om ervoor te zorgen dat de geconfigureerde instantiehost geldig en betrouwbaar is. Deze functionaliteit is bedoeld voor gebruik in scenario's waarin het eindpunt voor metagegevens niet kan worden bereikt, zoals in privéclouds of Azure Stack. Het proces van exemplaardetectie omvat het ophalen van instantiemetagegevens van https://login.microsoft.com/ om de instantie te valideren.

disableInstanceDiscovery?: boolean

Waarde van eigenschap

boolean

Overgenomen vanAuthorityValidationOptions.disableInstanceDiscovery

httpClient

De HttpClient die wordt gebruikt voor het verzenden van HTTP-aanvragen.

httpClient?: HttpClient

Waarde van eigenschap

HttpClient

Overgenomen vanMultiTenantTokenCredentialOptions.httpClient

loggingOptions

Hiermee kunnen gebruikers instellingen configureren voor beleidsopties voor logboekregistratie, accountgegevens voor logboekregistratie en persoonsgegevens voor klantondersteuning toestaan.

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

Waarde van eigenschap

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

Overgenomen vanMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

Opties voor het configureren van een proxy voor uitgaande aanvragen.

proxyOptions?: ProxySettings

Waarde van eigenschap

ProxySettings

Overgenomen vanMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Opties voor hoe omleidingsreacties worden verwerkt.

redirectOptions?: RedirectPolicyOptions

Waarde van eigenschap

RedirectPolicyOptions

Overgenomen vanMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

Opties die bepalen hoe mislukte aanvragen opnieuw moeten worden geprobeerd.

retryOptions?: PipelineRetryOptions

Waarde van eigenschap

PipelineRetryOptions

Overgenomen vanMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

Opties voor het instellen van algemene telemetrie en het traceren van gegevens voor uitgaande aanvragen.

telemetryOptions?: TelemetryOptions

Waarde van eigenschap

TelemetryOptions

Overgenomen vanMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Opties voor het configureren van TLS-verificatie

tlsOptions?: TlsSettings

Waarde van eigenschap

TlsSettings

Overgenomen vanMultiTenantTokenCredentialOptions.tlsOptions

userAgentOptions

Opties voor het toevoegen van gebruikersagentgegevens aan uitgaande aanvragen.

userAgentOptions?: UserAgentPolicyOptions

Waarde van eigenschap

UserAgentPolicyOptions

Overgenomen vanMultiTenantTokenCredentialOptions.userAgentOptions