AttestationAdministrationClient class

Pakiet:

@azure/attestation

Zaświadczania, klasa klienta.

Klasa AttestationClient umożliwia dostęp do interfejsów API powiązanych z zaświadczeniem:

• getPolicy
• setPolicy
• resetPolicy
• getPolicyManagementCertificates
• addPolicyManagementCertificate
• removePolicyManagementCertificate

Konstruktory

AttestationAdministrationClient(string, TokenCredential, AttestationAdministrationClientOptions)

Tworzy wystąpienie klasy AttestationAdministrationClient. Przykład użycia: import { AttestationAdministrationClient } from "@azure/attestation"; const client = new AttestationAdministrationClient( "<service endpoint>", new TokenCredential("<>") );

Metody

addPolicyManagementCertificate(string, string, string, AttestationAdministrationClientPolicyCertificateOperationOptions)	Dodaj nowy łańcuch certyfikatów do zestawu certyfikatów zarządzania zasadami.
getPolicy(string, AttestationAdministrationClientPolicyOperationOptions)	Pobiera dokument zasad zaświadczania z serwera i zwraca go do obiektu wywołującego.
getPolicyManagementCertificates(AttestationAdministrationClientPolicyCertificateOperationOptions)	Zwraca zestaw certyfikatów zarządzania zasadami dla tego wystąpienia zaświadczania.
removePolicyManagementCertificate(string, string, string, AttestationAdministrationClientPolicyCertificateOperationOptions)	Dodaj nowy łańcuch certyfikatów do zestawu certyfikatów zarządzania zasadami.
resetPolicy(string, AttestationAdministrationClientPolicyOperationOptions)	Resetuje zasady zaświadczania dla określonego attestationType do wartości domyślnej.
setPolicy(string, string, AttestationAdministrationClientPolicyOperationOptions)	Ustawia zasady zaświadczania dla określonego attestationType.

Szczegóły konstruktora

AttestationAdministrationClient(string, TokenCredential, AttestationAdministrationClientOptions)

Tworzy wystąpienie klasy AttestationAdministrationClient.

Przykład użycia:

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

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

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

Parametry

endpoint

string

Punkt końcowy wystąpienia zaświadczania, na przykład https://mytenant.attest.azure.net.

credentials

TokenCredential

options

AttestationAdministrationClientOptions

Służy do konfigurowania klienta Form Recognizer.

Szczegóły metody

addPolicyManagementCertificate(string, string, string, AttestationAdministrationClientPolicyCertificateOperationOptions)

Dodaj nowy łańcuch certyfikatów do zestawu certyfikatów zarządzania zasadami.

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

Parametry

pemCertificate

string

Certyfikat zakodowany za pomocą protokołu PEM do dodania do zestawu certyfikatów zarządzania zasadami.

privateKey

string

Istniejący klucz prywatny zaświadczania używany do podpisywania żądania przychodzącego.

certificate

string

Istniejący certyfikat zaświadczania używany do weryfikowania żądania przychodzącego.

options

AttestationAdministrationClientPolicyCertificateOperationOptions

Opcje używane w wywołaniu usługi.

Zwraca

Promise<AttestationResponse<PolicyCertificatesModificationResult>>

Odpowiedź zaświadczania obejmująca element PolicyCertificatesModificationResult

Uwagi

Ten interfejs API jest obsługiwany tylko w isolated przypadku wystąpień zaświadczania.

Klucz podpisywania musi być jednym z istniejących certyfikatów podpisywania zaświadczania. Nowy certyfikat pemCertificate jest podpisany przy użyciu klucza podpisywania, a usługa zweryfikuje podpis przed zezwoleniem na dodanie.

getPolicy(string, AttestationAdministrationClientPolicyOperationOptions)

Pobiera dokument zasad zaświadczania z serwera i zwraca go do obiektu wywołującego.

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

Parametry

attestationType

string

AttestationType, dla którego mają być pobierane zasady.

options

AttestationAdministrationClientPolicyOperationOptions

