Sdílet prostřednictvím

CertificateClient class

Balíček:
@azure/keyvault-certificates

Klient pro interakci s funkcemi certifikátů služby KeyVault

Konstruktory

CertificateClient(string, TokenCredential, CertificateClientOptions)

Vytvoří instanci CertificateClient.

Vlastnosti

vaultUrl

Základní adresa URL trezoru

Metody

backupCertificate(string, OperationOptions)

Požaduje, aby se do klienta stáhla záloha zadaného certifikátu. Stáhnou se všechny verze certifikátu. Tato operace vyžaduje oprávnění k certifikátům nebo zálohování.

Příklad použití:

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

Vygeneruje zálohu certifikátu.
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Vytvoří nový certifikát. Pokud se jedná o první verzi, vytvoří se prostředek certifikátu. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se certifikát plně neobnoví.

Poznámka: Odeslání Self jako issuerName zásad certifikátu vytvoří certifikát podepsaný svým držitelem.

Tato operace vyžaduje oprávnění k certifikátům nebo vytvoření.

Příklad použití:

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

Vytvoří certifikát.
beginDeleteCertificate(string, CertificatePollerOptions)

Operace DELETE se vztahuje na všechny certifikáty uložené ve službě Azure Key Vault. Delete nelze použít pro jednotlivé verze certifikátu. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se certifikát plně neobnoví.

Tato operace vyžaduje oprávnění k certifikátům nebo odstranění.

Příklad použití:

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

Odstraní certifikát ze zadaného trezoru klíčů.
beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Obnoví odstraněný certifikát v zadaném trezoru. Tuto operaci lze provést pouze v trezoru s povoleným obnovitelném odstraněním. Tato operace vrátí dlouho běžící operaci poller, která umožňuje čekat na neomezenou dobu, dokud se certifikát plně neobnoví.

Tato operace vyžaduje oprávnění k certifikátům nebo obnovení.

Příklad použití:

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

Obnoví odstraněný certifikát.
createIssuer(string, string, CreateIssuerOptions)

Operace createIssuer přidá nebo aktualizuje zadaného vystavitele certifikátu. Tato operace vyžaduje oprávnění certifikátů/setissuers.

Příklad použití:

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

Nastaví zadaného vystavitele certifikátu.
deleteCertificateOperation(string, OperationOptions)

Odstraní operaci vytvoření pro zadaný certifikát, který se právě vytváří. Certifikát se už nevytvořil. Tato operace vyžaduje oprávnění k certifikátům nebo aktualizaci.

Příklad použití:

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

Odstranění operace certifikátu
deleteContacts(OperationOptions)

Odstraní všechny kontakty certifikátu. Tato operace vyžaduje oprávnění certifikátů/managecontacts.

Příklad použití:

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

Odstraní všechny kontakty certifikátu.
deleteIssuer(string, OperationOptions)

Operace deleteIssuer trvale odebere zadaného vystavitele certifikátu z trezoru. Tato operace vyžaduje oprávnění certifikátů/manageissuers/deleteisuers.

Příklad použití:

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

Odstraní zadaného vystavitele certifikátu.
getCertificate(string, OperationOptions)

Získá nejnovější informace dostupné z konkrétního certifikátu, včetně zásad certifikátu. Tato operace vyžaduje certifikáty nebo získat oprávnění.

Příklad použití:

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

Načte certifikát z názvu certifikátu (včetně zásad certifikátu).
getCertificateOperation(string, CertificatePollerOptions)

Získá operaci vytvoření přidruženou k zadanému certifikátu. Tato operace vyžaduje certifikáty nebo získat oprávnění. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se certifikát plně neobnoví.

Příklad použití:

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

Získá operaci poller certifikátu.
getCertificatePolicy(string, OperationOptions)

Operace getCertificatePolicy vrátí zadané prostředky zásad certifikátu v zadaném trezoru klíčů. Tato operace vyžaduje certifikáty nebo získat oprávnění.

Příklad použití:

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

Získá zásadu certifikátu.
getCertificateVersion(string, string, OperationOptions)

Získá informace o určitém certifikátu pro konkrétní verzi. Zásady certifikátu se nevrátí. Tato operace vyžaduje certifikáty nebo získat oprávnění.

Příklad použití:

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

Načte certifikát z názvu certifikátu a zadané verze.
getContacts(OperationOptions)

