CertificateClient class

  • Ссылка
Пакет:
@azure/keyvault-certificates

Клиент для взаимодействия с функциями сертификатов KeyVault

Конструкторы

CertificateClient(string, TokenCredential, CertificateClientOptions)

Создает экземпляр CertificateClient.

Свойства

vaultUrl

Базовый URL-адрес хранилища

Методы

backupCertificate(string, OperationOptions)

Запрашивает скачивание на клиент резервной копии указанного сертификата. Будут загружены все версии сертификата. Для этой операции требуется разрешение на создание сертификатов или резервное копирование.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");

Создает резервную копию сертификата.
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Создание нового сертификата. Если это первая версия, создается ресурс сертификата. Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время, пока сертификат не будет полностью восстановлен.

Примечание: При отправке SelfissuerName в качестве политики сертификата будет создан самозаверяющий сертификат.

Эта операция требует наличия разрешения на создание сертификатов.

Пример использования:

const client = new CertificateClient(url, credentials);
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert"
};
const createPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy);

// The pending certificate can be obtained by calling the following method:
const pendingCertificate = createPoller.getResult();

// Serializing the poller
const serialized = createPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy, { resumeFrom: serialized });

// Waiting until it's done
const certificate = await createPoller.pollUntilDone();
console.log(certificate);

Создает сертификат
beginDeleteCertificate(string, CertificatePollerOptions)

Операция DELETE применяется к любому сертификату, хранящейся в azure Key Vault. Delete нельзя применить к отдельной версии сертификата. Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время, пока сертификат не будет полностью восстановлен.

Для этой операции требуется разрешение certificates/delete.

Пример использования:

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await createPoller.pollUntilDone();

const deletePoller = await client.beginDeleteCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const deletedCertificate = await deletePoller.pollUntilDone();
console.log(deletedCertificate);

Удаляет сертификат из указанного хранилища ключей.
beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Восстанавливает удаленный сертификат в указанном хранилище. Эту операцию можно выполнить только в хранилище с поддержкой обратимого удаления. Эта операция Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время, пока сертификат не будет полностью восстановлен.

Для этой операции требуется разрешение certificates/recover.

Пример использования:

const client = new CertificateClient(url, credentials);

const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const certificate = await recoverPoller.pollUntilDone();
console.log(certificate);

Восстановление удаленного сертификата
createIssuer(string, string, CreateIssuerOptions)

Операция createIssuer добавляет или обновляет указанного издателя сертификата. Для этой операции требуется разрешение certificates/setissuers.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");

Задает указанного издателя сертификата.
deleteCertificateOperation(string, OperationOptions)

Удаляет операцию создания для указанного сертификата, который находится в процессе создания. Сертификат больше не создается. Для этой операции требуется разрешение на получение сертификатов или обновление.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await client.deleteCertificateOperation("MyCertificate");
await client.getCertificateOperation("MyCertificate"); // Throws error: Pending certificate not found: "MyCertificate"

Удаление операции сертификата
deleteContacts(OperationOptions)

Удаляет все контакты сертификата. Для этой операции требуется разрешение certificates/managecontacts.

Пример использования:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
await client.deleteContacts();

Удаляет все контакты сертификата.
deleteIssuer(string, OperationOptions)

Операция deleteIssuer окончательно удаляет указанного издателя сертификата из хранилища. Для этой операции требуется разрешение certificates/manageissuers/deleteissuers.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Provider");
await client.deleteIssuer("IssuerName");

Удаляет указанного издателя сертификата.
getCertificate(string, OperationOptions)

Возвращает последние сведения, доступные из определенного сертификата, включая политику сертификата. Для этой операции требуется разрешение certificates/get.

Пример использования:

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificate = await client.getCertificate("MyCertificate");
console.log(certificate);

Извлекает сертификат из имени сертификата (включает политику сертификатов).
getCertificateOperation(string, CertificatePollerOptions)

