Delen via

InteractiveBrowserCredentialNodeOptions interface

  • Referentie
Pakket:
@azure/identity

Definieert de algemene opties voor de klasse InteractiveBrowserCredential.

Uitbreiding

InteractiveCredentialOptions,CredentialPersistenceOptions,BrowserCustomizationOptions,BrokerAuthOptions

Eigenschappen

clientId

De client-id van de Microsoft Entra-toepassing waarmee gebruikers zich aanmelden. Het wordt aanbevolen dat ontwikkelaars hun toepassingen registreren en de juiste rollen toewijzen. Ga naar https://aka.ms/identity/AppRegistrationAndRoleAssignmentvoor meer informatie. Als dit niet is opgegeven, verifiëren gebruikers zich bij een Azure-ontwikkeltoepassing. Dit wordt niet aanbevolen voor productiescenario's.
loginHint

met loginHint kan een gebruikersnaam vooraf worden geselecteerd voor interactieve aanmeldingen. Als u deze optie instelt, wordt de prompt voor accountselectie overgeslagen en wordt onmiddellijk geprobeerd u aan te melden met het opgegeven account.
redirectUri

Haalt de omleidings-URI van de toepassing op. Dit moet hetzelfde zijn als de waarde in de toepassingsregistratieportal. Standaard ingesteld op window.location.href. Dit veld is niet meer vereist voor Node.js.
tenantId

De id van de Microsoft Entra-tenant (directory).

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 heeft geïnstalleerd.
additionalPolicies

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

Opties voor het configureren van agentexemplaren voor uitgaande aanvragen
allowInsecureConnection

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

Resultaat van een eerdere verificatie die kan worden gebruikt om de referenties in de cache van elk afzonderlijk account op te halen. 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 authenticate() methode van de referentie aan te roepen:

const authenticationRecord = await credential.authenticate();
authorityHost

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

Opties voor brokerverificatie bij het gebruik van InteractiveBrowserCredential
browserCustomizationOptions

Gedeelde configuratieopties voor browseraanpassing
disableAutomaticAuthentication

Hiermee wordt getToken gegenereerd als handmatige verificatie nodig is. Ontwikkelaars moeten authenticate() aanroepen om te bepalen wanneer ze handmatig moeten worden geverifieerd.
disableInstanceDiscovery

Het veld bepaalt of exemplaardetectie wordt uitgevoerd bij het verifiëren. Als u dit instelt op true, worden zowel de detectie van exemplaren als de validatie van de instantie volledig uitgeschakeld. Als gevolg hiervan is het van cruciaal belang 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 opties voor logboekregistratiebeleid, accountgegevens voor logboekregistratie en persoonsgegevens toestaan voor klantondersteuning.
proxyOptions

Opties voor het configureren van een proxy voor uitgaande aanvragen.
redirectOptions

Opties voor de manier waarop omleidingsreacties worden verwerkt.
retryOptions

Opties voor het opnieuw proberen van mislukte aanvragen.
telemetryOptions

Opties voor het instellen van algemene telemetrie en traceringsgegevens voor uitgaande aanvragen.
tlsOptions

Opties voor het configureren van TLS-verificatie
tokenCachePersistenceOptions

Opties voor de persistentielaag (indien beschikbaar) bij het opslaan van referenties.

U moet eerst een invoegtoepassing voor de persistentieprovider registreren. Zie het @azure/identity-cache-persistence-pakket op NPM.

Voorbeeld:

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

useIdentityPlugin(cachePersistencePlugin);

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

Opties voor het toevoegen van gebruikersagentgegevens aan uitgaande aanvragen.

Eigenschapdetails

clientId

De client-id van de Microsoft Entra-toepassing waarmee gebruikers zich aanmelden. Het wordt aanbevolen dat ontwikkelaars hun toepassingen registreren en de juiste rollen toewijzen. Ga naar https://aka.ms/identity/AppRegistrationAndRoleAssignmentvoor meer informatie. Als dit niet is opgegeven, verifiëren gebruikers zich bij een Azure-ontwikkeltoepassing. Dit wordt niet aanbevolen voor productiescenario's.

clientId?: string

Waarde van eigenschap

string

loginHint

met loginHint kan een gebruikersnaam vooraf worden geselecteerd voor interactieve aanmeldingen. Als u deze optie instelt, wordt de prompt voor accountselectie overgeslagen en wordt onmiddellijk geprobeerd u aan te melden met het opgegeven account.

loginHint?: string

Waarde van eigenschap

string

redirectUri

Haalt de omleidings-URI van de toepassing op. Dit moet hetzelfde zijn als de waarde in de toepassingsregistratieportal. Standaard ingesteld op window.location.href. Dit veld is niet meer vereist voor Node.js.

