InteractiveBrowserCredentialNodeOptions interface

Csomag:

@azure/identity

Meghatározza az InteractiveBrowserCredential osztály gyakori beállításait.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions,BrowserCustomizationOptions,BrokerAuthOptions

Tulajdonságok

clientId	Annak a Microsoft Entra-alkalmazásnak az ügyfélazonosítója, amelybe a felhasználók bejelentkeznek. Javasoljuk, hogy a fejlesztők regisztrálják az alkalmazásaikat, és rendeljenek hozzá megfelelő szerepköröket. További információ: https://aka.ms/identity/AppRegistrationAndRoleAssignment. Ha nincs megadva, a felhasználók hitelesítést fognak végezni egy Azure-fejlesztési alkalmazáson, ami éles forgatókönyvekhez nem ajánlott.
loginHint	A loginHint lehetővé teszi, hogy egy felhasználónevet előre kijelöljön az interaktív bejelentkezésekhez. Ennek a beállításnak a beállítása kihagyja a fiókválasztási kérést, és azonnal megkísérli a bejelentkezést a megadott fiókkal.
redirectUri	Lekéri az alkalmazás átirányítási URI-ját. Ennek meg kell egyeznie az alkalmazásregisztrációs portál értékével. Alapértelmezés szerint window.location.href. Ez a mező már nem szükséges Node.js.
tenantId	A Microsoft Entra-bérlő (címtár) azonosítója.

Örökölt tulajdonságok

additionallyAllowedTenants	Több-bérlős alkalmazások esetén további bérlőket határoz meg, amelyekhez a hitelesítő adatok jogkivonatokat szerezhetnek be. Adja hozzá a "*" helyettesítő karaktert, hogy a hitelesítő adatok jogkivonatokat szerezzenek be az alkalmazás által telepített összes bérlőhöz.
additionalPolicies	A HTTP-folyamatba belefoglalandó további szabályzatok.
agent	Az ügynökpéldány konfigurálásának lehetőségei kimenő kérelmekhez
allowInsecureConnection	Igaz értékre van állítva, ha a kérés HTTP-en keresztül van elküldve HTTPS helyett
authenticationRecord	Az egyes fiókok gyorsítótárazott hitelesítő adatainak lekérésére használható korábbi hitelesítés eredménye. Erre azért van szükség, hogy az alkalmazás ügyfél-azonosítónként és bérlőazonosító-páronként több fiókkal működjön együtt. Ez a rekord a hitelesítő adatok authenticate() metódusának meghívásával kérhető le, az alábbiak szerint: const authenticationRecord = await credential.authenticate();
authorityHost	A hitelesítési kérelmekhez használni kívánt szolgáltatói állomás. A lehetséges értékek az AzureAuthorityHostskeresztül érhetők el. Az alapértelmezett érték a "https://login.microsoftonline.com".
brokerOptions	A közvetítő hitelesítésének engedélyezése az InteractiveBrowserCredential használatakor
browserCustomizationOptions	Megosztott konfigurációs beállítások a böngésző testreszabásához
disableAutomaticAuthentication	A getToken dobást végez, ha manuális hitelesítésre van szükség. A fejlesztőknek fel kell hívniuk a authenticate(), hogy szabályozni fogják, mikor kell manuálisan hitelesíteni.
disableInstanceDiscovery	A mező azt határozza meg, hogy a példányfelderítés a hitelesítés megkísérlésekor történik-e. A true beállítása teljesen letiltja a példányfelderítést és a hitelesítést is. Ennek eredményeképpen elengedhetetlen annak biztosítása, hogy a konfigurált szolgáltatói gazdagép érvényes és megbízható legyen. Ez a funkció olyan helyzetekben használható, ahol a metaadat-végpont nem érhető el, például magánfelhőkben vagy Az Azure Stackben. A példányfelderítés folyamata magában foglalja a szolgáltató metaadatainak lekérését https://login.microsoft.com/ a szolgáltató ellenőrzéséhez.
httpClient	A HTTP-kérések küldéséhez használt HttpClient.
loggingOptions	Lehetővé teszi a felhasználók számára a naplózási házirend beállításainak konfigurálását, a naplózási fiók adatainak és az ügyfélszolgálat személyazonosításra alkalmas információinak megadását.
proxyOptions	A kimenő kérelmek proxyjának konfigurálására szolgáló beállítások.
redirectOptions	Az átirányítási válaszok kezelésének beállításai.
retryOptions	A sikertelen kérések újrapróbálkozására vonatkozó beállítások.
telemetryOptions	A gyakori telemetriai és nyomkövetési adatok kimenő kérelmekre való beállításának beállításai.
tlsOptions	A TLS-hitelesítés konfigurálásának lehetőségei
tokenCachePersistenceOptions	A hitelesítő adatok tárolásakor megadható beállítások az adatmegőrzési rétegnek (ha van ilyen). Először regisztrálnia kell egy adatmegőrzési szolgáltató beépülő modult. Tekintse meg a @azure/identity-cache-persistence csomagot az NPM-en. Példa: import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity"; useIdentityPlugin(cachePersistencePlugin); const credential = new DeviceCodeCredential({ tokenCachePersistenceOptions: { enabled: true, }, });
userAgentOptions	A felhasználói ügynök adatainak a kimenő kérelmekhez való hozzáadásának lehetőségei.

