Поделиться через

CertificateClient class

Пакет:
@azure/keyvault-certificates

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

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

CertificateClient(string, TokenCredential, CertificateClientOptions)

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

Свойства

vaultUrl

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

Методы

backupCertificate(string, OperationOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

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

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

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert",
};

const poller = await client.beginCreateCertificate(certificateName, certificatePolicy);

// You can use the pending certificate immediately:
const pendingCertificate = poller.getResult();

// Or you can wait until the certificate finishes being signed:
const keyVaultCertificate = await poller.pollUntilDone();
console.log(keyVaultCertificate);

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

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const certificateName = "MyCertificate";

const poller = await client.beginDeleteCertificate(certificateName);

// You can use the deleted certificate immediately:
const deletedCertificate = poller.getResult();

// The certificate is being deleted. Only wait for it if you want to restore it or purge it.
await poller.pollUntilDone();

// You can also get the deleted certificate this way:
await client.getDeletedCertificate(certificateName);

// Deleted certificates can also be recovered or purged.

// recoverDeletedCertificate returns a poller, just like beginDeleteCertificate.
// const recoverPoller = await client.beginRecoverDeletedCertificate(certificateName);
// await recoverPoller.pollUntilDone();

// If a certificate is done and the Key Vault has soft-delete enabled, the certificate can be purged with:
await client.purgeDeletedCertificate(certificateName);

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

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

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

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

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.createIssuer("IssuerName", "Test");

Задает указанный издатель сертификата.
deleteCertificateOperation(string, OperationOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert",
});
await client.deleteCertificateOperation("MyCertificate");

await client.getCertificateOperation("MyCertificate");

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.deleteContacts();

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.deleteIssuer("IssuerName");

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const certificateName = "MyCertificate";

const result = await client.getCertificate(certificateName);
console.log(result.name);

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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 возвращает указанные ресурсы политики сертификатов в указанном хранилище ключей. Для этой операции требуется разрешение на сертификаты или получение.

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const policy = await client.getCertificatePolicy("MyCertificate");
console.log(policy);

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";

const latestCertificate = await client.getCertificate(certificateName);
console.log(`Latest version of the certificate ${certificateName}: `, latestCertificate);
const specificCertificate = await client.getCertificateVersion(
  certificateName,
  latestCertificate.properties.version,
);
console.log(
  `The certificate ${certificateName} at the version ${latestCertificate.properties.version}: `,
  specificCertificate,
);

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const contacts = await client.getContacts();
for (const contact of contacts) {
  console.log(contact);
}

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const certificateIssuer = await client.getIssuer("IssuerName");
console.log(certificateIssuer);

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
import { SecretClient } from "@azure/keyvault-secrets";
import { isNodeLike } from "@azure/core-util";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);
const secretClient = new SecretClient(url, credential);

const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;

const buffer = isNodeLike
  ? Buffer.from(base64EncodedCertificate, "base64")
  : Uint8Array.from(atob(base64EncodedCertificate), (c) => c.charCodeAt(0));
await client.importCertificate("MyCertificate", buffer);

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

// 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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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