Vrátí sadu prostředků kontaktů certifikátu v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění certifikátů/managecontacts.

Příklad použití:

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

Nastaví kontakty certifikátu.
getDeletedCertificate(string, OperationOptions)

načte informace o odstraněném certifikátu a jeho atributy, jako je interval uchovávání, plánované trvalé odstranění a aktuální úroveň obnovení odstranění. Tato operace vyžaduje certifikáty nebo získat oprávnění.

Příklad použití:

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

Získá odstraněný certifikát.
getIssuer(string, OperationOptions)

Operace getIssuer vrátí zadané prostředky vystavitele certifikátu v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění certifikátů/manageissuers/getisuers.

Příklad použití:

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

Získá zadaného vystavitele certifikátu.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Importuje existující platný certifikát obsahující privátní klíč do služby Azure Key Vault. Certifikát, který se má importovat, může být ve formátu PFX nebo PEM. Pokud je certifikát ve formátu PEM, musí soubor PEM obsahovat klíč i certifikáty x509. Tato operace vyžaduje oprávnění k certifikátům nebo importu.

Příklad použití:

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

Importuje certifikát z hodnoty tajného kódu certifikátu.
listDeletedCertificates(ListDeletedCertificatesOptions)

Načte certifikáty v aktuálním trezoru, které jsou ve stavu odstranění a jsou připravené k obnovení nebo vymazání. Tato operace zahrnuje informace specifické pro odstranění. Tato operace vyžaduje oprávnění k certifikátům, získání nebo výpisu. Tuto operaci je možné povolit pouze u trezorů s povoleným obnovitelném odstraněním.

Příklad použití:

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

Seznam odstraněných certifikátů
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Iteruje nejnovější verzi všech certifikátů v trezoru. Úplný identifikátor certifikátu a atributy jsou k dispozici v odpovědi. Pro certifikáty se nevrácejí žádné hodnoty. Tyto operace vyžadují oprávnění k certifikátům nebo seznamům.

Příklad použití:

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

Zobrazí seznam všech verzí zadaného certifikátu.
listPropertiesOfCertificateVersions(string, OperationOptions)

Vrátí verze certifikátu v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění k certifikátům nebo seznamům.

Příklad použití:

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!);
}

Výpis verzí certifikátu
listPropertiesOfIssuers(OperationOptions)

Vrátí sadu prostředků vystavitele certifikátů v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění certifikátů/manageissuers/getisuers.

Příklad použití:

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

Vypíše vystavitele certifikátů.
mergeCertificate(string, Uint8Array[], OperationOptions)

Provede sloučení certifikátu nebo řetězu certifikátů s párem klíčů, který je aktuálně ve službě dostupný. Tato operace vyžaduje oprávnění k certifikátům nebo vytvoření.

Příklad použití:

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

Sloučí žádost o podepsaný certifikát do čekajícího certifikátu.
purgeDeletedCertificate(string, OperationOptions)

Provede nevratné odstranění zadaného certifikátu bez možnosti obnovení. Operace není k dispozici, pokud úroveň obnovení nezadá hodnotu Vyprázdnit. Tato operace vyžaduje oprávnění k vyprázdnění certifikátu.

Příklad použití:

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

Získá odstraněný certifikát.
restoreCertificateBackup(Uint8Array, OperationOptions)

Obnoví zálohovaný certifikát a všechny jeho verze do trezoru. Tato operace vyžaduje oprávnění k certifikátům nebo obnovení.

Příklad použití:

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

Obnoví certifikát ze zálohy.
setContacts(CertificateContact[], OperationOptions)

Nastaví kontakty certifikátu pro trezor klíčů. Tato operace vyžaduje oprávnění certifikátů/managecontacts.

Příklad použití:

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",
  },
]);

Nastaví kontakty certifikátu.
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Aktualizuje zásady certifikátu pro zadaný certifikát. Tato operace vyžaduje oprávnění k certifikátům nebo aktualizaci. Získá zásadu certifikátu.
updateCertificateProperties(string, string, UpdateCertificatePropertiesOptions)

Použije zadanou aktualizaci pro daný certifikát; jedinými aktualizovanými prvky jsou atributy certifikátu. Tato operace vyžaduje oprávnění k certifikátům nebo aktualizaci.

Příklad použití:

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

Aktualizuje certifikát.
updateIssuer(string, UpdateIssuerOptions)