Возвращает операцию создания, связанную с указанным сертификатом. Для этой операции требуется разрешение certificates/get. Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время, пока сертификат не будет полностью восстановлен.

Пример использования:

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

const poller = await client.getCertificateOperation("MyCertificate");
const pendingCertificate = poller.getResult();

const certificateOperation = poller.getOperationState().certificateOperation;
console.log(certificateOperation);

Возвращает операцию опроса сертификата.
getCertificatePolicy(string, OperationOptions)

Операция getCertificatePolicy возвращает указанные ресурсы политики сертификатов в указанном хранилище ключей. Для этой операции требуется разрешение certificates/get.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const policy = await client.getCertificatePolicy("MyCertificate");
console.log(policy);

Возвращает политику сертификата.
getCertificateVersion(string, string, OperationOptions)

Возвращает сведения об определенном сертификате для определенной версии. Политика сертификата не возвращается. Для этой операции требуется разрешение certificates/get.

Пример использования:

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificateWithPolicy = await client.getCertificate("MyCertificate");
const certificate = await client.getCertificateVersion("MyCertificate", certificateWithPolicy.properties.version!);
console.log(certificate);

Извлекает сертификат из имени сертификата и указанной версии.
getContacts(OperationOptions)

Возвращает набор ресурсов контактов сертификата в указанном хранилище ключей. Для этой операции требуется разрешение certificates/managecontacts.

Пример использования:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
const contacts = await client.getContacts();
console.log(contacts);

Задает контакты сертификата.
getDeletedCertificate(string, OperationOptions)

извлекает сведения об удаленном сертификате, а также его атрибуты, такие как интервал хранения, запланированное окончательное удаление и текущий уровень восстановления удаления. Для этой операции требуется разрешение certificates/get.

Пример использования:

const client = new CertificateClient(url, credentials);
const deletedCertificate = await client.getDeletedCertificate("MyDeletedCertificate");
console.log("Deleted certificate:", deletedCertificate);

Возвращает удаленный сертификат.
getIssuer(string, OperationOptions)

Операция getIssuer возвращает указанные ресурсы издателя сертификата в указанном хранилище ключей. Для этой операции требуется разрешение certificates/manageissuers/getissuers.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
const certificateIssuer = await client.getIssuer("IssuerName");
console.log(certificateIssuer);

Возвращает указанного им издателя сертификата.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Импортирует существующий действительный сертификат, содержащий закрытый ключ, в azure Key Vault. Сертификат, который необходимо импортировать, может иметь формат PFX или PEM. Если сертификат находится в формате PEM, PEM-файл должен содержать ключ, а также сертификаты x509. Для этой операции требуются разрешения на сертификаты и импорт.

Пример использования:

const client = new CertificateClient(url, credentials);
// See: @azure/keyvault-secrets
const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;
let buffer: Uint8Array;

if (isNode) {
  buffer = Buffer.from(base64EncodedCertificate, "base64");
} else {
  buffer = Uint8Array.from(atob(base64EncodedCertificate), (c) => c.charCodeAt(0));
}

await client.importCertificate("MyCertificate", buffer);

Импорт сертификата из значения секрета сертификата
listDeletedCertificates(ListDeletedCertificatesOptions)

Извлекает сертификаты в текущем хранилище, которые находятся в удаленном состоянии и готовы к восстановлению или очистке. Эта операция включает сведения, относящиеся к удалению. Для этой операции требуется разрешение certificates,get/list. Эту операцию можно включить только в хранилищах с поддержкой обратимого удаления.

Пример использования:

const client = new CertificateClient(url, credentials);
for await (const deletedCertificate of client.listDeletedCertificates()) {
  console.log(deletedCertificate);
}
for await (const page of client.listDeletedCertificates().byPage()) {
  for (const deletedCertificate of page) {
    console.log(deletedCertificate);
  }
}

