你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
OnBehalfOfCredential class
允许使用“代表”流Microsoft Entra ID进行身份验证。
构造函数
On |
创建 OnBehalfOfCredential 的实例,其中包含针对具有 PEM 证书路径和用户断言的Microsoft Entra ID进行身份验证所需的详细信息。 使用
|
On |
创建 OnBehalfOfCredential 的实例,其中包含使用客户端密码和用户断言针对Microsoft Entra ID进行身份验证所需的详细信息。 使用
|
方法
get |
使用 Microsoft Entra ID 进行身份验证,如果成功,则返回访问令牌。 如果身份验证失败,则会引发 CredentialUnavailableError ,其中包含失败的详细信息。 |
构造函数详细信息
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
创建 OnBehalfOfCredential 的实例,其中包含针对具有 PEM 证书路径和用户断言的Microsoft Entra ID进行身份验证所需的详细信息。
使用 KeyClient
from @azure/keyvault-keys 的示例:
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进行身份验证所需的详细信息。
使用 KeyClient
from @azure/keyvault-keys 的示例:
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 ID 进行身份验证,如果成功,则返回访问令牌。 如果身份验证失败,则会引发 CredentialUnavailableError ,其中包含失败的详细信息。
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>
参数
- scopes
-
string | string[]
令牌将有权访问的范围列表。
- options
- GetTokenOptions
用于配置基础网络请求的选项。
返回
Promise<AccessToken>