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 應用程式用戶端標識碼。

domain

string

包含此應用程式的網域或租用戶標識碼。

certificate

string

PEM 編碼的憑證私鑰。

thumbprint

string

憑證的十六進位編碼指紋。

tokenAudience

TokenAudience

要求令牌的物件。 有效值為 'graph'、'batch' 或任何其他資源，例如 'https://vault.azure.net/'。 如果 tokenAudience 是 'graph'，則也應該提供網域，而且其值不應該是預設的 'common' 租使用者。 它必須是字串（最好是 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 應用程式用戶端標識碼也稱為 SPN （ServicePrincipal Name）。 如需範例，請參閱 .Net 的 Active Directory 快速入門。

certificateStringOrFilePath

string

PEM 編碼的憑證和私鑰，或包含該資訊的 .pem 檔案的絕對檔案路徑。 例如：

• CertificateString： “-----BEGIN PRIVATE KEY <-----\nxxxxx>\n----- END PRIVATE KEY-----\n-----BEGIN CERTIFICATE <-----\nyyyyy>\n----- END CERTIFICATE-----\n”
• CertificateFilePath：.pem 檔案的絕對 檔案路徑。

domain

string

包含此應用程式的網域或租用戶標識碼。

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