Tulajdonság adatai

clientId

Annak a Microsoft Entra-alkalmazásnak az ügyfélazonosítója, amelybe a felhasználók bejelentkeznek. Javasoljuk, hogy a fejlesztők regisztrálják az alkalmazásaikat, és rendeljenek hozzá megfelelő szerepköröket. További információ: https://aka.ms/identity/AppRegistrationAndRoleAssignment. Ha nincs megadva, a felhasználók hitelesítést fognak végezni egy Azure-fejlesztési alkalmazáson, ami éles forgatókönyvekhez nem ajánlott.

clientId?: string

Tulajdonság értéke

string

loginHint

A loginHint lehetővé teszi, hogy egy felhasználónevet előre kijelöljön az interaktív bejelentkezésekhez. Ennek a beállításnak a beállítása kihagyja a fiókválasztási kérést, és azonnal megkísérli a bejelentkezést a megadott fiókkal.

loginHint?: string

Tulajdonság értéke

string

redirectUri

Lekéri az alkalmazás átirányítási URI-ját. Ennek meg kell egyeznie az alkalmazásregisztrációs portál értékével. Alapértelmezés szerint window.location.href. Ez a mező már nem szükséges Node.js.

redirectUri?: string | () => string

Tulajdonság értéke

string | () => string

tenantId

A Microsoft Entra-bérlő (címtár) azonosítója.

tenantId?: string

Tulajdonság értéke

string

Örökölt tulajdonság részletei

additionallyAllowedTenants

Több-bérlős alkalmazások esetén további bérlőket határoz meg, amelyekhez a hitelesítő adatok jogkivonatokat szerezhetnek be. Adja hozzá a "*" helyettesítő karaktert, hogy a hitelesítő adatok jogkivonatokat szerezzenek be az alkalmazás által telepített összes bérlőhöz.

additionallyAllowedTenants?: string[]

Tulajdonság értéke

string[]

InteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

A HTTP-folyamatba belefoglalandó további szabályzatok.

additionalPolicies?: AdditionalPolicyConfig[]

Tulajdonság értéke

AdditionalPolicyConfig[]

InteractiveCredentialOptions.additionalPolicies

agent

Az ügynökpéldány konfigurálásának lehetőségei kimenő kérelmekhez

agent?: Agent

Tulajdonság értéke

Agent

InteractiveCredentialOptions.agent

allowInsecureConnection

Igaz értékre van állítva, ha a kérés HTTP-en keresztül van elküldve HTTPS helyett

allowInsecureConnection?: boolean

Tulajdonság értéke

boolean

InteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Az egyes fiókok gyorsítótárazott hitelesítő adatainak lekérésére használható korábbi hitelesítés eredménye. Erre azért van szükség, hogy az alkalmazás ügyfél-azonosítónként és bérlőazonosító-páronként több fiókkal működjön együtt.

Ez a rekord a hitelesítő adatok authenticate() metódusának meghívásával kérhető le, az alábbiak szerint:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Tulajdonság értéke

AuthenticationRecord

ÖrököltInteractiveCredentialOptions.authenticationRecord

authorityHost

