Freigeben über

ClientCertificateCredentialOptions interface

  • Referenz
Paket:
@azure/identity

Optionale Parameter für die ClientCertificateCredential-Klasse .

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

Eigenschaften

sendCertificateChain

Option zum Einschließen des x5c-Headers für die Autorisierung "SubjectName" und "Ausstellername". Legen Sie diese Option fest, um base64-codiertes öffentliches Zertifikat im Clientassertionsheader als x5c-Anspruch zu senden.

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 Platzhalterwert "*" 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 eingeschlossen werden sollen.
allowInsecureConnection

Legen Sie auf true fest, 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 beim Authentifizierungsversuch instance Ermittlung durchgeführt wird. Wenn Sie dies auf festlegen, true werden sowohl instance Ermittlung als auch die Überprüfung der Autorität vollständig deaktiviert. Daher ist es von entscheidender Bedeutung, 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 aushttps://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, Einstellungen für Protokollierungsrichtlinienoptionen zu konfigurieren, Protokollierungskontoinformationen und personenbezogene Informationen für den Kundensupport zuzulassen.
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 Zum Nachverfolgen von Informationen für ausgehende Anforderungen.
tlsOptions

Optionen zum Konfigurieren der TLS-Authentifizierung
tokenCachePersistenceOptions

Optionen, die beim Speichern von Anmeldeinformationen für die Persistenzschicht (sofern verfügbar) bereitgestellt werden sollen.

Sie müssen zuerst ein Persistenzanbieter-Plug-In registrieren. Sehen Sie sich das @azure/identity-cache-persistence Paket auf NPM an.

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

sendCertificateChain

Option zum Einschließen des x5c-Headers für die Autorisierung "SubjectName" und "Ausstellername". Legen Sie diese Option fest, um base64-codiertes öffentliches Zertifikat im Clientassertionsheader als x5c-Anspruch zu senden.

sendCertificateChain?: boolean

Eigenschaftswert

boolean

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 Platzhalterwert "*" hinzu, damit die Anmeldeinformationen Token für jeden Mandanten abrufen können, für den die Anwendung installiert ist.

additionallyAllowedTenants?: string[]

Eigenschaftswert

string[]

Geerbt vonMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Eigenschaftswert

AdditionalPolicyConfig[]

Geerbt vonMultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

Legen Sie auf true fest, 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 AzureAuthorityHosts verfügbar. Die Standardeinstellung lautet „https://login.microsoftonline.com"“.

authorityHost?: string

Eigenschaftswert

string

Geerbt vonMultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

Das Feld bestimmt, ob beim Authentifizierungsversuch instance Ermittlung durchgeführt wird. Wenn Sie dies auf festlegen, true werden sowohl instance Ermittlung als auch die Überprüfung der Autorität vollständig deaktiviert. Daher ist es von entscheidender Bedeutung, 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 aushttps://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, Einstellungen für Protokollierungsrichtlinienoptionen zu konfigurieren, Protokollierungskontoinformationen und personenbezogene Informationen für den Kundensupport zuzulassen.

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, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.

retryOptions?: PipelineRetryOptions

Eigenschaftswert

PipelineRetryOptions

Geerbt vonMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

Optionen zum Festlegen allgemeiner Telemetriedaten und Zum Nachverfolgen von Informationen 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

tokenCachePersistenceOptions

Optionen, die beim Speichern von Anmeldeinformationen für die Persistenzschicht (sofern verfügbar) bereitgestellt werden sollen.

Sie müssen zuerst ein Persistenzanbieter-Plug-In registrieren. Sehen Sie sich das @azure/identity-cache-persistence Paket auf NPM an.

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