Operace updateIssuer provede aktualizaci u zadané entity vystavitele certifikátu. Tato operace vyžaduje oprávnění certifikátů/setissuers.

Příklad použití:

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

Aktualizuje zadaného vystavitele certifikátu.

Podrobnosti konstruktoru

CertificateClient(string, TokenCredential, CertificateClientOptions)

Vytvoří instanci CertificateClient.

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

Parametry

vaultUrl

string

základní adresu URL trezoru. Měli byste ověřit, že tato adresa URL odkazuje na platný prostředek služby Key Vault. Podrobnosti najdete v https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Objekt, který implementuje rozhraní TokenCredential použité k ověřování požadavků na službu. Pomocí balíčku @azure/identity vytvořte přihlašovací údaje, které vyhovují vašim potřebám.

clientOptions
CertificateClientOptions

Možnosti kanálu používané ke konfiguraci požadavků rozhraní API služby Key Vault Tento parametr vynecháte, pokud chcete použít výchozí konfiguraci kanálu.

Podrobnosti vlastnosti

vaultUrl

Základní adresa URL trezoru

vaultUrl: string

Hodnota vlastnosti

string

Podrobnosti metody

backupCertificate(string, OperationOptions)

Požaduje, aby se do klienta stáhla záloha zadaného certifikátu. Stáhnou se všechny verze certifikátu. Tato operace vyžaduje oprávnění k certifikátům nebo zálohování.

Příklad použití:

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

Vygeneruje zálohu certifikátu.

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

Parametry

certificateName

string

Název certifikátu

options
OperationOptions

Volitelné parametry

Návraty

Promise<undefined | Uint8Array>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Vytvoří nový certifikát. Pokud se jedná o první verzi, vytvoří se prostředek certifikátu. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se certifikát plně neobnoví.

Poznámka: Odeslání Self jako issuerName zásad certifikátu vytvoří certifikát podepsaný svým držitelem.

Tato operace vyžaduje oprávnění k certifikátům nebo vytvoření.

Příklad použití:

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

Vytvoří certifikát.

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

Parametry

certificateName

string

Název certifikátu

policy
CertificatePolicy
options
BeginCreateCertificateOptions

Volitelné parametry

Návraty

Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, CertificatePollerOptions)

Operace DELETE se vztahuje na všechny certifikáty uložené ve službě Azure Key Vault. Delete nelze použít pro jednotlivé verze certifikátu. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se certifikát plně neobnoví.

Tato operace vyžaduje oprávnění k certifikátům nebo odstranění.

Příklad použití:

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

Odstraní certifikát ze zadaného trezoru klíčů.

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

Parametry

certificateName

string

Název certifikátu.

options
CertificatePollerOptions

Volitelné parametry

Návraty

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Obnoví odstraněný certifikát v zadaném trezoru. Tuto operaci lze provést pouze v trezoru s povoleným obnovitelném odstraněním. Tato operace vrátí dlouho běžící operaci poller, která umožňuje čekat na neomezenou dobu, dokud se certifikát plně neobnoví.

Tato operace vyžaduje oprávnění k certifikátům nebo obnovení.

Příklad použití:

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

Obnoví odstraněný certifikát.

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

Parametry

certificateName

string

Název odstraněného certifikátu

options
CertificatePollerOptions

Volitelné parametry

Návraty

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

Operace createIssuer přidá nebo aktualizuje zadaného vystavitele certifikátu. Tato operace vyžaduje oprávnění certifikátů/setissuers.

Příklad použití:

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

Nastaví zadaného vystavitele certifikátu.

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

Parametry

issuerName

string

Název vystavitele.

provider

string

Zprostředkovatel vystavitele.

options
CreateIssuerOptions

Volitelné parametry

Návraty

Promise<CertificateIssuer>

deleteCertificateOperation(string, OperationOptions)

Odstraní operaci vytvoření pro zadaný certifikát, který se právě vytváří. Certifikát se už nevytvořil. Tato operace vyžaduje oprávnění k certifikátům nebo aktualizaci.

Příklad použití:

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

Odstranění operace certifikátu

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

Parametry

certificateName

string

Název certifikátu

options
OperationOptions

Volitelné parametry

Návraty

Promise<CertificateOperation>

deleteContacts(OperationOptions)

Odstraní všechny kontakty certifikátu. Tato operace vyžaduje oprávnění certifikátů/managecontacts.

Příklad použití:

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

Odstraní všechny kontakty certifikátu.

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

