AttestationAdministrationClient | @azure/attestation

Attestation Client class.

The AttestationClient class enables access to the Attestation related APIs:

getPolicy
setPolicy
resetPolicy
getPolicyManagementCertificates
addPolicyManagementCertificate
removePolicyManagementCertificate

Hierarchy

AttestationAdministrationClient

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationAdministrationClient.ts:108
Creates an instance of AttestationAdministrationClient.

Example usage:
```
import { AttestationAdministrationClient } from "@azure/attestation";

const client = new AttestationAdministrationClient(
   "<service endpoint>",
   new TokenCredential("<>")
);
```
Parameters
- endpoint: string
  
  The attestation instance endpoint, for example https://mytenant.attest.azure.net.
- credentials: TokenCredential
- Default value options: AttestationAdministrationClientOptions = {}
  
  Used to configure the Form Recognizer client.
Returns AttestationAdministrationClient

Methods

addPolicyManagementCertificate

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationAdministrationClient.ts:445
Add a new certificate chain to the set of policy management certificates.

remarks

This API is only supported on isolated attestation instances.

The signing key MUST be one of the existing attestation signing certificates. The new pemCertificate is signed using the signingKey and the service will validate the signature before allowing the addition.

throws

{@link Error} when a private key is specified without a certificate and vice versa.

throws

{@link Error} when the key in the certificate provided does not match the private key.

Parameters
- pemCertificate: string
  
  PEM encoded certificate to add to the set of policy management certificates.
- privateKey: string
  
  Existing attestation private key used to sign the incoming request.
- certificate: string
  
  Existing attestation certificate used to verify the incoming request.
- Default value options: AttestationAdministrationClientPolicyCertificateOperationOptions = {}
  
  Options used in the call to the service.
Returns Promise<AttestationResponse<PolicyCertificatesModificationResult>>

An attestation response including a PolicyCertificatesModificationResult

getPolicy

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationAdministrationClient.ts:159
Retrieves the attestation policy document from the server, and returns it to the caller.

Parameters
- attestationType: AttestationType
  
  AttestationType for which to retrieve policy.
- Default value options: AttestationAdministrationClientPolicyOperationOptions = {}
  
  Pipeline and client options for the getPolicy call.
Returns Promise<AttestationResponse<string>>

AttestationResponse<string> - the value property is the attestation policy, the token property will be the actual token returned by the attestation service.

getPolicyManagementCertificates

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationAdministrationClient.ts:381
Returns the set of policy management certificates for this attestation instance.

remarks

If the attestation instance is not in Isolated mode, this list will always be empty.

Parameters
- Default value options: AttestationAdministrationClientPolicyCertificateOperationOptions = {}
  
  Options for the call to the attestation service.
Returns Promise<AttestationResponse<AttestationSigner[]>>

AttestationResponse wrapping a list of Attestation Signers.

removePolicyManagementCertificate

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationAdministrationClient.ts:563
Add a new certificate chain to the set of policy management certificates.

remarks

This API is only supported on isolated attestation instances.

The signing key MUST be one of the existing attestation signing certificates. The new pemCertificate is signed using the signingKey and the service will validate the signature before allowing the addition.

throws

{@link Error} when a private key is specified without a certificate and vice versa.

throws

{@link Error} when the key in the certificate provided does not match the private key.

Parameters
- pemCertificate: string
  
  PEM encoded certificate to add to the set of policy management certificates.
- privateKey: string
  
  Existing attestation private key used to sign the incoming request.
- certificate: string
  
  Existing attestation certificate used to verify the incoming request.
- Default value options: AttestationAdministrationClientPolicyCertificateOperationOptions = {}
  
  Options used in the call to the service.
Returns Promise<AttestationResponse<PolicyCertificatesModificationResult>>

An attestation response including a PolicyCertificatesModificationResult

resetPolicy

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationAdministrationClient.ts:313
Resets the attestation policy for the specified {@link attestationType} to the default value.

remarks

Please note that if the attestation service instance is running in "Isolated" mode, the {@link signingKey} must be one of the signing keys configured for the service instance.

throws

{@link Error} when a private key is specified without a certificate and vice versa.

throws

{@link Error} when the key in the certificate provided does not match the private key.

Parameters
- attestationType: AttestationType
  
  Attestation Type for which to set policy.
- Default value options: AttestationAdministrationClientPolicyOperationOptions = {}
  
  call options.
Returns Promise<AttestationResponse<PolicyResult>>

An AttestationResponse wrapping a PolicyResult. Clients can use the PolicyResult to validate that the policy was actually reset by the attestation service.

setPolicy

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationAdministrationClient.ts:231
Sets the attestation policy for the specified {@link attestationType}.

remarks

Please note that if the attestation service instance is running in "Isolated" mode, the {@link signingKey} must be one of the signing keys configured for the service instance.

throws

{@link Error} when a private key is specified without a certificate and vice versa.

throws

{@link Error} when the key in the certificate provided does not match the private key.

Parameters
- attestationType: AttestationType
  
  Attestation Type for which to set policy.
- newPolicyDocument: string
  
  Policy document to be set.
- Default value options: AttestationAdministrationClientPolicyOperationOptions = {}
  
  call options.
Returns Promise<AttestationResponse<PolicyResult>>

An AttestationResponse wrapping a PolicyResult. Clients can use the PolicyResult to validate that the policy was actually set by the attestation service.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

endpoint: string

credentials: TokenCredential

Default value options: AttestationAdministrationClientOptions = {}

Returns AttestationAdministrationClient

Methods

addPolicyManagementCertificate

Parameters

pemCertificate: string

privateKey: string

certificate: string

Default value options: AttestationAdministrationClientPolicyCertificateOperationOptions = {}

Returns Promise<AttestationResponse<PolicyCertificatesModificationResult>>

getPolicy

Parameters

attestationType: AttestationType

Default value options: AttestationAdministrationClientPolicyOperationOptions = {}

Returns Promise<AttestationResponse<string>>

getPolicyManagementCertificates

Parameters

Default value options: AttestationAdministrationClientPolicyCertificateOperationOptions = {}

Returns Promise<AttestationResponse<AttestationSigner[]>>

removePolicyManagementCertificate

Parameters

pemCertificate: string

privateKey: string

certificate: string

Default value options: AttestationAdministrationClientPolicyCertificateOperationOptions = {}

Returns Promise<AttestationResponse<PolicyCertificatesModificationResult>>

resetPolicy

Parameters

attestationType: AttestationType

Default value options: AttestationAdministrationClientPolicyOperationOptions = {}

Returns Promise<AttestationResponse<PolicyResult>>

setPolicy

Parameters

attestationType: AttestationType

newPolicyDocument: string

Default value options: AttestationAdministrationClientPolicyOperationOptions = {}

Returns Promise<AttestationResponse<PolicyResult>>