Share via

ClientCertificateCredentialOptions interface

  • Odwołanie
Pakiet:
@azure/identity

Parametry opcjonalne dla klasy ClientCertificateCredential .

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

Właściwości

sendCertificateChain

Opcja uwzględnienia nagłówka x5c dla autoryzacji SubjectName i nazwy wystawcy. Ustaw tę opcję, aby wysyłać certyfikat publiczny zakodowany w formacie base64 w nagłówku potwierdzenia klienta jako oświadczenie x5c

Właściwości dziedziczone

additionallyAllowedTenants

W przypadku aplikacji z wieloma dzierżawami określa dodatkowe dzierżawy, dla których poświadczenia mogą uzyskiwać tokeny. Dodaj wartość symbolu wieloznakowego "*", aby umożliwić poświadczeniu uzyskiwanie tokenów dla dowolnej dzierżawy zainstalowanej aplikacji.
additionalPolicies

Dodatkowe zasady do uwzględnienia w potoku HTTP.
allowInsecureConnection

Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS
authorityHost

Host urzędu do użycia na potrzeby żądań uwierzytelniania. Możliwe wartości są dostępne za pośrednictwem elementu AzureAuthorityHosts. Wartość domyślna to "https://login.microsoftonline.com".
disableInstanceDiscovery

Pole określa, czy odnajdywanie wystąpień jest wykonywane podczas próby uwierzytelnienia. Ustawienie tego ustawienia true spowoduje całkowite wyłączenie zarówno odnajdywania wystąpień, jak i weryfikacji urzędu. W związku z tym niezwykle ważne jest upewnienie się, że skonfigurowany host urzędu jest prawidłowy i godny zaufania. Ta funkcja jest przeznaczona do użycia w scenariuszach, w których nie można uzyskać dostępu do punktu końcowego metadanych, na przykład w chmurach prywatnych lub usłudze Azure Stack. Proces odnajdywania wystąpień wiąże się z pobieraniem metadanych urzędu z https://login.microsoft.com/ programu w celu zweryfikowania urzędu.
httpClient

Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.
loggingOptions

Umożliwia użytkownikom konfigurowanie ustawień opcji zasad rejestrowania, zezwalanie na rejestrowanie informacji o koncie i danych osobowych na potrzeby obsługi klienta.
proxyOptions

Opcje konfigurowania serwera proxy dla żądań wychodzących.
redirectOptions

Opcje obsługi odpowiedzi przekierowania.
retryOptions

Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
telemetryOptions

Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.
tlsOptions

Opcje konfigurowania uwierzytelniania TLS
tokenCachePersistenceOptions

Opcje udostępniania warstwy trwałości (jeśli jest dostępna) podczas przechowywania poświadczeń.

Musisz najpierw zarejestrować wtyczkę dostawcy trwałości. @azure/identity-cache-persistence Zobacz pakiet na serwerze NPM.

Przykład:

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

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

Szczegóły właściwości

sendCertificateChain

Opcja uwzględnienia nagłówka x5c dla autoryzacji SubjectName i nazwy wystawcy. Ustaw tę opcję, aby wysyłać certyfikat publiczny zakodowany w formacie base64 w nagłówku potwierdzenia klienta jako oświadczenie x5c

sendCertificateChain?: boolean

Wartość właściwości

boolean

Szczegóły właściwości dziedziczonej

additionallyAllowedTenants

W przypadku aplikacji z wieloma dzierżawami określa dodatkowe dzierżawy, dla których poświadczenia mogą uzyskiwać tokeny. Dodaj wartość symbolu wieloznakowego "*", aby umożliwić poświadczeniu uzyskiwanie tokenów dla dowolnej dzierżawy zainstalowanej aplikacji.

additionallyAllowedTenants?: string[]

Wartość właściwości

string[]

Dziedziczone zmultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

Dodatkowe zasady do uwzględnienia w potoku HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Wartość właściwości

AdditionalPolicyConfig[]

Dziedziczone zMultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS

allowInsecureConnection?: boolean

Wartość właściwości

boolean

Dziedziczone zmultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

Host urzędu do użycia na potrzeby żądań uwierzytelniania. Możliwe wartości są dostępne za pośrednictwem elementu AzureAuthorityHosts. Wartość domyślna to "https://login.microsoftonline.com".

authorityHost?: string

Wartość właściwości

string

Dziedziczone zMultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

Pole określa, czy odnajdywanie wystąpień jest wykonywane podczas próby uwierzytelnienia. Ustawienie tego ustawienia true spowoduje całkowite wyłączenie zarówno odnajdywania wystąpień, jak i weryfikacji urzędu. W związku z tym niezwykle ważne jest upewnienie się, że skonfigurowany host urzędu jest prawidłowy i godny zaufania. Ta funkcja jest przeznaczona do użycia w scenariuszach, w których nie można uzyskać dostępu do punktu końcowego metadanych, na przykład w chmurach prywatnych lub usłudze Azure Stack. Proces odnajdywania wystąpień wiąże się z pobieraniem metadanych urzędu z https://login.microsoft.com/ programu w celu zweryfikowania urzędu.

disableInstanceDiscovery?: boolean

Wartość właściwości

boolean

Dziedziczone zauthorityValidationOptions.disableInstanceDiscovery

httpClient

Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.

httpClient?: HttpClient

Wartość właściwości

HttpClient

Dziedziczone zobiektu MultiTenantTokenCredentialOptions.httpClient

loggingOptions

Umożliwia użytkownikom konfigurowanie ustawień opcji zasad rejestrowania, zezwalanie na rejestrowanie informacji o koncie i danych osobowych na potrzeby obsługi klienta.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Wartość właściwości

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Dziedziczone zmultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

Opcje konfigurowania serwera proxy dla żądań wychodzących.

proxyOptions?: ProxySettings

Wartość właściwości

ProxySettings

Dziedziczone zMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Opcje obsługi odpowiedzi przekierowania.

redirectOptions?: RedirectPolicyOptions

Wartość właściwości

RedirectPolicyOptions

Dziedziczone zMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.

retryOptions?: PipelineRetryOptions

Wartość właściwości

PipelineRetryOptions

Dziedziczone zmultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.

telemetryOptions?: TelemetryOptions

Wartość właściwości

TelemetryOptions

Dziedziczone zMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Opcje konfigurowania uwierzytelniania TLS

tlsOptions?: TlsSettings

Wartość właściwości

TlsSettings

Dziedziczone zmultiTenantTokenCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Opcje udostępniania warstwy trwałości (jeśli jest dostępna) podczas przechowywania poświadczeń.

Musisz najpierw zarejestrować wtyczkę dostawcy trwałości. @azure/identity-cache-persistence Zobacz pakiet na serwerze NPM.

Przykład:

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

Wartość właściwości

TokenCachePersistenceOptions

Dziedziczone zcredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

userAgentOptions?: UserAgentPolicyOptions

Wartość właściwości

UserAgentPolicyOptions

Dziedziczone zmultiTenantTokenCredentialOptions.userAgentOptions