Parametry

options
OperationOptions

Volitelné parametry

Návraty

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

Operace deleteIssuer trvale odebere zadaného vystavitele certifikátu z trezoru. Tato operace vyžaduje oprávnění certifikátů/manageissuers/deleteisuers.

Příklad použití:

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

Odstraní zadaného vystavitele certifikátu.

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

Parametry

issuerName

string

Název vystavitele.

options
OperationOptions

Volitelné parametry

Návraty

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

Získá nejnovější informace dostupné z konkrétního certifikátu, včetně zásad certifikátu. Tato operace vyžaduje certifikáty nebo získat oprávnění.

Příklad použití:

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

Načte certifikát z názvu certifikátu (včetně zásad certifikátu).

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

Parametry

certificateName

string

Název certifikátu

options
OperationOptions

Volitelné parametry

Návraty

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

Získá operaci vytvoření přidruženou k zadanému certifikátu. Tato operace vyžaduje certifikáty nebo získat oprávnění. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se certifikát plně neobnoví.

Příklad použití:

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

Získá operaci poller certifikátu.

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

Parametry

certificateName

string

Název certifikátu

options
CertificatePollerOptions

Volitelné parametry

Návraty

Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, OperationOptions)

Operace getCertificatePolicy vrátí zadané prostředky zásad certifikátu v zadaném trezoru klíčů. Tato operace vyžaduje certifikáty nebo získat oprávnění.

Příklad použití:

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

Získá zásadu certifikátu.

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

Parametry

certificateName

string

Název certifikátu

options
OperationOptions

Volitelné parametry

Návraty

Promise<CertificatePolicy>

getCertificateVersion(string, string, OperationOptions)

Získá informace o určitém certifikátu pro konkrétní verzi. Zásady certifikátu se nevrátí. Tato operace vyžaduje certifikáty nebo získat oprávnění.

Příklad použití:

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

Načte certifikát z názvu certifikátu a zadané verze.

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

Parametry

certificateName

string

Název certifikátu

version

string

Konkrétní verze certifikátu

options
OperationOptions

Volitelné parametry

Návraty

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

Vrátí sadu prostředků kontaktů certifikátu v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění certifikátů/managecontacts.

Příklad použití:

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

Nastaví kontakty certifikátu.

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

Parametry

options
OperationOptions

Volitelné parametry

Návraty

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

načte informace o odstraněném certifikátu a jeho atributy, jako je interval uchovávání, plánované trvalé odstranění a aktuální úroveň obnovení odstranění. Tato operace vyžaduje certifikáty nebo získat oprávnění.

Příklad použití:

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

Získá odstraněný certifikát.

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

Parametry

certificateName

string

Název certifikátu

options
OperationOptions

Volitelné parametry

Návraty

Promise<DeletedCertificate>

getIssuer(string, OperationOptions)

Operace getIssuer vrátí zadané prostředky vystavitele certifikátu v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění certifikátů/manageissuers/getisuers.

Příklad použití:

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

Získá zadaného vystavitele certifikátu.

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

Parametry

issuerName

string

Název vystavitele.

options
OperationOptions

Volitelné parametry

Návraty

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Importuje existující platný certifikát obsahující privátní klíč do služby Azure Key Vault. Certifikát, který se má importovat, může být ve formátu PFX nebo PEM. Pokud je certifikát ve formátu PEM, musí soubor PEM obsahovat klíč i certifikáty x509. Tato operace vyžaduje oprávnění k certifikátům nebo importu.

Příklad použití:

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

Importuje certifikát z hodnoty tajného kódu certifikátu.

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

Parametry

certificateName

string

Název certifikátu

certificateBytes

Uint8Array

Hodnota formátu PFX nebo ASCII PEM certifikátu obsahující certifikáty X.509 i privátní klíč

options
ImportCertificateOptions

Volitelné parametry

Návraty

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Načte certifikáty v aktuálním trezoru, které jsou ve stavu odstranění a jsou připravené k obnovení nebo vymazání. Tato operace zahrnuje informace specifické pro odstranění. Tato operace vyžaduje oprávnění k certifikátům, získání nebo výpisu. Tuto operaci je možné povolit pouze u trezorů s povoleným obnovitelném odstraněním.

Příklad použití:

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

Seznam odstraněných certifikátů

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

Parametry

options
ListDeletedCertificatesOptions

Volitelné parametry