Список удаленных сертификатов
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Выполняет итерацию последней версии всех сертификатов в хранилище. Полный идентификатор сертификата и атрибуты приведены в ответе. Для сертификатов значения не возвращаются. Для этой операции требуется разрешение на сертификаты или список.

Пример использования:

const client = new CertificateClient(url, credentials);
// All in one call
for await (const certificateProperties of client.listPropertiesOfCertificates()) {
  console.log(certificateProperties);
}
// By pages
for await (const page of client.listPropertiesOfCertificates().byPage()) {
  for (const certificateProperties of page) {
    console.log(certificateProperties);
  }
}

Вывод списка всех версий указанного сертификата.
listPropertiesOfCertificateVersions(string, OperationOptions)

Возвращает версии сертификата в указанном хранилище ключей. Для этой операции требуется разрешение certificates/list.

Пример использования:

const client = new CertificateClient(url, credentials);
for await (const certificateProperties of client.listPropertiesOfCertificateVersions("MyCertificate")) {
  console.log(certificateProperties.version!);
}

Перечисление версий сертификата.
listPropertiesOfIssuers(OperationOptions)

Возвращает набор ресурсов издателя сертификата в указанном хранилище ключей. Для этой операции требуется разрешение certificates/manageissuers/getissuers.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
// All in one call
for await (const issuerProperties of client.listPropertiesOfIssuers()) {
  console.log(issuerProperties);
}
// By pages
for await (const page of client.listPropertiesOfIssuers().byPage()) {
  for (const issuerProperties of page) {
    console.log(issuerProperties);
  }
}

Вывод списка издателей сертификатов.
mergeCertificate(string, Uint8Array[], OperationOptions)

Выполняет слияние сертификата или цепочки сертификатов с парой ключей, доступной в настоящее время в службе. Эта операция требует наличия разрешения на создание сертификатов.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Unknown",
  subject: "cn=MyCert"
});
const poller = await client.getCertificateOperation("MyCertificate");
const { csr } = poller.getOperationState().certificateOperation!;
const base64Csr = Buffer.from(csr!).toString("base64");
const wrappedCsr = ["-----BEGIN CERTIFICATE REQUEST-----", base64Csr, "-----END CERTIFICATE REQUEST-----"].join("\n");

const fs = require("fs");
fs.writeFileSync("test.csr", wrappedCsr);

// Certificate available locally made using:
//   openssl genrsa -out ca.key 2048
//   openssl req -new -x509 -key ca.key -out ca.crt
// You can read more about how to create a fake certificate authority here: https://gist.github.com/Soarez/9688998

const childProcess = require("child_process");
childProcess.execSync("openssl x509 -req -in test.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out test.crt");
const base64Crt = fs.readFileSync("test.crt").toString().split("\n").slice(1, -1).join("");

await client.mergeCertificate("MyCertificate", [Buffer.from(base64Crt)]);

Объединяет подписанный запрос сертификата в ожидающий сертификат
purgeDeletedCertificate(string, OperationOptions)

Выполняет необратимое удаление указанного сертификата без возможности восстановления. Операция недоступна, если на уровне восстановления не указано "Purgeable". Для этой операции требуется сертификат или разрешение на очистку.

Пример использования:

const client = new CertificateClient(url, credentials);
const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();
// Deleting a certificate takes time, make sure to wait before purging it
client.purgeDeletedCertificate("MyCertificate");

Возвращает удаленный сертификат.
restoreCertificateBackup(Uint8Array, OperationOptions)

Восстанавливает сертификат с резервной копией и все его версии в хранилище. Для этой операции требуется разрешение certificates/restore.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");
const poller = await client.beginDeleteCertificate("MyCertificate");
await poller.pollUntilDone();
// Some time is required before we're able to restore the certificate
await client.restoreCertificateBackup(backup!);

Восстановление сертификата из резервной копии
setContacts(CertificateContact[], OperationOptions)

Задает контакты сертификата для хранилища ключей. Для этой операции требуется разрешение certificates/managecontacts.

