AttestationAdministrationClient class

套件:

@azure/attestation

證明用戶端類別。

AttestationClient 類別可讓您存取證明相關的 API：

• getPolicy
• setPolicy
• resetPolicy
• 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

備註

只有證明實例才支援 isolated 此 API。

簽署金鑰必須是其中一個現有的證明簽署憑證。 新的 pemCertificate 會使用signedKey 簽署，而且服務會在允許新增之前先驗證簽章。

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

備註

只有證明實例才支援 isolated 此 API。

簽署金鑰必須是其中一個現有的證明簽署憑證。 新的 pemCertificate 會使用signedKey 簽署，而且服務會在允許新增之前先驗證簽章。

resetPolicy(string, AttestationAdministrationClientPolicyOperationOptions)

將指定 證明Type 的證明 原則重設為預設值。

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

參數

attestationType

string

要為其設定原則的證明類型。

options

AttestationAdministrationClientPolicyOperationOptions

呼叫選項。

傳回

Promise<AttestationResponse<PolicyResult>>

AttestationResponse包裝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>>

AttestationResponse包裝PolicyResult。 用戶端可以使用 PolicyResult 來驗證原則是否已由證明服務實際設定。

備註

請注意，如果證明服務實例是以「隔離」模式執行，則必須 <xref:signingKey> 是針對服務實例設定的其中一個簽署金鑰。