Opcje potoku i klienta dla wywołania getPolicy .

Zwraca

Promise<AttestationResponse<string>>

AttestationResponse<string>value— właściwość jest zasadami zaświadczania, token właściwość będzie rzeczywistym tokenem zwróconym przez usługę zaświadczania.

getPolicyManagementCertificates(AttestationAdministrationClientPolicyCertificateOperationOptions)

Zwraca zestaw certyfikatów zarządzania zasadami dla tego wystąpienia zaświadczania.

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

Parametry

options

AttestationAdministrationClientPolicyCertificateOperationOptions

Opcje wywołania usługi zaświadczania.

Zwraca

Promise<AttestationResponse<AttestationSigner[]>>

ZaświadczanieResponse opakowujące listę osób podpisujących zaświadczanie.

Uwagi

Jeśli wystąpienie zaświadczania nie jest w Isolated trybie, ta lista zawsze będzie pusta.

removePolicyManagementCertificate(string, string, string, AttestationAdministrationClientPolicyCertificateOperationOptions)

Dodaj nowy łańcuch certyfikatów do zestawu certyfikatów zarządzania zasadami.

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

Parametry

pemCertificate

string

Certyfikat zakodowany za pomocą protokołu PEM do dodania do zestawu certyfikatów zarządzania zasadami.

privateKey

string

Istniejący klucz prywatny zaświadczania używany do podpisywania żądania przychodzącego.

certificate

string

Istniejący certyfikat zaświadczania używany do weryfikowania żądania przychodzącego.

options

AttestationAdministrationClientPolicyCertificateOperationOptions

Opcje używane w wywołaniu usługi.

Zwraca

Promise<AttestationResponse<PolicyCertificatesModificationResult>>

Odpowiedź zaświadczania obejmująca element PolicyCertificatesModificationResult

Uwagi

Ten interfejs API jest obsługiwany tylko w isolated przypadku wystąpień zaświadczania.

Klucz podpisywania musi być jednym z istniejących certyfikatów podpisywania zaświadczania. Nowy certyfikat pemCertificate jest podpisany przy użyciu klucza podpisywania, a usługa zweryfikuje podpis przed zezwoleniem na dodanie.

resetPolicy(string, AttestationAdministrationClientPolicyOperationOptions)

Resetuje zasady zaświadczania dla określonego attestationType do wartości domyślnej.

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

Parametry

attestationType

string

Typ zaświadczania, dla którego należy ustawić zasady.

options

AttestationAdministrationClientPolicyOperationOptions

opcje wywołania.

Zwraca

Promise<AttestationResponse<PolicyResult>>

ZaświadczanieResponse opakowującezasadyResult. Klienci mogą użyć elementu PolicyResult, aby sprawdzić, czy zasady zostały rzeczywiście zresetowane przez usługę zaświadczania.

Uwagi

Należy pamiętać, że jeśli wystąpienie usługi zaświadczania jest uruchomione w trybie "Izolowany", <xref:signingKey> musi być jednym z kluczy podpisywania skonfigurowanych dla wystąpienia usługi.

setPolicy(string, string, AttestationAdministrationClientPolicyOperationOptions)

Ustawia zasady zaświadczania dla określonego attestationType.

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

Parametry

attestationType

string

Typ zaświadczania, dla którego należy ustawić zasady.

newPolicyDocument

string

Dokument zasad do ustawienia.

options

AttestationAdministrationClientPolicyOperationOptions

opcje wywołania.

Zwraca

Promise<AttestationResponse<PolicyResult>>

ZaświadczanieResponse opakowującezasadyResult. Klienci mogą użyć wartości PolicyResult, aby sprawdzić, czy zasady zostały rzeczywiście ustawione przez usługę zaświadczania.

Uwagi

Należy pamiętać, że jeśli wystąpienie usługi zaświadczania jest uruchomione w trybie "Izolowany", <xref:signingKey> musi być jednym z kluczy podpisywania skonfigurowanych dla wystąpienia usługi.