Пример использования:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);

Задает контакты сертификата.
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Обновления политику сертификатов для указанного сертификата. Для этой операции требуется разрешение на получение сертификатов или обновление. Возвращает политику сертификата.
updateCertificateProperties(string, string, UpdateCertificateOptions)

Применяет указанное обновление к заданному сертификату; Единственными обновленными элементами являются атрибуты сертификата. Для этой операции требуется разрешение на получение сертификатов или обновление.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

// You may pass an empty string for version which will update
// the latest version of the certificate
await client.updateCertificateProperties("MyCertificate", "", {
  tags: {
    customTag: "value"
  }
});

Обновления сертификата
updateIssuer(string, UpdateIssuerOptions)

Операция updateIssuer выполняет обновление указанной сущности издателя сертификата. Для этой операции требуется разрешение certificates/setissuers.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
await client.updateIssuer("IssuerName", {
  provider: "Provider2"
});

Обновления указанного издателя сертификата.

Сведения о конструкторе

CertificateClient(string, TokenCredential, CertificateClientOptions)

Создает экземпляр CertificateClient.

new CertificateClient(vaultUrl: string, credential: TokenCredential, clientOptions?: CertificateClientOptions)

Параметры

vaultUrl

string

базовый URL-адрес хранилища. Убедитесь, что этот URL-адрес ссылается на допустимый ресурс Key Vault. Дополнительные сведения см. в разделе https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Объект , реализующий интерфейс, используемый TokenCredential для проверки подлинности запросов к службе. @azure/identity Используйте пакет для создания учетных данных, которые соответствуют вашим потребностям.

clientOptions
CertificateClientOptions

Параметры конвейера, используемые для настройки Key Vault запросов API. Пропустите этот параметр, чтобы использовать конфигурацию конвейера по умолчанию.

Сведения о свойстве

vaultUrl

Базовый URL-адрес хранилища

vaultUrl: string

Значение свойства

string

Сведения о методе

backupCertificate(string, OperationOptions)

Запрашивает скачивание на клиент резервной копии указанного сертификата. Будут загружены все версии сертификата. Для этой операции требуется разрешение на создание сертификатов или резервное копирование.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");

Создает резервную копию сертификата.

function backupCertificate(certificateName: string, options?: OperationOptions): Promise<undefined | Uint8Array>

Параметры

certificateName

string

Имя сертификата

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<undefined | Uint8Array>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Создание нового сертификата. Если это первая версия, создается ресурс сертификата. Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время, пока сертификат не будет полностью восстановлен.

Примечание: При отправке SelfissuerName в качестве политики сертификата будет создан самозаверяющий сертификат.

Эта операция требует наличия разрешения на создание сертификатов.

Пример использования:

const client = new CertificateClient(url, credentials);
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert"
};
const createPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy);

// The pending certificate can be obtained by calling the following method:
const pendingCertificate = createPoller.getResult();

// Serializing the poller
const serialized = createPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy, { resumeFrom: serialized });

// Waiting until it's done
const certificate = await createPoller.pollUntilDone();
console.log(certificate);

Создает сертификат

function beginCreateCertificate(certificateName: string, policy: CertificatePolicy, options?: BeginCreateCertificateOptions): Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

Параметры

certificateName

string

Имя сертификата

policy
CertificatePolicy
options
BeginCreateCertificateOptions

Необязательные параметры

Возвращаемое значение

Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, CertificatePollerOptions)

Операция DELETE применяется к любому сертификату, хранящейся в azure Key Vault. Delete нельзя применить к отдельной версии сертификата. Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время, пока сертификат не будет полностью восстановлен.

Для этой операции требуется разрешение certificates/delete.

Пример использования:

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await createPoller.pollUntilDone();

const deletePoller = await client.beginDeleteCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const deletedCertificate = await deletePoller.pollUntilDone();
console.log(deletedCertificate);

Удаляет сертификат из указанного хранилища ключей.

