DeviceCodeCredentialOptions interface

Paket:

@azure/identity

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

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

Eigenschaften

clientId	Die Client-ID (Anwendung) einer App-Registrierung im Mandanten.
tenantId	Die Microsoft Entra Mandanten -ID (Verzeichnis).
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 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.
additionalPolicies	Zusätzliche Richtlinien, die in die HTTP-Pipeline aufgenommen werden sollen.
allowInsecureConnection	Auf TRUE festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird.
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();
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"“.
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.
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.
httpClient	Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird.
loggingOptions	Ermöglicht Benutzern das Konfigurieren von Einstellungen für Protokollierungsrichtlinienoptionen, das Zulassen der Protokollierung von Kontoinformationen und personenbezogenen 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, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.
telemetryOptions	Optionen zum Festlegen allgemeiner Telemetriedaten und Ablaufverfolgungsinformationen auf ausgehende Anforderungen.
tlsOptions	Optionen zum Konfigurieren der TLS-Authentifizierung
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); });
userAgentOptions	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

tenantId

Die Microsoft Entra Mandanten -ID (Verzeichnis).

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

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

AuthenticationRecord

Geerbt vonInteractiveCredentialOptions.authenticationRecord

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

Geerbt vonInteractiveCredentialOptions.authorityHost

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

HttpClient

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 }

Geerbt vonInteractiveCredentialOptions.loggingOptions

proxyOptions

Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen.

proxyOptions?: ProxySettings

Eigenschaftswert

ProxySettings

Geerbt vonInteractiveCredentialOptions.proxyOptions

redirectOptions

Optionen für die Behandlung von Umleitungsantworten.

redirectOptions?: RedirectPolicyOptions

Eigenschaftswert

RedirectPolicyOptions

Geerbt vonInteractiveCredentialOptions.redirectOptions

retryOptions

Optionen, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.

retryOptions?: PipelineRetryOptions

Eigenschaftswert

PipelineRetryOptions

Geerbt vonInteractiveCredentialOptions.retryOptions

telemetryOptions

Optionen zum Festlegen allgemeiner Telemetriedaten und Ablaufverfolgungsinformationen auf ausgehende Anforderungen.

telemetryOptions?: TelemetryOptions

Eigenschaftswert

TelemetryOptions

Geerbt vonInteractiveCredentialOptions.telemetryOptions

tlsOptions

Optionen zum Konfigurieren der TLS-Authentifizierung

tlsOptions?: TlsSettings

Eigenschaftswert

TlsSettings

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

TokenCachePersistenceOptions

Geerbt vonCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Eigenschaftswert

UserAgentPolicyOptions

Geerbt vonInteractiveCredentialOptions.userAgentOptions