Вывод списка версий сертификата.
listPropertiesOfIssuers(OperationOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
import { writeFileSync, readFileSync } from "node:fs";
import { execSync } from "node:child_process";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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");

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

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

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

Слияние подписанного запроса сертификата в ожидающий сертификат
purgeDeletedCertificate(string, OperationOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.setContacts([
  {
    email: "b@b.com",
    name: "b",
    phone: "222222222222",
  },
]);

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

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

// 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 выполняет обновление для указанной сущности издателя сертификатов. Для этой операции требуется разрешение сертификатов или наборов.

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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

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

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

vaultUrl

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

vaultUrl: string

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

string

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

backupCertificate(string, OperationOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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)

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

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert",
};

const poller = await client.beginCreateCertificate(certificateName, certificatePolicy);

// You can use the pending certificate immediately:
const pendingCertificate = poller.getResult();

// Or you can wait until the certificate finishes being signed:
const keyVaultCertificate = await poller.pollUntilDone();
console.log(keyVaultCertificate);

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

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 нельзя применить к отдельной версии сертификата. Эта функция возвращает опрашиватель операций длительного выполнения, который позволяет ждать неограниченное время, пока сертификат не будет полностью восстановлен.

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const certificateName = "MyCertificate";

const poller = await client.beginDeleteCertificate(certificateName);

// You can use the deleted certificate immediately:
const deletedCertificate = poller.getResult();

// The certificate is being deleted. Only wait for it if you want to restore it or purge it.
await poller.pollUntilDone();

// You can also get the deleted certificate this way:
await client.getDeletedCertificate(certificateName);

// Deleted certificates can also be recovered or purged.

// recoverDeletedCertificate returns a poller, just like beginDeleteCertificate.
// const recoverPoller = await client.beginRecoverDeletedCertificate(certificateName);
// await recoverPoller.pollUntilDone();

// If a certificate is done and the Key Vault has soft-delete enabled, the certificate can be purged with:
await client.purgeDeletedCertificate(certificateName);

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

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

Параметры

certificateName

string

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

options
CertificatePollerOptions

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

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

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

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

// 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 добавляет или обновляет указанный издатель сертификата. Для этой операции требуется разрешение сертификатов или наборов.

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert",
});
await client.deleteCertificateOperation("MyCertificate");

await client.getCertificateOperation("MyCertificate");

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

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

Параметры

certificateName

string

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

options
OperationOptions

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

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

Promise<CertificateOperation>

deleteContacts(OperationOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.deleteContacts();

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

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

Параметры

options
OperationOptions

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

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

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.deleteIssuer("IssuerName");

Удаляет указанный издатель сертификата.

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

Параметры

issuerName

string

Имя издателя.

options
OperationOptions

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

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

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const certificateName = "MyCertificate";

const result = await client.getCertificate(certificateName);
console.log(result.name);

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

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

Параметры

certificateName

string

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

options
OperationOptions

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

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

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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 возвращает указанные ресурсы политики сертификатов в указанном хранилище ключей. Для этой операции требуется разрешение на сертификаты или получение.

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";

const latestCertificate = await client.getCertificate(certificateName);
console.log(`Latest version of the certificate ${certificateName}: `, latestCertificate);
const specificCertificate = await client.getCertificateVersion(
  certificateName,
  latestCertificate.properties.version,
);
console.log(
  `The certificate ${certificateName} at the version ${latestCertificate.properties.version}: `,
  specificCertificate,
);

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

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

Параметры

certificateName

string

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

version

string

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

options
OperationOptions

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

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

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const contacts = await client.getContacts();
for (const contact of contacts) {
  console.log(contact);
}

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

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

Параметры

options
OperationOptions

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

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

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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.

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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. Для этой операции требуется разрешение на сертификаты или импорт.

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
import { SecretClient } from "@azure/keyvault-secrets";
import { isNodeLike } from "@azure/core-util";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);
const secretClient = new SecretClient(url, credential);

const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;

const buffer = isNodeLike
  ? Buffer.from(base64EncodedCertificate, "base64")
  : 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. Эта операция может быть включена только в хранилищах с поддержкой обратимого удаления.

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

// 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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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.

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
import { writeFileSync, readFileSync } from "node:fs";
import { execSync } from "node:child_process";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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");

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

execSync("openssl x509 -req -in test.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out test.crt");
const base64Crt = 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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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, UpdateCertificatePropertiesOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

// 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?: UpdateCertificatePropertiesOptions): Promise<KeyVaultCertificate>

Параметры

certificateName

string

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

version

string

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

options
UpdateCertificateOptions

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

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

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.updateIssuer("IssuerName", {
  provider: "Provider2",
});

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

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

Параметры

issuerName

string

Имя издателя.

options
UpdateIssuerOptions

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

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

Promise<CertificateIssuer>