Návraty

PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Iteruje nejnovější verzi všech certifikátů v trezoru. Úplný identifikátor certifikátu a atributy jsou k dispozici v odpovědi. Pro certifikáty se nevrácejí žádné hodnoty. Tyto operace vyžadují oprávnění k certifikátům nebo seznamům.

Příklad použití:

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

Zobrazí seznam všech verzí zadaného certifikátu.

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

Parametry

options
ListPropertiesOfCertificatesOptions

Volitelné parametry

Návraty

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfCertificateVersions(string, OperationOptions)

Vrátí verze certifikátu v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění k certifikátům nebo seznamům.

Příklad použití:

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!);
}

Výpis verzí certifikátu

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

Parametry

certificateName

string

Název certifikátu.

options
OperationOptions

Volitelné parametry

Návraty

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfIssuers(OperationOptions)

Vrátí sadu prostředků vystavitele certifikátů v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění certifikátů/manageissuers/getisuers.

Příklad použití:

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

Vypíše vystavitele certifikátů.

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

Parametry

options
OperationOptions

Volitelné parametry

Návraty

PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

mergeCertificate(string, Uint8Array[], OperationOptions)

Provede sloučení certifikátu nebo řetězu certifikátů s párem klíčů, který je aktuálně ve službě dostupný. Tato operace vyžaduje oprávnění k certifikátům nebo vytvoření.

Příklad použití:

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

Sloučí žádost o podepsaný certifikát do čekajícího certifikátu.

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

Parametry

certificateName

string

Název certifikátu

x509Certificates

Uint8Array[]

Certifikáty ke sloučení

options
OperationOptions

Volitelné parametry

Návraty

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, OperationOptions)

Provede nevratné odstranění zadaného certifikátu bez možnosti obnovení. Operace není k dispozici, pokud úroveň obnovení nezadá hodnotu Vyprázdnit. Tato operace vyžaduje oprávnění k vyprázdnění certifikátu.

Příklad použití:

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

Získá odstraněný certifikát.

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

Parametry

certificateName

string

Název odstraněného certifikátu, který se má vyprázdnit

options
OperationOptions

Volitelné parametry

Návraty

Promise<null>

restoreCertificateBackup(Uint8Array, OperationOptions)

Obnoví zálohovaný certifikát a všechny jeho verze do trezoru. Tato operace vyžaduje oprávnění k certifikátům nebo obnovení.

Příklad použití:

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

Obnoví certifikát ze zálohy.

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

Parametry

backup

Uint8Array

Zálohovaný certifikát, ze které se má provést obnovení

options
OperationOptions

Volitelné parametry

Návraty

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], OperationOptions)

Nastaví kontakty certifikátu pro trezor klíčů. Tato operace vyžaduje oprávnění certifikátů/managecontacts.

Příklad použití:

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",
  },
]);

Nastaví kontakty certifikátu.

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

Parametry

contacts

CertificateContact[]

Kontakty, které se mají použít

options
OperationOptions

Volitelné parametry

Návraty

Promise<undefined | CertificateContact[]>

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Aktualizuje zásady certifikátu pro zadaný certifikát. Tato operace vyžaduje oprávnění k certifikátům nebo aktualizaci. Získá zásadu certifikátu.

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

Parametry

certificateName

string

Název certifikátu

policy
CertificatePolicy

Zásady certifikátu

options
OperationOptions

Volitelné parametry

Návraty

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificatePropertiesOptions)

Použije zadanou aktualizaci pro daný certifikát; jedinými aktualizovanými prvky jsou atributy certifikátu. Tato operace vyžaduje oprávnění k certifikátům nebo aktualizaci.

Příklad použití:

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

Aktualizuje certifikát.

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

Parametry

certificateName

string

Název certifikátu

version

string

Verze certifikátu, který se má aktualizovat (prázdný řetězec aktualizuje nejnovější verzi)

options
UpdateCertificateOptions

Možnosti, včetně toho, co se má aktualizovat

Návraty

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

Operace updateIssuer provede aktualizaci u zadané entity vystavitele certifikátu. Tato operace vyžaduje oprávnění certifikátů/setissuers.

Příklad použití:

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

Aktualizuje zadaného vystavitele certifikátu.

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

Parametry

issuerName

string

Název vystavitele.

options
UpdateIssuerOptions

Volitelné parametry

Návraty

Promise<CertificateIssuer>