function beginDeleteCertificate(certificateName: string, options?: CertificatePollerOptions): Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

Параметры

certificateName

string

Имя сертификата.

options
CertificatePollerOptions

Необязательные параметры

Возвращаемое значение

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Восстанавливает удаленный сертификат в указанном хранилище. Эту операцию можно выполнить только в хранилище с поддержкой обратимого удаления. Эта операция Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время, пока сертификат не будет полностью восстановлен.

Для этой операции требуется разрешение certificates/recover.

Пример использования:

const client = new CertificateClient(url, credentials);

const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const certificate = await recoverPoller.pollUntilDone();
console.log(certificate);

Восстановление удаленного сертификата

function beginRecoverDeletedCertificate(certificateName: string, options?: CertificatePollerOptions): Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

Параметры

certificateName

string

Имя удаленного сертификата

options
CertificatePollerOptions

Необязательные параметры

Возвращаемое значение

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

Операция createIssuer добавляет или обновляет указанного издателя сертификата. Для этой операции требуется разрешение certificates/setissuers.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");

Задает указанного издателя сертификата.

function createIssuer(issuerName: string, provider: string, options?: CreateIssuerOptions): Promise<CertificateIssuer>

Параметры

issuerName

string

Имя поставщика.

provider

string

Поставщик издателя.

options
CreateIssuerOptions

Необязательные параметры

Возвращаемое значение

Promise<CertificateIssuer>

deleteCertificateOperation(string, OperationOptions)

Удаляет операцию создания для указанного сертификата, который находится в процессе создания. Сертификат больше не создается. Для этой операции требуется разрешение на получение сертификатов или обновление.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await client.deleteCertificateOperation("MyCertificate");
await client.getCertificateOperation("MyCertificate"); // Throws error: Pending certificate not found: "MyCertificate"

Удаление операции сертификата

function deleteCertificateOperation(certificateName: string, options?: OperationOptions): Promise<CertificateOperation>

Параметры

certificateName

string

Имя сертификата

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<CertificateOperation>

deleteContacts(OperationOptions)

Удаляет все контакты сертификата. Для этой операции требуется разрешение certificates/managecontacts.

Пример использования:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
await client.deleteContacts();

Удаляет все контакты сертификата.

function deleteContacts(options?: OperationOptions): Promise<undefined | CertificateContact[]>

Параметры

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

Операция deleteIssuer окончательно удаляет указанного издателя сертификата из хранилища. Для этой операции требуется разрешение certificates/manageissuers/deleteissuers.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Provider");
await client.deleteIssuer("IssuerName");

Удаляет указанного издателя сертификата.

function deleteIssuer(issuerName: string, options?: OperationOptions): Promise<CertificateIssuer>

Параметры

issuerName

string

Имя поставщика.

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

Возвращает последние сведения, доступные из определенного сертификата, включая политику сертификата. Для этой операции требуется разрешение certificates/get.

Пример использования:

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificate = await client.getCertificate("MyCertificate");
console.log(certificate);

Извлекает сертификат из имени сертификата (включает политику сертификатов).

function getCertificate(certificateName: string, options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>

Параметры

certificateName

string

Имя сертификата

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

Возвращает операцию создания, связанную с указанным сертификатом. Для этой операции требуется разрешение certificates/get. Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время, пока сертификат не будет полностью восстановлен.

Пример использования:

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

const poller = await client.getCertificateOperation("MyCertificate");
const pendingCertificate = poller.getResult();

const certificateOperation = poller.getOperationState().certificateOperation;
console.log(certificateOperation);

Возвращает операцию опроса сертификата.

function getCertificateOperation(certificateName: string, options?: CertificatePollerOptions): Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

Параметры

certificateName

string

Имя сертификата

options
CertificatePollerOptions

Необязательные параметры

Возвращаемое значение

Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, OperationOptions)

