DefaultAzureCredentialOptions interface

Paket:

@azure/identity

Bietet Optionen zum Konfigurieren der DefaultAzureCredential Klasse.

Extends

MultiTenantTokenCredentialOptions,AuthorityValidationOptions

Eigenschaften

processTimeoutInMs	Timeout konfigurierbar zum Erstellen von Tokenanforderungen für Entwickleranmeldeinformationen, nämlich <xref:AzurePowershellCredential>, AzureDeveloperCliCredential und AzureCliCredential. Prozesstimeout für Anmeldeinformationen sollte in Millisekunden angegeben werden.
requiredEnvVars	Liste der Umgebungsvariablen, die zur Laufzeit definiert werden müssen. Wenn eine Variable in dieser Liste fehlt oder auf einen leeren Wert festgelegt ist, löst der DefaultAzureCredential-Konstruktor einen Fehler aus. Verwenden Sie diese Option, um zu erzwingen, dass Ihre Anwendung über die erforderliche Umgebungskonfiguration verfügt, bevor Sie mit der Ausführung fortfahren.
tenantId	Übergeben Sie optional eine Mandanten-ID, die als Teil der Anmeldeinformationen verwendet werden soll. Standardmäßig kann sie je nach zugrunde liegenden Anmeldeinformationen eine generische Mandanten-ID verwenden.

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.
agent	Optionen zum Konfigurieren der Agent-Instanz für ausgehende Anforderungen
allowInsecureConnection	Auf "true" festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird
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".
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
userAgentOptions	Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen.

Details zur Eigenschaft

processTimeoutInMs

Timeout konfigurierbar zum Erstellen von Tokenanforderungen für Entwickleranmeldeinformationen, nämlich <xref:AzurePowershellCredential>, AzureDeveloperCliCredential und AzureCliCredential. Prozesstimeout für Anmeldeinformationen sollte in Millisekunden angegeben werden.

processTimeoutInMs?: number

Eigenschaftswert

number

requiredEnvVars

Liste der Umgebungsvariablen, die zur Laufzeit definiert werden müssen. Wenn eine Variable in dieser Liste fehlt oder auf einen leeren Wert festgelegt ist, löst der DefaultAzureCredential-Konstruktor einen Fehler aus. Verwenden Sie diese Option, um zu erzwingen, dass Ihre Anwendung über die erforderliche Umgebungskonfiguration verfügt, bevor Sie mit der Ausführung fortfahren.

requiredEnvVars?: DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

Eigenschaftswert

DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

tenantId

Übergeben Sie optional eine Mandanten-ID, die als Teil der Anmeldeinformationen verwendet werden soll. Standardmäßig kann sie je nach zugrunde liegenden Anmeldeinformationen eine generische Mandanten-ID verwenden.

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

vonMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Eigenschaftswert

AdditionalPolicyConfig[]

geerbt vonMultiTenantTokenCredentialOptions.additionalPolicies

agent

Optionen zum Konfigurieren der Agent-Instanz für ausgehende Anforderungen

agent?: Agent

Eigenschaftswert

Agent

vonMultiTenantTokenCredentialOptions.agent

allowInsecureConnection

Auf "true" festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird

allowInsecureConnection?: boolean

Eigenschaftswert

boolean

geerbt vonMultiTenantTokenCredentialOptions.allowInsecureConnection

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 vonMultiTenantTokenCredentialOptions.authorityHost-

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 vonAuthorityValidationOptions.disableInstanceDiscovery-

httpClient

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

httpClient?: HttpClient

Eigenschaftswert

HttpClient

geerbt vonMultiTenantTokenCredentialOptions.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 vonMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen.

proxyOptions?: ProxySettings

Eigenschaftswert

ProxySettings

geerbt vonMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Optionen für die Behandlung von Umleitungsantworten.

redirectOptions?: RedirectPolicyOptions

Eigenschaftswert

RedirectPolicyOptions

geerbt vonMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden.

retryOptions?: PipelineRetryOptions

Eigenschaftswert

PipelineRetryOptions

geerbt vonMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Eigenschaftswert

TelemetryOptions

geerbt vonMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Optionen zum Konfigurieren der TLS-Authentifizierung

tlsOptions?: TlsSettings

Eigenschaftswert

TlsSettings

geerbt vonMultiTenantTokenCredentialOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Eigenschaftswert

UserAgentPolicyOptions

vonMultiTenantTokenCredentialOptions.userAgentOptions