InteractiveBrowserCredentialNodeOptions interface
Definiert die allgemeinen Optionen für die InteractiveBrowserCredential-Klasse.
- Extends
Eigenschaften
client |
Die Client-ID der Microsoft Entra-Anwendung, bei der sich Benutzer anmelden. Es wird empfohlen, dass Entwickler ihre Anwendungen registrieren und entsprechende Rollen zuweisen. Weitere Informationen finden Sie unter https://aka.ms/identity/AppRegistrationAndRoleAssignment. Wenn nicht angegeben, authentifizieren sich Benutzer bei einer Azure-Entwicklungsanwendung, die für Produktionsszenarien nicht empfohlen wird. |
login |
loginHint ermöglicht es einem Benutzernamen, für interaktive Anmeldungen vorab ausgewählt zu werden. Wenn Sie diese Option festlegen, wird die Kontoauswahlaufforderung übersprungen und sofort versucht, sich mit dem angegebenen Konto anzumelden. |
redirect |
Ruft den Umleitungs-URI der Anwendung ab. Dies sollte mit dem Wert im Anwendungsregistrierungsportal übereinstimmen. Standardmäßig wird |
tenant |
Die Microsoft Entra-Mandanten-ID (Verzeichnis-ID). |
Geerbte Eigenschaften
additionally |
Gibt für Anwendungen mit mehreren Mandanten zusätzliche Mandanten an, für die die Anmeldeinformationen Token erwerben können. Fügen Sie den Wildcardwert "*" hinzu, damit die Anmeldeinformationen Token für jeden Mandanten abrufen können, den die Anwendung installiert hat. |
additional |
Zusätzliche Richtlinien, die in die HTTP-Pipeline eingeschlossen werden sollen. |
allow |
Auf "true" festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird |
authentication |
Ergebnis einer vorherigen Authentifizierung, die zum Abrufen der zwischengespeicherten Anmeldeinformationen jedes einzelnen Kontos verwendet werden kann. Dies ist erforderlich, um anzugeben, falls die Anwendung mit mehr als einem Konto pro Client-ID und Mandanten-ID-Paar arbeiten möchte. Dieser Datensatz kann abgerufen werden, indem er die
|
authority |
Der Autoritätshost, der für Authentifizierungsanforderungen verwendet werden soll. Mögliche Werte sind über AzureAuthorityHostsverfügbar. Der Standardwert ist "https://login.microsoftonline.com". |
broker |
Optionen zum Zulassen der Brokerauthentifizierung bei Verwendung von InteractiveBrowserCredential |
browser |
Optionen für die gemeinsame Konfiguration für die Browseranpassung |
disable |
Macht getToken ausgelöst, wenn eine manuelle Authentifizierung erforderlich ist.
Entwickler müssen |
disable |
Das Feld bestimmt, ob die Instanzermittlung beim Versuch, sich zu authentifizieren, ausgeführt wird.
Wenn Sie dies auf |
http |
Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird. |
logging |
Ermöglicht Benutzern das Konfigurieren von Einstellungen für Protokollierungsrichtlinienoptionen, die Protokollierung von Kontoinformationen und personenbezogene Informationen für den Kundensupport. |
proxy |
Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen. |
redirect |
Optionen für die Behandlung von Umleitungsantworten. |
retry |
Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden. |
telemetry |
Optionen zum Festlegen allgemeiner Telemetrie- und Ablaufverfolgungsinformationen für ausgehende Anforderungen. |
tls |
Optionen zum Konfigurieren der TLS-Authentifizierung |
token |
Optionen zum Bereitstellen der Persistenzebene (sofern verfügbar) beim Speichern von Anmeldeinformationen. Sie müssen zuerst ein Persistenzanbieter-Plug-In registrieren. Weitere Informationen finden Sie im Beispiel:
|
user |
Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen. |
Details zur Eigenschaft
clientId
Die Client-ID der Microsoft Entra-Anwendung, bei der sich Benutzer anmelden. Es wird empfohlen, dass Entwickler ihre Anwendungen registrieren und entsprechende Rollen zuweisen. Weitere Informationen finden Sie unter https://aka.ms/identity/AppRegistrationAndRoleAssignment. Wenn nicht angegeben, authentifizieren sich Benutzer bei einer Azure-Entwicklungsanwendung, die für Produktionsszenarien nicht empfohlen wird.
clientId?: string
Eigenschaftswert
string
loginHint
loginHint ermöglicht es einem Benutzernamen, für interaktive Anmeldungen vorab ausgewählt zu werden. Wenn Sie diese Option festlegen, wird die Kontoauswahlaufforderung übersprungen und sofort versucht, sich mit dem angegebenen Konto anzumelden.
loginHint?: string
Eigenschaftswert
string
redirectUri
Ruft den Umleitungs-URI der Anwendung ab. Dies sollte mit dem Wert im Anwendungsregistrierungsportal übereinstimmen. Standardmäßig wird window.location.href
.
Dieses Feld ist für Node.jsnicht mehr erforderlich.
redirectUri?: string | () => string
Eigenschaftswert
string | () => string
tenantId
Die Microsoft Entra-Mandanten-ID (Verzeichnis-ID).
tenantId?: string
Eigenschaftswert
string
Geerbte Eigenschaftsdetails
additionallyAllowedTenants
Gibt für Anwendungen mit mehreren Mandanten zusätzliche Mandanten an, für die die Anmeldeinformationen Token erwerben können. Fügen Sie den Wildcardwert "*" hinzu, damit die Anmeldeinformationen Token für jeden Mandanten abrufen können, den die Anwendung installiert hat.
additionallyAllowedTenants?: string[]
Eigenschaftswert
string[]
Geerbt vonInteractiveCredentialOptions.additionallyAllowedTenants
additionalPolicies
Zusätzliche Richtlinien, die in die HTTP-Pipeline eingeschlossen werden sollen.
additionalPolicies?: AdditionalPolicyConfig[]
Eigenschaftswert
allowInsecureConnection
Auf "true" festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird
allowInsecureConnection?: boolean
Eigenschaftswert
boolean
geerbt vonInteractiveCredentialOptions.allowInsecureConnection
authenticationRecord
Ergebnis einer vorherigen Authentifizierung, die zum Abrufen der zwischengespeicherten Anmeldeinformationen jedes einzelnen Kontos verwendet werden kann. Dies ist erforderlich, um anzugeben, falls die Anwendung mit mehr als einem Konto pro Client-ID und Mandanten-ID-Paar arbeiten möchte.
Dieser Datensatz kann abgerufen werden, indem er die authenticate()
Methode der Anmeldeinformationen wie folgt aufruft:
const authenticationRecord = await credential.authenticate();
authenticationRecord?: AuthenticationRecord
Eigenschaftswert
authorityHost
Der Autoritätshost, der für Authentifizierungsanforderungen verwendet werden soll. Mögliche Werte sind über AzureAuthorityHostsverfügbar. Der Standardwert ist "https://login.microsoftonline.com".
authorityHost?: string
Eigenschaftswert
string
brokerOptions
Optionen zum Zulassen der Brokerauthentifizierung bei Verwendung von InteractiveBrowserCredential
brokerOptions?: BrokerOptions
Eigenschaftswert
geerbt vonBrokerAuthOptions.brokerOptions
browserCustomizationOptions
Optionen für die gemeinsame Konfiguration für die Browseranpassung
browserCustomizationOptions?: { errorMessage?: string, successMessage?: string }
Eigenschaftswert
{ errorMessage?: string, successMessage?: string }
geerbt vonBrowserCustomizationOptions.browserCustomizationOptions
disableAutomaticAuthentication
Macht getToken ausgelöst, wenn eine manuelle Authentifizierung erforderlich ist.
Entwickler müssen authenticate()
aufrufen, um zu steuern, wann die manuelle Authentifizierung erfolgt.
disableAutomaticAuthentication?: boolean
Eigenschaftswert
boolean
geerbt vonInteractiveCredentialOptions.disableAutomaticAuthentication
disableInstanceDiscovery
Das Feld bestimmt, ob die Instanzermittlung beim Versuch, sich zu authentifizieren, ausgeführt wird.
Wenn Sie dies auf true
festlegen, werden sowohl die Instanzermittlung als auch die Autoritätsüberprüfung vollständig deaktiviert.
Daher ist es wichtig, sicherzustellen, dass der konfigurierte Autoritätshost gültig und vertrauenswürdig ist.
Diese Funktionalität ist für Szenarien vorgesehen, in denen der Metadatenendpunkt nicht erreicht werden kann, z. B. in privaten Clouds oder Azure Stack.
Der Prozess der Instanzermittlung umfasst das Abrufen von Autoritätsmetadaten aus https://login.microsoft.com/, um die Autorität zu überprüfen.
disableInstanceDiscovery?: boolean
Eigenschaftswert
boolean
Geerbt vonInteractiveCredentialOptions.disableInstanceDiscovery-
httpClient
Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird.
httpClient?: HttpClient
Eigenschaftswert
geerbt vonInteractiveCredentialOptions.httpClient-
loggingOptions
Ermöglicht Benutzern das Konfigurieren von Einstellungen für Protokollierungsrichtlinienoptionen, die Protokollierung von Kontoinformationen und personenbezogene Informationen für den Kundensupport.
loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
Eigenschaftswert
LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
proxyOptions
Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen.
proxyOptions?: ProxySettings
Eigenschaftswert
redirectOptions
Optionen für die Behandlung von Umleitungsantworten.
redirectOptions?: RedirectPolicyOptions
Eigenschaftswert
retryOptions
Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden.
retryOptions?: PipelineRetryOptions
Eigenschaftswert
telemetryOptions
Optionen zum Festlegen allgemeiner Telemetrie- und Ablaufverfolgungsinformationen für ausgehende Anforderungen.
telemetryOptions?: TelemetryOptions
Eigenschaftswert
tlsOptions
Optionen zum Konfigurieren der TLS-Authentifizierung
tlsOptions?: TlsSettings
Eigenschaftswert
tokenCachePersistenceOptions
Optionen zum Bereitstellen der Persistenzebene (sofern verfügbar) beim Speichern von Anmeldeinformationen.
Sie müssen zuerst ein Persistenzanbieter-Plug-In registrieren. Weitere Informationen finden Sie im @azure/identity-cache-persistence
-Paket auf NPM.
Beispiel:
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);
const credential = new DeviceCodeCredential({
tokenCachePersistenceOptions: {
enabled: true,
},
});
tokenCachePersistenceOptions?: TokenCachePersistenceOptions
Eigenschaftswert
geerbt vonCredentialPersistenceOptions.tokenCachePersistenceOptions
userAgentOptions
Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen.
userAgentOptions?: UserAgentPolicyOptions