Операция getCertificatePolicy возвращает указанные ресурсы политики сертификатов в указанном хранилище ключей. Для этой операции требуется разрешение certificates/get.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const policy = await client.getCertificatePolicy("MyCertificate");
console.log(policy);

Возвращает политику сертификата.

function getCertificatePolicy(certificateName: string, options?: OperationOptions): Promise<CertificatePolicy>

Параметры

certificateName

string

Имя сертификата

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<CertificatePolicy>

getCertificateVersion(string, string, OperationOptions)

Возвращает сведения об определенном сертификате для определенной версии. Политика сертификата не возвращается. Для этой операции требуется разрешение certificates/get.

Пример использования:

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificateWithPolicy = await client.getCertificate("MyCertificate");
const certificate = await client.getCertificateVersion("MyCertificate", certificateWithPolicy.properties.version!);
console.log(certificate);

Извлекает сертификат из имени сертификата и указанной версии.

function getCertificateVersion(certificateName: string, version: string, options?: OperationOptions): Promise<KeyVaultCertificate>

Параметры

certificateName

string

Имя сертификата

version

string

Конкретная версия сертификата

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

Возвращает набор ресурсов контактов сертификата в указанном хранилище ключей. Для этой операции требуется разрешение certificates/managecontacts.

Пример использования:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
const contacts = await client.getContacts();
console.log(contacts);

Задает контакты сертификата.

function getContacts(options?: OperationOptions): Promise<undefined | CertificateContact[]>

Параметры

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

извлекает сведения об удаленном сертификате, а также его атрибуты, такие как интервал хранения, запланированное окончательное удаление и текущий уровень восстановления удаления. Для этой операции требуется разрешение certificates/get.

Пример использования:

const client = new CertificateClient(url, credentials);
const deletedCertificate = await client.getDeletedCertificate("MyDeletedCertificate");
console.log("Deleted certificate:", deletedCertificate);

Возвращает удаленный сертификат.

function getDeletedCertificate(certificateName: string, options?: OperationOptions): Promise<DeletedCertificate>

Параметры

certificateName

string

Имя сертификата

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<DeletedCertificate>

getIssuer(string, OperationOptions)

Операция getIssuer возвращает указанные ресурсы издателя сертификата в указанном хранилище ключей. Для этой операции требуется разрешение certificates/manageissuers/getissuers.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
const certificateIssuer = await client.getIssuer("IssuerName");
console.log(certificateIssuer);

Возвращает указанного им издателя сертификата.

function getIssuer(issuerName: string, options?: OperationOptions): Promise<CertificateIssuer>

Параметры

issuerName

string

Имя поставщика.

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Импортирует существующий действительный сертификат, содержащий закрытый ключ, в azure Key Vault. Сертификат, который необходимо импортировать, может иметь формат PFX или PEM. Если сертификат находится в формате PEM, PEM-файл должен содержать ключ, а также сертификаты x509. Для этой операции требуются разрешения на сертификаты и импорт.

Пример использования:

const client = new CertificateClient(url, credentials);
// See: @azure/keyvault-secrets
const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;
let buffer: Uint8Array;

if (isNode) {
  buffer = Buffer.from(base64EncodedCertificate, "base64");
} else {
  buffer = Uint8Array.from(atob(base64EncodedCertificate), (c) => c.charCodeAt(0));
}

await client.importCertificate("MyCertificate", buffer);

Импорт сертификата из значения секрета сертификата

function importCertificate(certificateName: string, certificateBytes: Uint8Array, options?: ImportCertificateOptions): Promise<KeyVaultCertificateWithPolicy>

Параметры

certificateName

string

Имя сертификата

certificateBytes

Uint8Array

Значение сертификата в формате PFX или ASCII PEM, содержащее сертификаты X.509 и закрытый ключ.

options
ImportCertificateOptions

Необязательные параметры