redirectUri?: string | () => string

Waarde van eigenschap

string | () => string

tenantId

De id van de Microsoft Entra-tenant (directory).

tenantId?: string

Waarde van eigenschap

string

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 heeft geïnstalleerd.

additionallyAllowedTenants?: string[]

Waarde van eigenschap

string[]

overgenomen vanInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Waarde van eigenschap

AdditionalPolicyConfig[]

overgenomen vanInteractiveCredentialOptions.additionalPolicies

agent

Opties voor het configureren van agentexemplaren voor uitgaande aanvragen

agent?: Agent

Waarde van eigenschap

Agent

overgenomen vanInteractiveCredentialOptions.agent

allowInsecureConnection

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

allowInsecureConnection?: boolean

Waarde van eigenschap

boolean

overgenomen vanInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Resultaat van een eerdere verificatie die kan worden gebruikt om de referenties in de cache van elk afzonderlijk account op te halen. 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 authenticate() methode van de referentie aan te roepen:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Waarde van eigenschap

AuthenticationRecord

overgenomen vanInteractiveCredentialOptions.authenticationRecord

authorityHost

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

authorityHost?: string

Waarde van eigenschap

string

overgenomen vanInteractiveCredentialOptions.authorityHost-

brokerOptions

Opties voor brokerverificatie bij het gebruik van InteractiveBrowserCredential

brokerOptions?: BrokerOptions

Waarde van eigenschap

BrokerOptions

overgenomen vanBrokerAuthOptions.brokerOptions-

browserCustomizationOptions

Gedeelde configuratieopties voor browseraanpassing

browserCustomizationOptions?: { errorMessage?: string, successMessage?: string }

Waarde van eigenschap

{ errorMessage?: string, successMessage?: string }

overgenomen vanBrowserCustomizationOptions.browserCustomizationOptions-

disableAutomaticAuthentication

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

disableAutomaticAuthentication?: boolean

Waarde van eigenschap

boolean

overgenomen vanInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

Het veld bepaalt of exemplaardetectie wordt uitgevoerd bij het verifiëren. Als u dit instelt op true, worden zowel de detectie van exemplaren als de validatie van de instantie volledig uitgeschakeld. Als gevolg hiervan is het van cruciaal belang 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 vanInteractiveCredentialOptions.disableInstanceDiscovery-

httpClient

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

httpClient?: HttpClient

Waarde van eigenschap

HttpClient

overgenomen vanInteractiveCredentialOptions.httpClient-

loggingOptions

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

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

Waarde van eigenschap

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

overgenomen vanInteractiveCredentialOptions.loggingOptions

proxyOptions

Opties voor het configureren van een proxy voor uitgaande aanvragen.

proxyOptions?: ProxySettings

Waarde van eigenschap

ProxySettings

overgenomen vanInteractiveCredentialOptions.proxyOptions

redirectOptions

Opties voor de manier waarop omleidingsreacties worden verwerkt.

redirectOptions?: RedirectPolicyOptions

Waarde van eigenschap

RedirectPolicyOptions

overgenomen vanInteractiveCredentialOptions.redirectOptions

retryOptions

Opties voor het opnieuw proberen van mislukte aanvragen.

retryOptions?: PipelineRetryOptions

Waarde van eigenschap

PipelineRetryOptions

overgenomen vanInteractiveCredentialOptions.retryOptions

telemetryOptions

Opties voor het instellen van algemene telemetrie en traceringsgegevens voor uitgaande aanvragen.

telemetryOptions?: TelemetryOptions

Waarde van eigenschap

TelemetryOptions

overgenomen vanInteractiveCredentialOptions.telemetryOptions

tlsOptions

Opties voor het configureren van TLS-verificatie

tlsOptions?: TlsSettings

Waarde van eigenschap

TlsSettings

overgenomen vanInteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Opties voor de persistentielaag (indien beschikbaar) bij het opslaan van referenties.

U moet eerst een invoegtoepassing voor de persistentieprovider registreren. Zie het @azure/identity-cache-persistence-pakket op NPM.

Voorbeeld:

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

useIdentityPlugin(cachePersistencePlugin);

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

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Waarde van eigenschap

TokenCachePersistenceOptions

overgenomen vanCredentialPersistenceOptions.tokenCachePersistenceOptions-

userAgentOptions

Opties voor het toevoegen van gebruikersagentgegevens aan uitgaande aanvragen.

userAgentOptions?: UserAgentPolicyOptions

Waarde van eigenschap

UserAgentPolicyOptions

overgenomen vanInteractiveCredentialOptions.userAgentOptions-