AttestationAdministrationClient class
Classe cliente de atestado.
A classe AttestationClient permite o acesso às APIs relacionadas ao Atestado:
- getPolicy
- Política de conjunto
- Política de redefinição
- getPolicyManagementCertificates
- Certificado de gerenciamento de política de adição
- removePolicyManagementCertificate
Construtores
| Attestation |
Cria uma instância de AttestationAdministrationClient. Uso de exemplo: |
Métodos
Detalhes do construtor
AttestationAdministrationClient(string, TokenCredential, AttestationAdministrationClientOptions)
Cria uma instância de AttestationAdministrationClient.
Uso de exemplo:
import { AttestationAdministrationClient } from "@azure/attestation";
const client = new AttestationAdministrationClient(
"<service endpoint>",
new TokenCredential("<>")
);
new AttestationAdministrationClient(endpoint: string, credentials: TokenCredential, options?: AttestationAdministrationClientOptions)Parâmetros
- endpoint
-
string
O ponto de extremidade da instância de atestado, por exemplo, https://mytenant.attest.azure.net.
- credentials
- TokenCredential
Usado para configurar o cliente do Reconhecimento de Formulários.
Detalhes do método
addPolicyManagementCertificate(string, string, string, AttestationAdministrationClientPolicyCertificateOperationOptions)
Adicione uma nova cadeia de certificados ao conjunto de certificados de gerenciamento de políticas.
function addPolicyManagementCertificate(pemCertificate: string, privateKey: string, certificate: string, options?: AttestationAdministrationClientPolicyCertificateOperationOptions): Promise<AttestationResponse<PolicyCertificatesModificationResult>>Parâmetros
- pemCertificate
-
string
Certificado codificado em PEM para adicionar ao conjunto de certificados de gerenciamento de políticas.
- privateKey
-
string
Chave privada de atestado existente usada para assinar a solicitação de entrada.
- certificate
-
string
Certificado de atestado existente usado para verificar a solicitação de entrada.
Opções usadas na chamada para o serviço.
Retornos
Uma resposta de atestado, incluindo um PolicyCertificatesModificationResult
Comentários
Essa API só tem suporte em isolated instâncias de atestado.
A chave de assinatura DEVE ser um dos certificados de assinatura de atestado existentes. O novo pemCertificate é assinado usando a signingKey e o serviço validará a assinatura antes de permitir a adição.
getPolicy(string, AttestationAdministrationClientPolicyOperationOptions)
Recupera o documento de política de atestado do servidor e o retorna ao chamador.
function getPolicy(attestationType: string, options?: AttestationAdministrationClientPolicyOperationOptions): Promise<AttestationResponse<string>>Parâmetros
- attestationType
-
string
AttestationType para o qual recuperar a política.
Opções de pipeline e cliente para a chamada getPolicy.
Retornos
Promise<AttestationResponse<string>>
AttestationResponse<string> - a propriedade value é a política de atestado, a propriedade token será o token real retornado pelo serviço de atestado.
getPolicyManagementCertificates(AttestationAdministrationClientPolicyCertificateOperationOptions)
Retorna o conjunto de certificados de gerenciamento de políticas para essa instância de atestado.
function getPolicyManagementCertificates(options?: AttestationAdministrationClientPolicyCertificateOperationOptions): Promise<AttestationResponse<AttestationSigner[]>>Parâmetros
Opções para a chamada para o serviço de atestado.
Retornos
Promise<AttestationResponse<AttestationSigner[]>>
AttestationResponse encapsulando uma lista de Signatários de Atestado.
Comentários
Se a instância de atestado não estiver no modo Isolated, essa lista sempre estará vazia.
removePolicyManagementCertificate(string, string, string, AttestationAdministrationClientPolicyCertificateOperationOptions)
Adicione uma nova cadeia de certificados ao conjunto de certificados de gerenciamento de políticas.
function removePolicyManagementCertificate(pemCertificate: string, privateKey: string, certificate: string, options?: AttestationAdministrationClientPolicyCertificateOperationOptions): Promise<AttestationResponse<PolicyCertificatesModificationResult>>Parâmetros
- pemCertificate
-
string
Certificado codificado em PEM para adicionar ao conjunto de certificados de gerenciamento de políticas.
- privateKey
-
string
Chave privada de atestado existente usada para assinar a solicitação de entrada.
- certificate
-
string
Certificado de atestado existente usado para verificar a solicitação de entrada.
Opções usadas na chamada para o serviço.
Retornos
Uma resposta de atestado, incluindo um PolicyCertificatesModificationResult
Comentários
Essa API só tem suporte em isolated instâncias de atestado.
A chave de assinatura DEVE ser um dos certificados de assinatura de atestado existentes. O novo pemCertificate é assinado usando a signingKey e o serviço validará a assinatura antes de permitir a adição.
resetPolicy(string, AttestationAdministrationClientPolicyOperationOptions)
Redefine a política de atestado do atestado especificado para o valor padrão.
function resetPolicy(attestationType: string, options?: AttestationAdministrationClientPolicyOperationOptions): Promise<AttestationResponse<PolicyResult>>Parâmetros
- attestationType
-
string
Tipo de atestado para o qual definir a política.
opções de chamada.
Retornos
Promise<AttestationResponse<PolicyResult>>
Um AtestadoResponse encapsulando um PolicyResult . Os clientes podem usar o PolicyResult para validar que a política foi redefinida pelo serviço de atestado.
Comentários
Observe que, se a instância do serviço de atestado estiver em execução no modo "Isolado", o <xref:signingKey> deverá ser uma das chaves de assinatura configuradas para a instância de serviço.
setPolicy(string, string, AttestationAdministrationClientPolicyOperationOptions)
Define a política de atestado para o atestado deespecificado.
function setPolicy(attestationType: string, newPolicyDocument: string, options?: AttestationAdministrationClientPolicyOperationOptions): Promise<AttestationResponse<PolicyResult>>Parâmetros
- attestationType
-
string
Tipo de atestado para o qual definir a política.
- newPolicyDocument
-
string
Documento de política a ser definido.
opções de chamada.
Retornos
Promise<AttestationResponse<PolicyResult>>
Um AtestadoResponse encapsulando um PolicyResult . Os clientes podem usar o PolicyResult para validar que a política foi realmente definida pelo serviço de atestado.
Comentários
Observe que, se a instância do serviço de atestado estiver em execução no modo "Isolado", o <xref:signingKey> deverá ser uma das chaves de assinatura configuradas para a instância de serviço.