Возвращаемое значение

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Извлекает сертификаты в текущем хранилище, которые находятся в удаленном состоянии и готовы к восстановлению или очистке. Эта операция включает сведения, относящиеся к удалению. Для этой операции требуется разрешение certificates,get/list. Эту операцию можно включить только в хранилищах с поддержкой обратимого удаления.

Пример использования:

const client = new CertificateClient(url, credentials);
for await (const deletedCertificate of client.listDeletedCertificates()) {
  console.log(deletedCertificate);
}
for await (const page of client.listDeletedCertificates().byPage()) {
  for (const deletedCertificate of page) {
    console.log(deletedCertificate);
  }
}

Список удаленных сертификатов

function listDeletedCertificates(options?: ListDeletedCertificatesOptions): PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

Параметры

options
ListDeletedCertificatesOptions

Необязательные параметры

Возвращаемое значение

PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Выполняет итерацию последней версии всех сертификатов в хранилище. Полный идентификатор сертификата и атрибуты приведены в ответе. Для сертификатов значения не возвращаются. Для этой операции требуется разрешение на сертификаты или список.

Пример использования:

const client = new CertificateClient(url, credentials);
// All in one call
for await (const certificateProperties of client.listPropertiesOfCertificates()) {
  console.log(certificateProperties);
}
// By pages
for await (const page of client.listPropertiesOfCertificates().byPage()) {
  for (const certificateProperties of page) {
    console.log(certificateProperties);
  }
}

Вывод списка всех версий указанного сертификата.

function listPropertiesOfCertificates(options?: ListPropertiesOfCertificatesOptions): PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

Параметры

options
ListPropertiesOfCertificatesOptions

Необязательные параметры

Возвращаемое значение

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfCertificateVersions(string, OperationOptions)

Возвращает версии сертификата в указанном хранилище ключей. Для этой операции требуется разрешение certificates/list.

Пример использования:

const client = new CertificateClient(url, credentials);
for await (const certificateProperties of client.listPropertiesOfCertificateVersions("MyCertificate")) {
  console.log(certificateProperties.version!);
}

Перечисление версий сертификата.

function listPropertiesOfCertificateVersions(certificateName: string, options?: OperationOptions): PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

Параметры

certificateName

string

Имя сертификата.

options
OperationOptions

Необязательные параметры

Возвращаемое значение

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfIssuers(OperationOptions)

Возвращает набор ресурсов издателя сертификата в указанном хранилище ключей. Для этой операции требуется разрешение certificates/manageissuers/getissuers.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
// All in one call
for await (const issuerProperties of client.listPropertiesOfIssuers()) {
  console.log(issuerProperties);
}
// By pages
for await (const page of client.listPropertiesOfIssuers().byPage()) {
  for (const issuerProperties of page) {
    console.log(issuerProperties);
  }
}

Вывод списка издателей сертификатов.

function listPropertiesOfIssuers(options?: OperationOptions): PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

Параметры

options
OperationOptions

Необязательные параметры

Возвращаемое значение

PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

mergeCertificate(string, Uint8Array[], OperationOptions)

Выполняет слияние сертификата или цепочки сертификатов с парой ключей, доступной в настоящее время в службе. Эта операция требует наличия разрешения на создание сертификатов.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Unknown",
  subject: "cn=MyCert"
});
const poller = await client.getCertificateOperation("MyCertificate");
const { csr } = poller.getOperationState().certificateOperation!;
const base64Csr = Buffer.from(csr!).toString("base64");
const wrappedCsr = ["-----BEGIN CERTIFICATE REQUEST-----", base64Csr, "-----END CERTIFICATE REQUEST-----"].join("\n");

const fs = require("fs");
fs.writeFileSync("test.csr", wrappedCsr);

// Certificate available locally made using:
//   openssl genrsa -out ca.key 2048
//   openssl req -new -x509 -key ca.key -out ca.crt
// You can read more about how to create a fake certificate authority here: https://gist.github.com/Soarez/9688998

