你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

ClientSecretCredential class

允许使用为应用注册生成的客户端密码Microsoft Entra ID进行身份验证。 有关如何配置客户端密码的详细信息,可在此处找到:

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

构造函数

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

创建 ClientSecretCredential 的实例,其中包含使用客户端密码针对Microsoft Entra ID进行身份验证所需的详细信息。

方法

getToken(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 进行身份验证,如果成功,则返回访问令牌。 如果身份验证失败,则会引发 CredentialUnavailableError ,其中包含失败的详细信息。

构造函数详细信息

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

创建 ClientSecretCredential 的实例,其中包含使用客户端密码针对Microsoft Entra ID进行身份验证所需的详细信息。

new ClientSecretCredential(tenantId: string, clientId: string, clientSecret: string, options?: ClientSecretCredentialOptions)

参数

tenantId

string

Microsoft Entra租户 (目录) ID。

clientId

string

客户端 (应用程序) 租户中应用注册的 ID。

clientSecret

string

专为应用注册生成的客户端密码。

options
ClientSecretCredentialOptions

用于配置发出身份验证请求的客户端的选项。

方法详细信息

getToken(string | string[], GetTokenOptions)

使用 Microsoft Entra ID 进行身份验证,如果成功,则返回访问令牌。 如果身份验证失败,则会引发 CredentialUnavailableError ,其中包含失败的详细信息。

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

参数

scopes

string | string[]

令牌将有权访问的范围列表。

options
GetTokenOptions

用于配置此 TokenCredential 实现可能发出的任何请求的选项。

返回

Promise<AccessToken>