共用方式為

ClientCertificateCredentialOptions interface

  • 參考
套件:
@azure/identity

ClientCertificateCredential 類別的選擇性參數。

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

屬性

sendCertificateChain

包含 SubjectName 和簽發者名稱授權之 x5c 標頭的選項。 將此選項設定為將客戶端判斷提示標頭中的base64編碼公用憑證傳送為 x5c 宣告

繼承的屬性

additionallyAllowedTenants

針對多租使用者應用程式，指定認證可取得令牌的其他租使用者。 新增通配符值 「*」 以允許認證取得安裝應用程式之任何租使用者的令牌。
additionalPolicies

要包含在 HTTP 管線中的其他原則。
allowInsecureConnection

如果要求是透過 HTTP 而不是 HTTPS 傳送，則設定為 true
authorityHost

要用於驗證要求的授權單位主機。 可能的值可透過 AzureAuthorityHosts取得。 預設值為 「https://login.microsoftonline.com"。
disableInstanceDiscovery

欄位會決定在嘗試驗證時是否執行實例探索。 將此設定為 true 會完全停用實例探索和授權單位驗證。 因此，請務必確保已設定的授權單位主機有效且值得信任。 這項功能適用於無法連線到元數據端點的案例，例如在私人雲端或 Azure Stack 中。 實例探索的程式需要從 https://login.microsoft.com/ 擷取授權單位元數據，以驗證授權單位。
httpClient

將用來傳送 HTTP 要求的 HttpClient。
loggingOptions

允許使用者設定記錄原則選項的設定、允許記錄帳戶資訊和客戶支援的個人標識資訊。
proxyOptions

設定連出要求 Proxy 的選項。
redirectOptions

如何處理重新導向響應的選項。
retryOptions

控制如何重試失敗要求的選項。
telemetryOptions

將一般遙測和追蹤資訊設定為傳出要求的選項。
tlsOptions

設定 TLS 驗證的選項
tokenCachePersistenceOptions

儲存認證時，提供給持續性層的選項（如果有的話）。

您必須先註冊持續性提供者外掛程式。 請參閱 NPM 上的 @azure/identity-cache-persistence 套件。

例：

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

將使用者代理程式詳細數據新增至傳出要求的選項。

屬性詳細資料

sendCertificateChain

包含 SubjectName 和簽發者名稱授權之 x5c 標頭的選項。 將此選項設定為將客戶端判斷提示標頭中的base64編碼公用憑證傳送為 x5c 宣告

sendCertificateChain?: boolean

屬性值

boolean

繼承的屬性詳細資料

additionallyAllowedTenants

針對多租使用者應用程式，指定認證可取得令牌的其他租使用者。 新增通配符值 「*」 以允許認證取得安裝應用程式之任何租使用者的令牌。

additionallyAllowedTenants?: string[]

屬性值

string[]

繼承自MultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

要包含在 HTTP 管線中的其他原則。

additionalPolicies?: AdditionalPolicyConfig[]

屬性值

AdditionalPolicyConfig[]

繼承自MultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

如果要求是透過 HTTP 而不是 HTTPS 傳送，則設定為 true

allowInsecureConnection?: boolean

屬性值

boolean

繼承自MultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

要用於驗證要求的授權單位主機。 可能的值可透過 AzureAuthorityHosts取得。 預設值為 「https://login.microsoftonline.com"。

authorityHost?: string

屬性值

string

繼承自MultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

欄位會決定在嘗試驗證時是否執行實例探索。 將此設定為 true 會完全停用實例探索和授權單位驗證。 因此，請務必確保已設定的授權單位主機有效且值得信任。 這項功能適用於無法連線到元數據端點的案例，例如在私人雲端或 Azure Stack 中。 實例探索的程式需要從 https://login.microsoft.com/ 擷取授權單位元數據，以驗證授權單位。

disableInstanceDiscovery?: boolean

屬性值

boolean

繼承自AuthorityValidationOptions.disableInstanceDiscovery

httpClient

將用來傳送 HTTP 要求的 HttpClient。

httpClient?: HttpClient

屬性值

HttpClient

繼承自MultiTenantTokenCredentialOptions.httpClient

loggingOptions

允許使用者設定記錄原則選項的設定、允許記錄帳戶資訊和客戶支援的個人標識資訊。

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

屬性值

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

繼承自MultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

設定連出要求 Proxy 的選項。

proxyOptions?: ProxySettings

屬性值

ProxySettings

繼承自MultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

如何處理重新導向響應的選項。

redirectOptions?: RedirectPolicyOptions

屬性值

RedirectPolicyOptions

繼承自MultiTenantTokenCredentialOptions.redirectOptions

retryOptions

控制如何重試失敗要求的選項。

retryOptions?: PipelineRetryOptions

屬性值

PipelineRetryOptions

繼承自MultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

將一般遙測和追蹤資訊設定為傳出要求的選項。

telemetryOptions?: TelemetryOptions

屬性值

TelemetryOptions

繼承自MultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

設定 TLS 驗證的選項

tlsOptions?: TlsSettings

屬性值

TlsSettings

繼承自MultiTenantTokenCredentialOptions.tlsOptions

tokenCachePersistenceOptions

儲存認證時，提供給持續性層的選項（如果有的話）。

您必須先註冊持續性提供者外掛程式。 請參閱 NPM 上的 @azure/identity-cache-persistence 套件。

例：

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

屬性值

TokenCachePersistenceOptions

繼承自CredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

將使用者代理程式詳細數據新增至傳出要求的選項。

userAgentOptions?: UserAgentPolicyOptions

屬性值

UserAgentPolicyOptions

繼承自MultiTenantTokenCredentialOptions.userAgentOptions