const childProcess = require("child_process");
childProcess.execSync("openssl x509 -req -in test.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out test.crt");
const base64Crt = fs.readFileSync("test.crt").toString().split("\n").slice(1, -1).join("");

await client.mergeCertificate("MyCertificate", [Buffer.from(base64Crt)]);

Объединяет подписанный запрос сертификата в ожидающий сертификат

function mergeCertificate(certificateName: string, x509Certificates: Uint8Array[], options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>

Параметры

certificateName

string

Имя сертификата

x509Certificates

Uint8Array[]

Сертификаты для объединения

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, OperationOptions)

Выполняет необратимое удаление указанного сертификата без возможности восстановления. Операция недоступна, если на уровне восстановления не указано "Purgeable". Для этой операции требуется сертификат или разрешение на очистку.

Пример использования:

const client = new CertificateClient(url, credentials);
const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();
// Deleting a certificate takes time, make sure to wait before purging it
client.purgeDeletedCertificate("MyCertificate");

Возвращает удаленный сертификат.

function purgeDeletedCertificate(certificateName: string, options?: OperationOptions): Promise<null>

Параметры

certificateName

string

Имя удаленного сертификата для очистки

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<null>

restoreCertificateBackup(Uint8Array, OperationOptions)

Восстанавливает сертификат с резервной копией и все его версии в хранилище. Для этой операции требуется разрешение certificates/restore.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");
const poller = await client.beginDeleteCertificate("MyCertificate");
await poller.pollUntilDone();
// Some time is required before we're able to restore the certificate
await client.restoreCertificateBackup(backup!);

Восстановление сертификата из резервной копии

function restoreCertificateBackup(backup: Uint8Array, options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>

Параметры

backup

Uint8Array

Сертификат резервной копии для восстановления

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], OperationOptions)

Задает контакты сертификата для хранилища ключей. Для этой операции требуется разрешение certificates/managecontacts.

Пример использования:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);

Задает контакты сертификата.

function setContacts(contacts: CertificateContact[], options?: OperationOptions): Promise<undefined | CertificateContact[]>

Параметры

contacts

CertificateContact[]

Используемые контакты

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<undefined | CertificateContact[]>

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Обновления политику сертификатов для указанного сертификата. Для этой операции требуется разрешение на получение сертификатов или обновление. Возвращает политику сертификата.

function updateCertificatePolicy(certificateName: string, policy: CertificatePolicy, options?: OperationOptions): Promise<CertificatePolicy>

Параметры

certificateName

string

Имя сертификата

policy
CertificatePolicy

Политика сертификатов

options
OperationOptions

Необязательные параметры

Возвращаемое значение

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificateOptions)

Применяет указанное обновление к заданному сертификату; Единственными обновленными элементами являются атрибуты сертификата. Для этой операции требуется разрешение на получение сертификатов или обновление.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

// You may pass an empty string for version which will update
// the latest version of the certificate
await client.updateCertificateProperties("MyCertificate", "", {
  tags: {
    customTag: "value"
  }
});

Обновления сертификата

function updateCertificateProperties(certificateName: string, version: string, options?: UpdateCertificateOptions): Promise<KeyVaultCertificate>

Параметры

certificateName

string

Имя сертификата

version

string

Версия обновляемого сертификата (пустая строка обновит последнюю версию)

options
UpdateCertificateOptions

Параметры, в том числе сведения об обновлении

Возвращаемое значение

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

Операция updateIssuer выполняет обновление указанной сущности издателя сертификата. Для этой операции требуется разрешение certificates/setissuers.

Пример использования:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
await client.updateIssuer("IssuerName", {
  provider: "Provider2"
});

Обновления указанного издателя сертификата.

function updateIssuer(issuerName: string, options?: UpdateIssuerOptions): Promise<CertificateIssuer>

Параметры

issuerName

string

Имя поставщика.

options
UpdateIssuerOptions

Необязательные параметры

Возвращаемое значение

Promise<CertificateIssuer>