共用方式為

OnBehalfOfCredential class

  • 參考
套件:
@azure/identity

使用 代表流程啟用驗證，以Microsoft Entra 標識符。

建構函式

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

使用用戶端 getAssertion 和使用者判斷提示，建立 OnBehalfOfCredential 實例，其中包含針對 Microsoft Entra 標識符進行驗證所需的詳細數據。

使用來自 @azure/keyvault-keysKeyClient 的範例：

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  getAssertion: () => { return Promise.resolve("my-jwt")},
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

建立 OnBehalfOfCredential 的實例，其中包含使用 PEM 憑證路徑和使用者判斷提示，針對Microsoft Entra ID 進行驗證所需的詳細數據。

使用來自 @azure/keyvault-keysKeyClient 的範例：

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  certificatePath: "/path/to/certificate.pem",
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");
OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

使用用戶端密碼和使用者判斷提示，建立 OnBehalfOfCredential 實例，其中包含針對 Microsoft Entra ID 進行驗證所需的詳細數據。

使用來自 @azure/keyvault-keysKeyClient 的範例：

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  clientSecret,
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");

方法

getToken(string | string[], GetTokenOptions)

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

建構函式詳細資料

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

使用用戶端 getAssertion 和使用者判斷提示，建立 OnBehalfOfCredential 實例，其中包含針對 Microsoft Entra 標識符進行驗證所需的詳細數據。

使用來自 @azure/keyvault-keysKeyClient 的範例：

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  getAssertion: () => { return Promise.resolve("my-jwt")},
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");

new OnBehalfOfCredential(options: OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

參數

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

選擇性參數，通常跨認證通用。

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

建立 OnBehalfOfCredential 的實例，其中包含使用 PEM 憑證路徑和使用者判斷提示，針對Microsoft Entra ID 進行驗證所需的詳細數據。

使用來自 @azure/keyvault-keysKeyClient 的範例：

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  certificatePath: "/path/to/certificate.pem",
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");

new OnBehalfOfCredential(options: OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

參數

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

選擇性參數，通常跨認證通用。

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

使用用戶端密碼和使用者判斷提示，建立 OnBehalfOfCredential 實例，其中包含針對 Microsoft Entra ID 進行驗證所需的詳細數據。

使用來自 @azure/keyvault-keysKeyClient 的範例：

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  clientSecret,
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");

new OnBehalfOfCredential(options: OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

參數

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

選擇性參數，通常跨認證通用。

方法詳細資料

getToken(string | string[], GetTokenOptions)

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

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

參數

scopes

string | string[]

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

options
GetTokenOptions

用來設定基礎網路要求的選項。

傳回

Promise<AccessToken>