Share via


EnvironmentCredential class

啟用驗證以使用用戶端密碼或憑證,或以使用者名稱和密碼的使用者身分進行 Microsoft Entra ID。

建構函式

EnvironmentCredential(EnvironmentCredentialOptions)

建立 EnvironmentCredential 類別的實例,並根據可用的環境變數決定要使用的認證。

必要的環境變數:

  • AZURE_TENANT_ID:Microsoft Entra 租使用者 (目錄) 標識符。
  • AZURE_CLIENT_ID:用戶端 (應用程式) 租用戶中應用程式註冊的標識碼。

如果設定AZURE_TENANT_ID,您也可以設定其他允許的租使用者

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS:針對多租使用者應用程式,指定認證可能會取得具有單一分號分隔字串之令牌的其他租使用者。 使用 * 允許所有租使用者。

用戶端認證驗證的環境變數:

  • AZURE_CLIENT_SECRET:為應用程式註冊產生的客戶端密碼。
  • AZURE_CLIENT_CERTIFICATE_PATH:驗證期間要使用的 PEM 憑證路徑,而不是客戶端密碼。
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (憑證檔案的選擇性) 密碼。

或者,使用者可以為使用者名稱和密碼驗證提供環境變數:

  • AZURE_USERNAME:用來驗證的用戶名稱。
  • AZURE_PASSWORD:用來驗證的密碼。

如果遺漏執行驗證所需的環境變數,將會擲回 CredentialUnavailableError 。 如果驗證失敗,或發生未知的錯誤,則會擲回 AuthenticationError

方法

getToken(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 進行驗證,並在成功時傳回存取令牌。

建構函式詳細資料

EnvironmentCredential(EnvironmentCredentialOptions)

建立 EnvironmentCredential 類別的實例,並根據可用的環境變數決定要使用的認證。

必要的環境變數:

  • AZURE_TENANT_ID:Microsoft Entra 租使用者 (目錄) 標識符。
  • AZURE_CLIENT_ID:用戶端 (應用程式) 租用戶中應用程式註冊的標識碼。

如果設定AZURE_TENANT_ID,您也可以設定其他允許的租使用者

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS:針對多租使用者應用程式,指定認證可能會取得具有單一分號分隔字串之令牌的其他租使用者。 使用 * 允許所有租使用者。

用戶端認證驗證的環境變數:

  • AZURE_CLIENT_SECRET:為應用程式註冊產生的客戶端密碼。
  • AZURE_CLIENT_CERTIFICATE_PATH:驗證期間要使用的 PEM 憑證路徑,而不是客戶端密碼。
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (憑證檔案的選擇性) 密碼。

或者,使用者可以為使用者名稱和密碼驗證提供環境變數:

  • AZURE_USERNAME:用來驗證的用戶名稱。
  • AZURE_PASSWORD:用來驗證的密碼。

如果遺漏執行驗證所需的環境變數,將會擲回 CredentialUnavailableError 。 如果驗證失敗,或發生未知的錯誤,則會擲回 AuthenticationError

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

參數

options
EnvironmentCredentialOptions

設定發出驗證要求之客戶端的選項。

方法詳細資料

getToken(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 進行驗證,並在成功時傳回存取令牌。

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

參數

scopes

string | string[]

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

options
GetTokenOptions

選用參數。 請參閱 GetTokenOptions

傳回

Promise<AccessToken>