通过

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

AttestationAdministrationClient class

包:
@azure/attestation

证明客户端类。

AttestationClient 类允许访问证明相关的 API：

  • getPolicy
  • 设置策略
  • 重置策略
  • getPolicyManagementCertificates
  • addPolicyManagementCertificate
  • removePolicyManagementCertificate

构造函数

AttestationAdministrationClient(string, TokenCredential, AttestationAdministrationClientOptions)

创建 AttestationAdministrationClient 的实例。

示例用法：

import { AttestationAdministrationClient } from "@azure/attestation";

const client = new AttestationAdministrationClient(
   "<service endpoint>",
   new TokenCredential("<>")
);

方法

addPolicyManagementCertificate(string, string, string, AttestationAdministrationClientPolicyCertificateOperationOptions)

向策略管理证书集添加新的证书链。
getPolicy(string, AttestationAdministrationClientPolicyOperationOptions)

从服务器检索证明策略文档，并将其返回到调用方。
getPolicyManagementCertificates(AttestationAdministrationClientPolicyCertificateOperationOptions)

返回此证明实例的策略管理证书集。
removePolicyManagementCertificate(string, string, string, AttestationAdministrationClientPolicyCertificateOperationOptions)

向策略管理证书集添加新的证书链。
resetPolicy(string, AttestationAdministrationClientPolicyOperationOptions)

将指定 证明Type 的证明策略重置为默认值。
setPolicy(string, string, AttestationAdministrationClientPolicyOperationOptions)

为指定的 证明Type设置证明策略。

构造函数详细信息

AttestationAdministrationClient(string, TokenCredential, AttestationAdministrationClientOptions)

创建 AttestationAdministrationClient 的实例。

示例用法：

import { AttestationAdministrationClient } from "@azure/attestation";

const client = new AttestationAdministrationClient(
   "<service endpoint>",
   new TokenCredential("<>")
);

new AttestationAdministrationClient(endpoint: string, credentials: TokenCredential, options?: AttestationAdministrationClientOptions)

参数

endpoint

string

证明实例终结点，例如 https://mytenant.attest.azure.net。

credentials
TokenCredential
options
AttestationAdministrationClientOptions

用于配置表单识别器客户端。

方法详细信息

addPolicyManagementCertificate(string, string, string, AttestationAdministrationClientPolicyCertificateOperationOptions)

向策略管理证书集添加新的证书链。

function addPolicyManagementCertificate(pemCertificate: string, privateKey: string, certificate: string, options?: AttestationAdministrationClientPolicyCertificateOperationOptions): Promise<AttestationResponse<PolicyCertificatesModificationResult>>

参数

pemCertificate

string

要添加到策略管理证书集的 PEM 编码证书。

privateKey

string

用于对传入请求进行签名的现有证明私钥。

certificate

string

用于验证传入请求的现有证明证书。

options
AttestationAdministrationClientPolicyCertificateOperationOptions

调用服务时使用的选项。

返回

Promise<AttestationResponse<PolicyCertificatesModificationResult>>

包含 PolicyCertificatesModificationResult 的证明响应

注解

此 API 仅在 isolated 证明实例上受支持。

签名密钥必须是现有证明签名证书之一。 新的 pemCertificate 使用 signatureKey 进行签名，服务将在允许添加之前验证签名。

getPolicy(string, AttestationAdministrationClientPolicyOperationOptions)

从服务器检索证明策略文档，并将其返回到调用方。

function getPolicy(attestationType: string, options?: AttestationAdministrationClientPolicyOperationOptions): Promise<AttestationResponse<string>>

参数

attestationType

string

要为其检索策略的 AttestationType。

options
AttestationAdministrationClientPolicyOperationOptions

用于 getPolicy 调用的管道和客户端选项。

返回

Promise<AttestationResponse<string>>

AttestationResponse<string> - value 属性是证明策略，token 属性将是证明服务返回的实际令牌。

getPolicyManagementCertificates(AttestationAdministrationClientPolicyCertificateOperationOptions)

返回此证明实例的策略管理证书集。

function getPolicyManagementCertificates(options?: AttestationAdministrationClientPolicyCertificateOperationOptions): Promise<AttestationResponse<AttestationSigner[]>>

参数

options
AttestationAdministrationClientPolicyCertificateOperationOptions

调用证明服务的选项。

返回

Promise<AttestationResponse<AttestationSigner[]>>

AttestationResponse 包装证明签名者列表。

注解

如果证明实例不在 Isolated 模式下，此列表将始终为空。

removePolicyManagementCertificate(string, string, string, AttestationAdministrationClientPolicyCertificateOperationOptions)

向策略管理证书集添加新的证书链。

function removePolicyManagementCertificate(pemCertificate: string, privateKey: string, certificate: string, options?: AttestationAdministrationClientPolicyCertificateOperationOptions): Promise<AttestationResponse<PolicyCertificatesModificationResult>>

参数

pemCertificate

string

要添加到策略管理证书集的 PEM 编码证书。

privateKey

string

用于对传入请求进行签名的现有证明私钥。

certificate

string

用于验证传入请求的现有证明证书。

options
AttestationAdministrationClientPolicyCertificateOperationOptions

调用服务时使用的选项。

返回

Promise<AttestationResponse<PolicyCertificatesModificationResult>>

包含 PolicyCertificatesModificationResult 的证明响应

注解

此 API 仅在 isolated 证明实例上受支持。

签名密钥必须是现有证明签名证书之一。 新的 pemCertificate 使用 signatureKey 进行签名，服务将在允许添加之前验证签名。

resetPolicy(string, AttestationAdministrationClientPolicyOperationOptions)

将指定 证明Type 的证明策略重置为默认值。

function resetPolicy(attestationType: string, options?: AttestationAdministrationClientPolicyOperationOptions): Promise<AttestationResponse<PolicyResult>>

参数

attestationType

string

要为其设置策略的证明类型。

options
AttestationAdministrationClientPolicyOperationOptions

调用选项。

返回

Promise<AttestationResponse<PolicyResult>>

证明Response 包装 PolicyResult。 客户端可以使用 PolicyResult 来验证策略是否由证明服务实际重置。

注解

请注意，如果证明服务实例在“隔离”模式下运行，则 <xref:signingKey> 必须是为服务实例配置的签名密钥之一。

setPolicy(string, string, AttestationAdministrationClientPolicyOperationOptions)

为指定的 证明Type设置证明策略。

function setPolicy(attestationType: string, newPolicyDocument: string, options?: AttestationAdministrationClientPolicyOperationOptions): Promise<AttestationResponse<PolicyResult>>

参数

attestationType

string

要为其设置策略的证明类型。

newPolicyDocument

string

要设置的策略文档。

options
AttestationAdministrationClientPolicyOperationOptions

调用选项。

返回

Promise<AttestationResponse<PolicyResult>>

证明Response 包装 PolicyResult。 客户端可以使用 PolicyResult 验证策略是否已由证明服务设置。

注解

请注意，如果证明服务实例在“隔离”模式下运行，则 <xref:signingKey> 必须是为服务实例配置的签名密钥之一。