Sdílet prostřednictvím

ClientCertificateCredentialOptions interface

  • Reference
Balíček:
@azure/identity

Volitelné parametry pro Třídu ClientCertificateCredential .

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

Vlastnosti

sendCertificateChain

Možnost zahrnout hlavičku x5c pro autorizaci názvu subjektu a názvu vystavitele. Tuto možnost nastavte tak, aby se v hlavičce kontrolního výrazu klienta odeslal veřejný certifikát kódovaný jako base64 jako deklarace identity x5c.

Zděděné vlastnosti

additionallyAllowedTenants

U aplikací s více tenanty určuje další tenanty, pro které přihlašovací údaje můžou získat tokeny. Přidejte hodnotu se zástupným znakem "*", aby přihlašovací údaje mohly získávat tokeny pro všechny tenanty, ve které je aplikace nainstalovaná.
additionalPolicies

Další zásady, které se mají zahrnout do kanálu HTTP.
allowInsecureConnection

Pokud se požadavek odesílá přes HTTP místo HTTPS, nastavte hodnotu true.
authorityHost

Hostitel autority, který se má použít pro žádosti o ověření. Možné hodnoty jsou k dispozici prostřednictvím AzureAuthorityHosts. Výchozí hodnota je "https://login.microsoftonline.com".
disableInstanceDiscovery

Pole určuje, jestli se při pokusu o ověření provede zjišťování instancí. Nastavením této možnosti na true úplně zakážete zjišťování instancí i ověřování autorit. Proto je důležité zajistit, aby nakonfigurovaný hostitel autority byl platný a důvěryhodný. Tato funkce je určená pro použití ve scénářích, kdy není dostupný koncový bod metadat, například v privátních cloudech nebo ve službě Azure Stack. Proces zjišťování instance zahrnuje načtení metadat autority z, https://login.microsoft.com/ aby se autorita ověřila.
httpClient

HttpClient, který se použije k odesílání požadavků HTTP.
loggingOptions

Umožňuje uživatelům konfigurovat nastavení pro možnosti zásad protokolování, povolit protokolování informací o účtu a identifikovatelné osobní údaje pro zákaznickou podporu.
proxyOptions

Možnosti konfigurace proxy serveru pro odchozí požadavky
redirectOptions

Možnosti zpracování odpovědí přesměrování
retryOptions

Možnosti, které určují, jak opakovat neúspěšné žádosti.
telemetryOptions

Možnosti nastavení běžné telemetrie a trasování informací pro odchozí požadavky
tlsOptions

Možnosti konfigurace ověřování TLS
tokenCachePersistenceOptions

Možnosti, které se mají poskytnout vrstvě trvalosti (pokud je k dispozici) při ukládání přihlašovacích údajů

Nejprve musíte zaregistrovat modul plug-in poskytovatele trvalosti. Viz balíček na @azure/identity-cache-persistence NPM.

Příklad:

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

Možnosti pro přidání podrobností o uživatelském agentu k odchozím požadavkům

Podrobnosti vlastnosti

sendCertificateChain

Možnost zahrnout hlavičku x5c pro autorizaci názvu subjektu a názvu vystavitele. Tuto možnost nastavte tak, aby se v hlavičce kontrolního výrazu klienta odeslal veřejný certifikát kódovaný jako base64 jako deklarace identity x5c.

sendCertificateChain?: boolean

Hodnota vlastnosti

boolean

Podrobnosti zděděných vlastností

additionallyAllowedTenants

U aplikací s více tenanty určuje další tenanty, pro které přihlašovací údaje můžou získat tokeny. Přidejte hodnotu se zástupným znakem "*", aby přihlašovací údaje mohly získávat tokeny pro všechny tenanty, ve které je aplikace nainstalovaná.

additionallyAllowedTenants?: string[]

Hodnota vlastnosti

string[]

Zděděno zMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

Další zásady, které se mají zahrnout do kanálu HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Hodnota vlastnosti

AdditionalPolicyConfig[]

Zděděno zMultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

Pokud se požadavek odesílá přes HTTP místo HTTPS, nastavte hodnotu true.

allowInsecureConnection?: boolean

Hodnota vlastnosti

boolean

Zděděno zMultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

Hostitel autority, který se má použít pro žádosti o ověření. Možné hodnoty jsou k dispozici prostřednictvím AzureAuthorityHosts. Výchozí hodnota je "https://login.microsoftonline.com".

authorityHost?: string

Hodnota vlastnosti

string

Zděděno zMultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

Pole určuje, jestli se při pokusu o ověření provede zjišťování instancí. Nastavením této možnosti na true úplně zakážete zjišťování instancí i ověřování autorit. Proto je důležité zajistit, aby nakonfigurovaný hostitel autority byl platný a důvěryhodný. Tato funkce je určená pro použití ve scénářích, kdy není dostupný koncový bod metadat, například v privátních cloudech nebo ve službě Azure Stack. Proces zjišťování instance zahrnuje načtení metadat autority z, https://login.microsoft.com/ aby se autorita ověřila.

disableInstanceDiscovery?: boolean

Hodnota vlastnosti

boolean

Zděděno zAuthorityValidationOptions.disableInstanceDiscovery

httpClient

HttpClient, který se použije k odesílání požadavků HTTP.

httpClient?: HttpClient

Hodnota vlastnosti

HttpClient

Zděděno zMultiTenantTokenCredentialOptions.httpClient

loggingOptions

Umožňuje uživatelům konfigurovat nastavení pro možnosti zásad protokolování, povolit protokolování informací o účtu a identifikovatelné osobní údaje pro zákaznickou podporu.

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

Hodnota vlastnosti

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

Zděděno zMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

Možnosti konfigurace proxy serveru pro odchozí požadavky

proxyOptions?: ProxySettings

Hodnota vlastnosti

ProxySettings

Zděděno zMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Možnosti zpracování odpovědí přesměrování

redirectOptions?: RedirectPolicyOptions

Hodnota vlastnosti

RedirectPolicyOptions

Zděděno zMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

Možnosti, které určují, jak opakovat neúspěšné žádosti.

retryOptions?: PipelineRetryOptions

Hodnota vlastnosti

PipelineRetryOptions

Zděděno zMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

Možnosti nastavení běžné telemetrie a trasování informací pro odchozí požadavky

telemetryOptions?: TelemetryOptions

Hodnota vlastnosti

TelemetryOptions

Zděděno zMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Možnosti konfigurace ověřování TLS

tlsOptions?: TlsSettings

Hodnota vlastnosti

TlsSettings

Zděděno zMultiTenantTokenCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Možnosti, které se mají poskytnout vrstvě trvalosti (pokud je k dispozici) při ukládání přihlašovacích údajů

Nejprve musíte zaregistrovat modul plug-in poskytovatele trvalosti. Viz balíček na @azure/identity-cache-persistence NPM.

Příklad:

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

Hodnota vlastnosti

TokenCachePersistenceOptions

Zděděno zCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Možnosti pro přidání podrobností o uživatelském agentu k odchozím požadavkům

userAgentOptions?: UserAgentPolicyOptions

Hodnota vlastnosti

UserAgentPolicyOptions

Zděděno zMultiTenantTokenCredentialOptions.userAgentOptions