共用方式為

DeviceCodeCredential class

  • 參考
套件:
@azure/identity

啟用驗證，以使用使用者可以輸入https://microsoft.com/devicelogin的裝置代碼 Microsoft Entra ID。

建構函式

DeviceCodeCredential(DeviceCodeCredentialOptions)

使用 Microsoft Entra ID 起始裝置程式代碼授權流程所需的詳細數據，建立 DeviceCodeCredential 的實例。

系統會記錄一則訊息，為使用者提供一個程式代碼，可在使用者前往之後用來驗證 https://microsoft.com/devicelogin

開發人員可以藉由傳遞自定義 userPromptCallback來設定此訊息的顯示方式：

const credential = new DeviceCodeCredential({
  tenantId: env.AZURE_TENANT_ID,
  clientId: env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  }
});

方法

authenticate(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 進行驗證，並在成功時傳回存取令牌。 如果驗證失敗，則會擲回 CredentialUnavailableError ，並包含失敗的詳細數據。

如果令牌無法以無訊息方式擷取，此方法將需要用戶互動來擷取令牌。
getToken(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 進行驗證，並在成功時傳回存取令牌。 如果驗證失敗，則會擲回 CredentialUnavailableError ，並包含失敗的詳細數據。

如果使用者提供 選項 disableAutomaticAuthentication，一旦無法以無訊息方式擷取令牌，此方法就不會嘗試要求用戶互動來擷取令牌。

建構函式詳細資料

DeviceCodeCredential(DeviceCodeCredentialOptions)

使用 Microsoft Entra ID 起始裝置程式代碼授權流程所需的詳細數據，建立 DeviceCodeCredential 的實例。

系統會記錄一則訊息，為使用者提供一個程式代碼，可在使用者前往之後用來驗證 https://microsoft.com/devicelogin

開發人員可以藉由傳遞自定義 userPromptCallback來設定此訊息的顯示方式：

const credential = new DeviceCodeCredential({
  tenantId: env.AZURE_TENANT_ID,
  clientId: env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  }
});

new DeviceCodeCredential(options?: DeviceCodeCredentialOptions)

參數

options
DeviceCodeCredentialOptions

設定客戶端以進行驗證要求的選項。

方法詳細資料

authenticate(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 進行驗證，並在成功時傳回存取令牌。 如果驗證失敗，則會擲回 CredentialUnavailableError ，並包含失敗的詳細數據。

如果令牌無法以無訊息方式擷取，此方法將需要用戶互動來擷取令牌。

function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>

參數

scopes

string | string[]

令牌可存取的範圍清單。

options
GetTokenOptions

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

傳回

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 進行驗證，並在成功時傳回存取令牌。 如果驗證失敗，則會擲回 CredentialUnavailableError ，並包含失敗的詳細數據。

如果使用者提供 選項 disableAutomaticAuthentication，一旦無法以無訊息方式擷取令牌，此方法就不會嘗試要求用戶互動來擷取令牌。

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

參數

scopes

string | string[]

令牌可存取的範圍清單。

options
GetTokenOptions

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

傳回

Promise<AccessToken>