Freigeben über

DeviceCodeCredentialOptions interface

  • Referenz
Paket:
@azure/identity

Definiert Optionen für die InteractiveBrowserCredential-Klasse für Node.js.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

Eigenschaften

clientId

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.
tenantId

Die Microsoft Entra-Mandanten-ID (Verzeichnis-ID).
userPromptCallback

Eine Rückruffunktion, die aufgerufen wird, um dem Benutzer DeviceCodeInfo anzuzeigen. Wenn sie nicht zugewiesen bleiben, protokollieren wir automatisch die Gerätecodeinformationen und die Authentifizierungsanweisungen in der Konsole.

Geerbte Eigenschaften

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.
additionalPolicies

Zusätzliche Richtlinien, die in die HTTP-Pipeline eingeschlossen werden sollen.
allowInsecureConnection

Auf "true" festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird
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();
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".
disableAutomaticAuthentication

Macht getToken ausgelöst, wenn eine manuelle Authentifizierung erforderlich ist. Entwickler müssen authenticate() aufrufen, um zu steuern, wann die manuelle Authentifizierung erfolgt.
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.
httpClient

Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird.
loggingOptions

Ermöglicht Benutzern das Konfigurieren von Einstellungen für Protokollierungsrichtlinienoptionen, die Protokollierung von Kontoinformationen und personenbezogene Informationen für den Kundensupport.
proxyOptions

Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen.
redirectOptions

Optionen für die Behandlung von Umleitungsantworten.
retryOptions

Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden.
telemetryOptions

Optionen zum Festlegen allgemeiner Telemetrie- und Ablaufverfolgungsinformationen für ausgehende Anforderungen.
tlsOptions

Optionen zum Konfigurieren der TLS-Authentifizierung
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,
  },
});
userAgentOptions

Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen.

Details zur Eigenschaft

clientId

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

tenantId

Die Microsoft Entra-Mandanten-ID (Verzeichnis-ID).

tenantId?: string

Eigenschaftswert

string

userPromptCallback

Eine Rückruffunktion, die aufgerufen wird, um dem Benutzer DeviceCodeInfo anzuzeigen. Wenn sie nicht zugewiesen bleiben, protokollieren wir automatisch die Gerätecodeinformationen und die Authentifizierungsanweisungen in der Konsole.

userPromptCallback?: DeviceCodePromptCallback

Eigenschaftswert

DeviceCodePromptCallback

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

AdditionalPolicyConfig[]

geerbt vonInteractiveCredentialOptions.additionalPolicies

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

AuthenticationRecord

vonInteractiveCredentialOptions.authenticationRecord

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

geerbt vonInteractiveCredentialOptions.authorityHost-

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

HttpClient

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 }

geerbt vonInteractiveCredentialOptions.loggingOptions

proxyOptions

Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen.

proxyOptions?: ProxySettings

Eigenschaftswert

ProxySettings

vonInteractiveCredentialOptions.proxyOptions

redirectOptions

Optionen für die Behandlung von Umleitungsantworten.

redirectOptions?: RedirectPolicyOptions

Eigenschaftswert

RedirectPolicyOptions

Geerbt vonInteractiveCredentialOptions.redirectOptions

retryOptions

Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden.

retryOptions?: PipelineRetryOptions

Eigenschaftswert

PipelineRetryOptions

vonInteractiveCredentialOptions.retryOptions

telemetryOptions

Optionen zum Festlegen allgemeiner Telemetrie- und Ablaufverfolgungsinformationen für ausgehende Anforderungen.

telemetryOptions?: TelemetryOptions

Eigenschaftswert

TelemetryOptions

Geerbt vonInteractiveCredentialOptions.telemetryOptions

tlsOptions

Optionen zum Konfigurieren der TLS-Authentifizierung

tlsOptions?: TlsSettings

Eigenschaftswert

TlsSettings

vonInteractiveCredentialOptions.tlsOptions

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

TokenCachePersistenceOptions

geerbt vonCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen.

userAgentOptions?: UserAgentPolicyOptions

Eigenschaftswert

UserAgentPolicyOptions

vonInteractiveCredentialOptions.userAgentOptions