通过

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

ApplicationTokenCertificateCredentials class

  • 参考
包:
@azure/ms-rest-nodeauth
Extends

ApplicationTokenCredentialsBase

构造函数

ApplicationTokenCertificateCredentials(string, string, string, string, TokenAudience, Environment, TokenCache)

创建新的 ApplicationTokenCredentials 对象。 有关创建 Azure Active Directory 应用程序的详细说明，请参阅 .Net 的 Active Directory 快速入门。

属性

certificate
thumbprint

继承属性

authContext
clientId
domain
environment
tokenAudience
tokenCache

方法

create(string, string, string, AzureTokenCredentialsOptions)

创建 ApplicationTokenCertificateCredentials 的新实例。
getToken()

最初尝试从缓存获取令牌。 如果这不成功，则尝试从 ADAL 获取令牌。

继承的方法

setDomain(string)
signRequest(WebResource)

使用身份验证标头对请求进行签名。

构造函数详细信息

ApplicationTokenCertificateCredentials(string, string, string, string, TokenAudience, Environment, TokenCache)

创建新的 ApplicationTokenCredentials 对象。 有关创建 Azure Active Directory 应用程序的详细说明，请参阅 .Net 的 Active Directory 快速入门。

new ApplicationTokenCertificateCredentials(clientId: string, domain: string, certificate: string, thumbprint: string, tokenAudience?: TokenAudience, environment?: Environment, tokenCache?: TokenCache)

参数

clientId

string

Active Directory 应用程序客户端 ID。

domain

string

包含此应用程序的域或租户 ID。

certificate

string

PEM 编码的证书私钥。

thumbprint

string

证书的十六进制编码指纹。

tokenAudience
TokenAudience

为其请求令牌的受众。 有效值为“graph”、“batch”或任何其他资源（如“”。https://vault.azure.net/ 如果 tokenAudience 为“graph”，则还应提供域，并且其值不应为默认的“公共”租户。 它必须是一个字符串 (采用 guid 格式) 。

environment
Environment

要进行身份验证的 Azure 环境。

tokenCache

TokenCache

令牌缓存。 默认值为 adal 中的 MemoryCache 对象。

属性详细信息

certificate 

certificate: string

属性值

string

thumbprint 

thumbprint: string

属性值

string

继承属性详细信息

authContext 

authContext: AuthenticationContext

属性值

AuthenticationContext

继承自 ApplicationTokenCredentialsBase.authContext

clientId 

clientId: string

属性值

string

继承自 ApplicationTokenCredentialsBase.clientId

domain 

domain: string

属性值

string

继承自 ApplicationTokenCredentialsBase.domain

environment 

environment: Environment

属性值

Environment

继承自 ApplicationTokenCredentialsBase.environment

tokenAudience 

tokenAudience?: string

属性值

string

继承自 ApplicationTokenCredentialsBase.tokenAudience

tokenCache 

tokenCache: TokenCache

属性值

TokenCache

继承自 ApplicationTokenCredentialsBase.tokenCache

方法详细信息

create(string, string, string, AzureTokenCredentialsOptions)

创建 ApplicationTokenCertificateCredentials 的新实例。

static function create(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions): ApplicationTokenCertificateCredentials

参数

clientId

string

Active Directory 应用程序客户端 ID 也称为 SPN (ServicePrincipal 名称) 。 有关示例，请参阅 .Net 的 Active Directory 快速入门 。

certificateStringOrFilePath

string

PEM 编码的证书和私钥或包含该信息的 .pem 文件的绝对文件路径。 例如：

  • CertificateString：“-----BEGIN 私钥-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n”
  • CertificateFilePath：.pem 文件的 绝对 文件路径。
domain

string

包含此应用程序的域或租户 ID。

options
AzureTokenCredentialsOptions

AzureTokenCredentialsOptions - 表示可选参数的对象。

返回

ApplicationTokenCertificateCredentials

ApplicationTokenCertificateCredentials

getToken()

最初尝试从缓存获取令牌。 如果这不成功，则尝试从 ADAL 获取令牌。

function getToken(): Promise<TokenResponse>

返回

Promise<TokenResponse>

解析为 TokenResponse 并拒绝并显示错误的承诺。

继承的方法详细信息

setDomain(string) 

function setDomain(domain: string)

参数

domain

string

继承自 ApplicationTokenCredentialsBase.setDomain

signRequest(WebResource)

使用身份验证标头对请求进行签名。

function signRequest(webResource: WebResource): Promise<WebResource>

参数

webResource
WebResource

要签名的 WebResource。

返回

Promise<WebResource>

继承自 ApplicationTokenCredentialsBase.signRequest