InteractiveBrowserCredentialNodeOptions interface
Definierar de vanliga alternativen för klassen InteractiveBrowserCredential.
- Extends
Egenskaper
client |
Klient-ID för en appregistrering i klientorganisationen. |
login |
loginHint tillåter att ett användarnamn förvals för interaktiva inloggningar. Om du anger det här alternativet hoppar du över frågan om kontoval och försöker omedelbart logga in med det angivna kontot. |
redirect |
Hämtar programmets omdirigerings-URI. Detta bör vara samma som värdet i programregistreringsportalen. Standardvärdet är |
tenant |
ID:t för Microsoft Entra klientorganisation (katalog). |
Ärvda egenskaper
additionally |
För program med flera klientorganisationer anger ytterligare klienter för vilka autentiseringsuppgifterna kan hämta token. Lägg till jokertecknets värde "*" så att autentiseringsuppgifterna kan hämta token för alla klientorganisationer som programmet är installerat. |
additional |
Ytterligare principer som ska ingå i HTTP-pipelinen. |
allow |
Ange till true om begäran skickas via HTTP i stället för HTTPS |
authentication |
Resultatet av en tidigare autentisering som kan användas för att hämta cachelagrade autentiseringsuppgifter för varje enskilt konto. Detta är nödvändigt för att ange om programmet vill arbeta med mer än ett konto per klient-ID och klient-ID-par. Den här posten kan hämtas genom att anropa autentiseringsuppgiftens
|
authority |
Den utfärdarvärd som ska användas för autentiseringsbegäranden. Möjliga värden är tillgängliga via AzureAuthorityHosts. Standardvärdet är "https://login.microsoftonline.com". |
broker |
Alternativ för att tillåta asynkron autentisering när du använder InteractiveBrowserCredential |
browser |
Delade konfigurationsalternativ för webbläsaranpassning |
disable |
Gör att getToken utlöser om en manuell autentisering krävs.
Utvecklare måste anropa för att |
disable |
Fältet avgör om instansidentifiering utförs vid försök att autentisera.
Om du anger detta inaktiveras |
http |
Den HttpClient som ska användas för att skicka HTTP-begäranden. |
logging |
Tillåter användare att konfigurera inställningar för loggningsprincipalternativ, tillåta loggning av kontoinformation och personligt identifierbar information för kundsupport. |
proxy |
Alternativ för att konfigurera en proxy för utgående begäranden. |
redirect |
Alternativ för hur omdirigeringssvar hanteras. |
retry |
Alternativ som styr hur du försöker utföra misslyckade begäranden igen. |
telemetry |
Alternativ för att ange vanlig telemetri och spårningsinformation för utgående begäranden. |
tls |
Alternativ för att konfigurera TLS-autentisering |
token |
Alternativ för att tillhandahålla beständighetsskiktet (om en är tillgänglig) vid lagring av autentiseringsuppgifter. Du måste först registrera ett plugin-program för beständighetsprovider. Se paketet på Exempel:
|
user |
Alternativ för att lägga till användaragentinformation i utgående begäranden. |
Egenskapsinformation
clientId
Klient-ID för en appregistrering i klientorganisationen.
clientId?: string
Egenskapsvärde
string
loginHint
loginHint tillåter att ett användarnamn förvals för interaktiva inloggningar. Om du anger det här alternativet hoppar du över frågan om kontoval och försöker omedelbart logga in med det angivna kontot.
loginHint?: string
Egenskapsvärde
string
redirectUri
Hämtar programmets omdirigerings-URI. Detta bör vara samma som värdet i programregistreringsportalen. Standardvärdet är window.location.href
.
Det här fältet krävs inte längre för Node.js.
redirectUri?: string | () => string
Egenskapsvärde
string | () => string
tenantId
ID:t för Microsoft Entra klientorganisation (katalog).
tenantId?: string
Egenskapsvärde
string
Information om ärvda egenskaper
additionallyAllowedTenants
För program med flera klientorganisationer anger ytterligare klienter för vilka autentiseringsuppgifterna kan hämta token. Lägg till jokertecknets värde "*" så att autentiseringsuppgifterna kan hämta token för alla klientorganisationer som programmet är installerat.
additionallyAllowedTenants?: string[]
Egenskapsvärde
string[]
Ärvd frånInteractiveCredentialOptions.additionallyAllowedTenants
additionalPolicies
Ytterligare principer som ska ingå i HTTP-pipelinen.
additionalPolicies?: AdditionalPolicyConfig[]
Egenskapsvärde
allowInsecureConnection
Ange till true om begäran skickas via HTTP i stället för HTTPS
allowInsecureConnection?: boolean
Egenskapsvärde
boolean
Ärvd frånInteractiveCredentialOptions.allowInsecureConnection
authenticationRecord
Resultatet av en tidigare autentisering som kan användas för att hämta cachelagrade autentiseringsuppgifter för varje enskilt konto. Detta är nödvändigt för att ange om programmet vill arbeta med mer än ett konto per klient-ID och klient-ID-par.
Den här posten kan hämtas genom att anropa autentiseringsuppgiftens authenticate()
metod enligt följande:
const authenticationRecord = await credential.authenticate();
authenticationRecord?: AuthenticationRecord
Egenskapsvärde
authorityHost
Den utfärdarvärd som ska användas för autentiseringsbegäranden. Möjliga värden är tillgängliga via AzureAuthorityHosts. Standardvärdet är "https://login.microsoftonline.com".
authorityHost?: string
Egenskapsvärde
string
brokerOptions
Alternativ för att tillåta asynkron autentisering när du använder InteractiveBrowserCredential
brokerOptions?: BrokerOptions
Egenskapsvärde
Ärvd frånBrokerAuthOptions.brokerOptions
browserCustomizationOptions
Delade konfigurationsalternativ för webbläsaranpassning
browserCustomizationOptions?: { errorMessage?: string, successMessage?: string }
Egenskapsvärde
{ errorMessage?: string, successMessage?: string }
Ärvd frånBrowserCustomizationOptions.browserCustomizationOptions
disableAutomaticAuthentication
Gör att getToken utlöser om en manuell autentisering krävs.
Utvecklare måste anropa för att authenticate()
styra när de ska autentiseras manuellt.
disableAutomaticAuthentication?: boolean
Egenskapsvärde
boolean
Ärvd frånInteractiveCredentialOptions.disableAutomaticAuthentication
disableInstanceDiscovery
Fältet avgör om instansidentifiering utförs vid försök att autentisera.
Om du anger detta inaktiveras true
både instansidentifiering och verifiering av utfärdare helt.
Därför är det viktigt att se till att den konfigurerade utfärdarens värd är giltig och tillförlitlig.
Den här funktionen är avsedd att användas i scenarier där metadataslutpunkten inte kan nås, till exempel i privata moln eller Azure Stack.
Processen för instansidentifiering innebär att auktoritetsmetadata hämtas från https://login.microsoft.com/ för att verifiera utfärdaren.
disableInstanceDiscovery?: boolean
Egenskapsvärde
boolean
Ärvd frånInteractiveCredentialOptions.disableInstanceDiscovery
httpClient
Den HttpClient som ska användas för att skicka HTTP-begäranden.
httpClient?: HttpClient
Egenskapsvärde
loggingOptions
Tillåter användare att konfigurera inställningar för loggningsprincipalternativ, tillåta loggning av kontoinformation och personligt identifierbar information för kundsupport.
loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
Egenskapsvärde
LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
proxyOptions
Alternativ för att konfigurera en proxy för utgående begäranden.
proxyOptions?: ProxySettings
Egenskapsvärde
redirectOptions
Alternativ för hur omdirigeringssvar hanteras.
redirectOptions?: RedirectPolicyOptions
Egenskapsvärde
retryOptions
Alternativ som styr hur du försöker utföra misslyckade begäranden igen.
retryOptions?: PipelineRetryOptions
Egenskapsvärde
telemetryOptions
Alternativ för att ange vanlig telemetri och spårningsinformation för utgående begäranden.
telemetryOptions?: TelemetryOptions
Egenskapsvärde
tlsOptions
Alternativ för att konfigurera TLS-autentisering
tlsOptions?: TlsSettings
Egenskapsvärde
tokenCachePersistenceOptions
Alternativ för att tillhandahålla beständighetsskiktet (om en är tillgänglig) vid lagring av autentiseringsuppgifter.
Du måste först registrera ett plugin-program för beständighetsprovider. Se paketet på @azure/identity-cache-persistence
NPM.
Exempel:
import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);
async function main() {
const credential = new DeviceCodeCredential({
tokenCachePersistenceOptions: {
enabled: true
}
});
}
main().catch((error) => {
console.error("An error occurred:", error);
process.exit(1);
});
tokenCachePersistenceOptions?: TokenCachePersistenceOptions
Egenskapsvärde
Ärvd frånCredentialPersistenceOptions.tokenCachePersistenceOptions
userAgentOptions
Alternativ för att lägga till användaragentinformation i utgående begäranden.
userAgentOptions?: UserAgentPolicyOptions