DefaultAzureCredentialClientIdOptions interface

Paket:

@azure/identity

Stellt Optionen zum Konfigurieren der DefaultAzureCredential-Klasse bereit. Diese Variante unterstützt managedIdentityClientId und nicht managedIdentityResourceId, da nur eine von beiden unterstützt wird.

Extends

DefaultAzureCredentialOptions

Eigenschaften

managedIdentityClientId	Übergeben Sie optional eine vom Benutzer zugewiesene Client-ID, die von ManagedIdentityCredential verwendet werden soll. Diese Client-ID kann auch über die Umgebungsvariable an ManagedIdentityCredential übergeben werden: AZURE_CLIENT_ID.
workloadIdentityClientId	Übergeben Sie optional eine vom Benutzer zugewiesene Client-ID, die von WorkloadIdentityCredential verwendet werden soll. Diese Client-ID kann auch über die Umgebungsvariable an WorkloadIdentityCredential übergeben werden: AZURE_CLIENT_ID.

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.
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"“.
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.
processTimeoutInMs	Timeout, das für Tokenanforderungen für Entwickleranmeldeinformationen konfiguriert werden kann, <xref:AzurePowershellCredential>nämlich , AzureDeveloperCliCredential und AzureCliCredential. Das Prozesstimeout für Anmeldeinformationen sollte in Millisekunden angegeben werden.
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.
tenantId	Übergeben Sie optional eine Mandanten-ID, die als Teil der Anmeldeinformationen verwendet werden soll. Standardmäßig kann eine generische Mandanten-ID verwendet werden, abhängig von den zugrunde liegenden Anmeldeinformationen.
tlsOptions	Optionen zum Konfigurieren der TLS-Authentifizierung
userAgentOptions	Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen.

Details zur Eigenschaft

managedIdentityClientId

Übergeben Sie optional eine vom Benutzer zugewiesene Client-ID, die von ManagedIdentityCredential verwendet werden soll. Diese Client-ID kann auch über die Umgebungsvariable an ManagedIdentityCredential übergeben werden: AZURE_CLIENT_ID.

managedIdentityClientId?: string

Eigenschaftswert

string

workloadIdentityClientId

Übergeben Sie optional eine vom Benutzer zugewiesene Client-ID, die von WorkloadIdentityCredential verwendet werden soll. Diese Client-ID kann auch über die Umgebungsvariable an WorkloadIdentityCredential übergeben werden: AZURE_CLIENT_ID.

workloadIdentityClientId?: 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 vonDefaultAzureCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Eigenschaftswert

AdditionalPolicyConfig[]

Geerbt vonDefaultAzureCredentialOptions.additionalPolicies

allowInsecureConnection

Auf TRUE festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird.

allowInsecureConnection?: boolean

Eigenschaftswert

boolean

Geerbt vonDefaultAzureCredentialOptions.allowInsecureConnection

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

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

httpClient

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

httpClient?: HttpClient

Eigenschaftswert

HttpClient

Geerbt vonDefaultAzureCredentialOptions.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 vonDefaultAzureCredentialOptions.loggingOptions

processTimeoutInMs

Timeout, das für Tokenanforderungen für Entwickleranmeldeinformationen konfiguriert werden kann, <xref:AzurePowershellCredential>nämlich , AzureDeveloperCliCredential und AzureCliCredential. Das Prozesstimeout für Anmeldeinformationen sollte in Millisekunden angegeben werden.

processTimeoutInMs?: number

Eigenschaftswert

number

Geerbt vonDefaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen.

proxyOptions?: ProxySettings

Eigenschaftswert

ProxySettings

Geerbt vonDefaultAzureCredentialOptions.proxyOptions

redirectOptions

Optionen für die Behandlung von Umleitungsantworten.

redirectOptions?: RedirectPolicyOptions

Eigenschaftswert

RedirectPolicyOptions

Geerbt vonDefaultAzureCredentialOptions.redirectOptions

retryOptions

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

retryOptions?: PipelineRetryOptions

Eigenschaftswert

PipelineRetryOptions

Geerbt vonDefaultAzureCredentialOptions.retryOptions

telemetryOptions

Optionen zum Festlegen allgemeiner Telemetriedaten und Ablaufverfolgungsinformationen auf ausgehende Anforderungen.

telemetryOptions?: TelemetryOptions

Eigenschaftswert

TelemetryOptions

Geerbt vonDefaultAzureCredentialOptions.telemetryOptions

tenantId

Übergeben Sie optional eine Mandanten-ID, die als Teil der Anmeldeinformationen verwendet werden soll. Standardmäßig kann eine generische Mandanten-ID verwendet werden, abhängig von den zugrunde liegenden Anmeldeinformationen.

tenantId?: string

Eigenschaftswert

string

Geerbt vonDefaultAzureCredentialOptions.tenantId

tlsOptions

Optionen zum Konfigurieren der TLS-Authentifizierung

tlsOptions?: TlsSettings

Eigenschaftswert

TlsSettings

Geerbt vonDefaultAzureCredentialOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Eigenschaftswert

UserAgentPolicyOptions

Geerbt vonDefaultAzureCredentialOptions.userAgentOptions