InteractiveBrowserCredentialNodeOptions interface
Definiert die allgemeinen Optionen für die InteractiveBrowserCredential-Klasse.
- Extends
Eigenschaften
client |
Die Client-ID (Anwendung) einer App-Registrierung im Mandanten. |
login |
loginHint ermöglicht es, einen Benutzernamen für interaktive Anmeldungen vorab auszuwählen. 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. Dieser Wert sollte mit dem Wert im Anwendungsregistrierungsportal übereinstimmen. Der Standardwert lautet |
tenant |
Die Microsoft Entra Mandanten -ID (Verzeichnis). |
Geerbte Eigenschaften
additionally |
Gibt für mehrinstanzenfähige Anwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token abrufen können. Fügen Sie den Wildcardwert "*" hinzu, damit die Anmeldeinformationen Token für jeden Mandanten abrufen können, für den die Anwendung installiert ist. |
additional |
Zusätzliche Richtlinien, die in die HTTP-Pipeline aufgenommen werden sollen. |
allow |
Auf TRUE festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird. |
authentication |
Ergebnis einer vorherigen Authentifizierung, die verwendet werden kann, um die zwischengespeicherten Anmeldeinformationen jedes einzelnen Kontos abzurufen. Dies ist für den Fall erforderlich, dass die Anwendung mit mehr als einem Konto pro Client-ID und Mandanten-ID-Paar arbeiten möchte. Dieser Datensatz kann wie folgt abgerufen werden, indem die -Methode der Anmeldeinformationen
|
authority |
Der Autoritätshost, der für Authentifizierungsanforderungen verwendet werden soll. Mögliche Werte sind über AzureAuthorityHosts verfügbar. Die Standardeinstellung lautet „https://login.microsoftonline.com"“. |
broker |
Optionen zum Zulassen der Brokerauthentifizierung bei Verwendung von InteractiveBrowserCredential |
browser |
Freigegebene Konfigurationsoptionen für die Browseranpassung |
disable |
Bewirkt, dass getToken ausgelöst wird, wenn eine manuelle Authentifizierung erforderlich ist.
Entwickler müssen aufrufen, |
disable |
Das Feld bestimmt, ob instance Ermittlung ausgeführt wird, wenn versucht wird, sich zu authentifizieren.
Wenn Sie dies auf festlegen |
http |
Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird. |
logging |
Ermöglicht Benutzern das Konfigurieren von Einstellungen für Protokollierungsrichtlinienoptionen, das Zulassen der Protokollierung von Kontoinformationen und personenbezogenen 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, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden. |
telemetry |
Optionen zum Festlegen allgemeiner Telemetriedaten und Ablaufverfolgungsinformationen auf ausgehende Anforderungen. |
tls |
Optionen zum Konfigurieren der TLS-Authentifizierung |
token |
Optionen, die beim Speichern von Anmeldeinformationen für die Persistenzebene (sofern verfügbar) bereitgestellt werden sollen. 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 (Anwendung) einer App-Registrierung im Mandanten.
clientId?: string
Eigenschaftswert
string
loginHint
loginHint ermöglicht es, einen Benutzernamen für interaktive Anmeldungen vorab auszuwählen. 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. Dieser Wert sollte mit dem Wert im Anwendungsregistrierungsportal übereinstimmen. Der Standardwert lautet window.location.href
.
Dieses Feld ist für Node.js nicht mehr erforderlich.
redirectUri?: string | () => string
Eigenschaftswert
string | () => string
tenantId
Die Microsoft Entra Mandanten -ID (Verzeichnis).
tenantId?: string
Eigenschaftswert
string
Geerbte Eigenschaftsdetails
additionallyAllowedTenants
Gibt für mehrinstanzenfähige Anwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token abrufen können. Fügen Sie den Wildcardwert "*" hinzu, damit die Anmeldeinformationen Token für jeden Mandanten abrufen können, für den die Anwendung installiert ist.
additionallyAllowedTenants?: string[]
Eigenschaftswert
string[]
Geerbt vonInteractiveCredentialOptions.additionallyAllowedTenants
additionalPolicies
Zusätzliche Richtlinien, die in die HTTP-Pipeline aufgenommen 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 verwendet werden kann, um die zwischengespeicherten Anmeldeinformationen jedes einzelnen Kontos abzurufen. Dies ist für den Fall erforderlich, dass die Anwendung mit mehr als einem Konto pro Client-ID und Mandanten-ID-Paar arbeiten möchte.
Dieser Datensatz kann wie folgt abgerufen werden, indem die -Methode der Anmeldeinformationen authenticate()
aufgerufen wird:
const authenticationRecord = await credential.authenticate();
authenticationRecord?: AuthenticationRecord
Eigenschaftswert
authorityHost
Der Autoritätshost, der für Authentifizierungsanforderungen verwendet werden soll. Mögliche Werte sind über AzureAuthorityHosts verfügbar. Die Standardeinstellung lautet „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
Freigegebene Konfigurationsoptionen für die Browseranpassung
browserCustomizationOptions?: { errorMessage?: string, successMessage?: string }
Eigenschaftswert
{ errorMessage?: string, successMessage?: string }
Geerbt vonBrowserCustomizationOptions.browserCustomizationOptions
disableAutomaticAuthentication
Bewirkt, dass getToken ausgelöst wird, wenn eine manuelle Authentifizierung erforderlich ist.
Entwickler müssen aufrufen, authenticate()
um zu steuern, wann die manuelle Authentifizierung erfolgt.
disableAutomaticAuthentication?: boolean
Eigenschaftswert
boolean
Geerbt vonInteractiveCredentialOptions.disableAutomaticAuthentication
disableInstanceDiscovery
Das Feld bestimmt, ob instance Ermittlung ausgeführt wird, wenn versucht wird, sich zu authentifizieren.
Wenn Sie dies auf festlegentrue
, werden sowohl instance Ermittlung als auch die Überprüfung der Autorität 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 die Verwendung in Szenarien vorgesehen, in denen der Metadatenendpunkt nicht erreicht werden kann, z. B. in privaten Clouds oder Azure Stack.
Der Prozess der instance Ermittlung 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, das Zulassen der Protokollierung von Kontoinformationen und personenbezogenen 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, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.
retryOptions?: PipelineRetryOptions
Eigenschaftswert
telemetryOptions
Optionen zum Festlegen allgemeiner Telemetriedaten und Ablaufverfolgungsinformationen auf ausgehende Anforderungen.
telemetryOptions?: TelemetryOptions
Eigenschaftswert
tlsOptions
Optionen zum Konfigurieren der TLS-Authentifizierung
tlsOptions?: TlsSettings
Eigenschaftswert
Geerbt vonInteractiveCredentialOptions.tlsOptions
tokenCachePersistenceOptions
Optionen, die beim Speichern von Anmeldeinformationen für die Persistenzebene (sofern verfügbar) bereitgestellt werden sollen.
Sie müssen zuerst ein Persistenzanbieter-Plug-In registrieren. Weitere Informationen finden Sie im @azure/identity-cache-persistence
Paket auf NPM.
Beispiel:
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
Eigenschaftswert
Geerbt vonCredentialPersistenceOptions.tokenCachePersistenceOptions
userAgentOptions
Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen.
userAgentOptions?: UserAgentPolicyOptions