AttestationAdministrationClient class
Аттестация Класс Client.
Класс AttestationClient обеспечивает доступ к API, связанным с аттестацией:
- getPolicy
- setPolicy
- resetPolicy
- GetPolicyManagementCertificates
- addPolicyManagementCertificate
- removePolicyManagementCertificate
Конструкторы
| Attestation |
Создает экземпляр AttestationAdministrationClient. Пример использования: |
Методы
Сведения о конструкторе
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
Используется для настройки клиента Распознаватель документов.
Сведения о методе
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
Существующий сертификат аттестации, используемый для проверки входящего запроса.
Параметры, используемые в вызове службы.
Возвращаемое значение
Ответ аттестации, включающий PolicyCertificatesModificationResult
Комментарии
Этот API поддерживается только в isolated экземплярах аттестации.
Ключ подписи должен быть одним из существующих сертификатов подписи аттестации. Новый pemCertificate подписывается с помощью ключа подписи, и служба проверит подпись, прежде чем разрешить добавление.
getPolicy(string, AttestationAdministrationClientPolicyOperationOptions)
Извлекает документ политики аттестации с сервера и возвращает его вызывающему объекту.
function getPolicy(attestationType: string, options?: AttestationAdministrationClientPolicyOperationOptions): Promise<AttestationResponse<string>>Параметры
- attestationType
-
string
AttestationType, для которого требуется получить политику.
Параметры конвейера и клиента для getPolicy вызова.
Возвращаемое значение
Promise<AttestationResponse<string>>
AttestationResponse<string>value— свойство является политикой аттестации, свойство token будет фактическим маркером, возвращенным службой аттестации.
getPolicyManagementCertificates(AttestationAdministrationClientPolicyCertificateOperationOptions)
Возвращает набор сертификатов управления политиками для этого экземпляра аттестации.
function getPolicyManagementCertificates(options?: AttestationAdministrationClientPolicyCertificateOperationOptions): Promise<AttestationResponse<AttestationSigner[]>>Параметры
Параметры для вызова службы аттестации.
Возвращаемое значение
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
Существующий сертификат аттестации, используемый для проверки входящего запроса.
Параметры, используемые в вызове службы.
Возвращаемое значение
Ответ аттестации, включающий PolicyCertificatesModificationResult
Комментарии
Этот API поддерживается только в isolated экземплярах аттестации.
Ключ подписи должен быть одним из существующих сертификатов подписи аттестации. Новый pemCertificate подписывается с помощью ключа подписи, и служба проверит подпись, прежде чем разрешить добавление.
resetPolicy(string, AttestationAdministrationClientPolicyOperationOptions)
Сбрасывает политику аттестации для указанного типа аттестации до значения по умолчанию.
function resetPolicy(attestationType: string, options?: AttestationAdministrationClientPolicyOperationOptions): Promise<AttestationResponse<PolicyResult>>Параметры
- attestationType
-
string
Тип аттестации, для которого следует задать политику.
параметры вызова.
Возвращаемое значение
Promise<AttestationResponse<PolicyResult>>
АттестацияОтвет, который упаковываетPolicyResult. Клиенты могут использовать PolicyResult для проверки того, что политика была фактически сброшена службой аттестации.
Комментарии
Обратите внимание, что если экземпляр службы аттестации работает в режиме "Изолированный", для экземпляра <xref:signingKey> службы должен быть один из ключей подписывания, настроенных для экземпляра службы.
setPolicy(string, string, AttestationAdministrationClientPolicyOperationOptions)
Задает политику аттестации для указанного типа аттестации.
function setPolicy(attestationType: string, newPolicyDocument: string, options?: AttestationAdministrationClientPolicyOperationOptions): Promise<AttestationResponse<PolicyResult>>Параметры
- attestationType
-
string
Тип аттестации, для которого следует задать политику.
- newPolicyDocument
-
string
Документ политики, который необходимо задать.
параметры вызова.
Возвращаемое значение
Promise<AttestationResponse<PolicyResult>>
АттестацияОтвет, который упаковываетPolicyResult. Клиенты могут использовать PolicyResult для проверки того, что политика действительно задана службой аттестации.
Комментарии
Обратите внимание, что если экземпляр службы аттестации работает в режиме "Изолированный", для экземпляра <xref:signingKey> службы должен быть один из ключей подписывания, настроенных для экземпляра службы.