A hitelesítési kérelmekhez használni kívánt szolgáltatói állomás. A lehetséges értékek az AzureAuthorityHostskeresztül érhetők el. Az alapértelmezett érték a "https://login.microsoftonline.com".

authorityHost?: string

Tulajdonság értéke

string

InteractiveCredentialOptions.authorityHost

brokerOptions

A közvetítő hitelesítésének engedélyezése az InteractiveBrowserCredential használatakor

brokerOptions?: BrokerOptions

Tulajdonság értéke

BrokerOptions

BrokerAuthOptions.brokerOptions

browserCustomizationOptions

Megosztott konfigurációs beállítások a böngésző testreszabásához

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

Tulajdonság értéke

{ errorMessage?: string, successMessage?: string }

ÖrököltBrowserCustomizationOptions.browserCustomizationOptions

disableAutomaticAuthentication

A getToken dobást végez, ha manuális hitelesítésre van szükség. A fejlesztőknek fel kell hívniuk a authenticate(), hogy szabályozni fogják, mikor kell manuálisan hitelesíteni.

disableAutomaticAuthentication?: boolean

Tulajdonság értéke

boolean

InteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

A mező azt határozza meg, hogy a példányfelderítés a hitelesítés megkísérlésekor történik-e. A true beállítása teljesen letiltja a példányfelderítést és a hitelesítést is. Ennek eredményeképpen elengedhetetlen annak biztosítása, hogy a konfigurált szolgáltatói gazdagép érvényes és megbízható legyen. Ez a funkció olyan helyzetekben használható, ahol a metaadat-végpont nem érhető el, például magánfelhőkben vagy Az Azure Stackben. A példányfelderítés folyamata magában foglalja a szolgáltató metaadatainak lekérését https://login.microsoft.com/ a szolgáltató ellenőrzéséhez.

disableInstanceDiscovery?: boolean

Tulajdonság értéke

boolean

InteractiveCredentialOptions.disableInstanceDiscovery

httpClient

A HTTP-kérések küldéséhez használt HttpClient.

httpClient?: HttpClient

Tulajdonság értéke

HttpClient

InteractiveCredentialOptions.httpClient

loggingOptions

Lehetővé teszi a felhasználók számára a naplózási házirend beállításainak konfigurálását, a naplózási fiók adatainak és az ügyfélszolgálat személyazonosításra alkalmas információinak megadását.

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

Tulajdonság értéke

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

InteractiveCredentialOptions.loggingOptions

proxyOptions

A kimenő kérelmek proxyjának konfigurálására szolgáló beállítások.

proxyOptions?: ProxySettings

Tulajdonság értéke

ProxySettings

InteractiveCredentialOptions.proxyOptions

redirectOptions

Az átirányítási válaszok kezelésének beállításai.

redirectOptions?: RedirectPolicyOptions

Tulajdonság értéke

RedirectPolicyOptions

InteractiveCredentialOptions.redirectOptions

retryOptions

A sikertelen kérések újrapróbálkozására vonatkozó beállítások.

retryOptions?: PipelineRetryOptions

Tulajdonság értéke

PipelineRetryOptions

InteractiveCredentialOptions.retryOptions

telemetryOptions

A gyakori telemetriai és nyomkövetési adatok kimenő kérelmekre való beállításának beállításai.

telemetryOptions?: TelemetryOptions

Tulajdonság értéke

TelemetryOptions

InteractiveCredentialOptions.telemetryOptions

tlsOptions

A TLS-hitelesítés konfigurálásának lehetőségei

tlsOptions?: TlsSettings

Tulajdonság értéke

TlsSettings

InteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

A hitelesítő adatok tárolásakor megadható beállítások az adatmegőrzési rétegnek (ha van ilyen).

Először regisztrálnia kell egy adatmegőrzési szolgáltató beépülő modult. Tekintse meg a @azure/identity-cache-persistence csomagot az NPM-en.

Példa:

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

useIdentityPlugin(cachePersistencePlugin);

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

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Tulajdonság értéke

TokenCachePersistenceOptions

ÖrököltCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

A felhasználói ügynök adatainak a kimenő kérelmekhez való hozzáadásának lehetőségei.

userAgentOptions?: UserAgentPolicyOptions

Tulajdonság értéke

UserAgentPolicyOptions

InteractiveCredentialOptions.userAgentOptions