共用方式為

DefaultAzureCredential class

套件:
@azure/identity

提供預設 ChainedTokenCredential 組態，適用於使用 Azure SDK 用戶端連結庫的大部分應用程式。 如需詳細資訊，請參閱 DefaultAzureCredential 概觀。

將依序嘗試下列認證類型：

如需如何嘗試驗證的詳細資訊，請參閱這些認證類型的檔。

下列範例示範如何使用選項 requiredEnvVars 來確保在實例化之前 DefaultAzureCredential 設定特定環境變數。 如果任何指定的環境變數遺失或為空，則會擲出錯誤，導致應用程式無法在沒有必要配置的情況下繼續執行。 它也示範如何設定 AZURE_TOKEN_CREDENTIALS 環境變數，以控制鏈結中包含哪些認證。

import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential({
  requiredEnvVars: [
    "AZURE_CLIENT_ID",
    "AZURE_TENANT_ID",
    "AZURE_CLIENT_SECRET",
    "AZURE_TOKEN_CREDENTIALS",
  ],
});
Extends
ChainedTokenCredential

建構函式

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

使用 DefaultAzureCredentialClientIdOptions建立 DefaultAzureCredential 類別的實例。
DefaultAzureCredential(DefaultAzureCredentialOptions)

使用 defaultAzureCredentialOptions DefaultAzureCredentialOptions 建立 DefaultAzureCredential 類別的實例。
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

使用 DefaultAzureCredentialResourceIdOptions建立 DefaultAzureCredential 類別的實例。

繼承的方法

getToken(string | string[], GetTokenOptions)

傳回其中一個鏈結 TokenCredential 實作所傳回的第一個存取令牌。 當一或多個認證擲回 AuthenticationError 且沒有傳回存取令牌時，會擲回 AggregateAuthenticationError。

Azure SDK 用戶端連結庫會自動呼叫此方法。 您可以直接呼叫此方法，但也必須處理令牌快取和令牌重新整理。

建構函式詳細資料

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

使用 DefaultAzureCredentialClientIdOptions建立 DefaultAzureCredential 類別的實例。

new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)

參數

options
DefaultAzureCredentialClientIdOptions

選擇性參數。 請參閱 DefaultAzureCredentialClientIdOptions。

DefaultAzureCredential(DefaultAzureCredentialOptions)

使用 defaultAzureCredentialOptions DefaultAzureCredentialOptions 建立 DefaultAzureCredential 類別的實例。

new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)

參數

options
DefaultAzureCredentialOptions

選擇性參數。 請參閱 DefaultAzureCredentialOptions。

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

使用 DefaultAzureCredentialResourceIdOptions建立 DefaultAzureCredential 類別的實例。

new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)

參數

options
DefaultAzureCredentialResourceIdOptions

選擇性參數。 請參閱 DefaultAzureCredentialResourceIdOptions。

繼承的方法的詳細資料

getToken(string | string[], GetTokenOptions)

傳回其中一個鏈結 TokenCredential 實作所傳回的第一個存取令牌。 當一或多個認證擲回 AuthenticationError 且沒有傳回存取令牌時，會擲回 AggregateAuthenticationError。

Azure SDK 用戶端連結庫會自動呼叫此方法。 您可以直接呼叫此方法，但也必須處理令牌快取和令牌重新整理。

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

參數

scopes

string | string[]

令牌將具有存取權的範圍清單。

options
GetTokenOptions

用來設定此 TokenCredential 實作之任何要求的選項。

傳回

Promise<AccessToken>

繼承自ChainedTokenCredential.getToken