CertificateClient class

Crée une instance de CertificateClient.

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

Paramètres

URL de base du coffre

vaultUrl: string

Valeur de propriété

Demande qu’une sauvegarde du certificat spécifié soit téléchargée sur le client. Toutes les versions du certificat seront téléchargées. Cette opération nécessite les certificats/l’autorisation de sauvegarde.

Exemple d’utilisation :

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

Génère une sauvegarde d’un certificat

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

Paramètres

Retours

Crée un certificat. S’il s’agit de la première version, la ressource de certificat est créée. Cette fonction retourne un pollueur d’opération longue qui vous permet d’attendre indéfiniment jusqu’à ce que le certificat soit entièrement récupéré.

Note: L’envoi SelfissuerName en tant que de stratégie du certificat crée un certificat auto-signé.

Cette opération nécessite l’autorisation certificates/create.

Exemple d’utilisation :

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

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

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

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

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

Crée un certificat

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

Paramètres

Retours

L’opération DELETE s’applique à tout certificat stocké dans Azure Key Vault. La fonction DELETE ne peut pas être appliquée à une version individuelle d’un certificat. Cette fonction retourne un pollueur d’opération longue qui vous permet d’attendre indéfiniment jusqu’à ce que le certificat soit entièrement récupéré.

Cette opération nécessite l’autorisation certificats/suppression.

Exemple d’utilisation :

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

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

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

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

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

Supprime un certificat d’un coffre de clés spécifié.

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

Paramètres

Retours

Récupère le certificat supprimé dans le coffre spécifié. Cette opération ne peut être effectuée que sur un coffre activé pour la suppression réversible. Cette opération Cette fonction retourne un pollueur d’opérations longues qui vous permet d’attendre indéfiniment jusqu’à ce que le certificat soit entièrement récupéré.

Cette opération nécessite l’autorisation certificats/récupération.

Exemple d’utilisation :

const client = new CertificateClient(url, credentials);

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

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

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

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

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

Récupère un certificat supprimé

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

Paramètres

Retours

L’opération createIssuer ajoute ou met à jour l’émetteur de certificat spécifié. Cette opération nécessite l’autorisation certificates/setissuers.

Exemple d’utilisation :

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

Définit l’émetteur de certificat spécifié.

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

Paramètres

Retours

Supprime l’opération de création d’un certificat spécifié en cours de création. Le certificat n’est plus créé. Cette opération nécessite l’autorisation certificats/mise à jour.

Exemple d’utilisation :

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

Supprimer l’opération d’un certificat

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

Paramètres

Retours

Supprime tous les contacts de certificat. Cette opération nécessite l’autorisation certificates/managecontacts.

Exemple d’utilisation :

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

Supprime tous les contacts de certificat

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

Paramètres

Retours

L’opération deleteIssuer supprime définitivement l’émetteur de certificat spécifié du coffre. Cette opération nécessite l’autorisation certificates/manageissuers/deleteissuers.

Exemple d’utilisation :

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

Supprime l’émetteur de certificat spécifié.

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

Paramètres

Retours

Obtient les informations les plus récentes disponibles à partir d’un certificat spécifique, y compris la stratégie du certificat. Cette opération nécessite l’autorisation certificats/obtenir.

Exemple d’utilisation :

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

Récupère un certificat à partir du nom du certificat (inclut la stratégie de certificat)

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

Paramètres

Retours

Obtient l’opération de création associée à un certificat spécifié. Cette opération nécessite l’autorisation certificats/obtenir. Cette fonction retourne un pollueur d’opération longue qui vous permet d’attendre indéfiniment jusqu’à ce que le certificat soit entièrement récupéré.

Exemple d’utilisation :

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

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

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

Obtient l’opération d’interrogation d’un certificat

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

Paramètres

Retours

L’opération getCertificatePolicy retourne les ressources de stratégie de certificat spécifiées dans le coffre de clés spécifié. Cette opération nécessite l’autorisation certificats/obtenir.

Exemple d’utilisation :

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

Obtient la stratégie d’un certificat

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

Paramètres

Retours

Obtient des informations sur un certificat spécifique sur une version spécifique. Il ne retourne pas la stratégie du certificat. Cette opération nécessite l’autorisation certificats/obtenir.

Exemple d’utilisation :

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

Récupère un certificat à partir du nom du certificat et d’une version spécifiée

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

Paramètres

Retours

Retourne l’ensemble des ressources de contact de certificat dans le coffre de clés spécifié. Cette opération nécessite l’autorisation certificates/managecontacts.

Exemple d’utilisation :

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

Définit les contacts de certificat.

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

Paramètres

Retours

récupère les informations du certificat supprimé ainsi que ses attributs, tels que l’intervalle de rétention, la suppression permanente planifiée et le niveau de récupération de suppression actuel. Cette opération nécessite l’autorisation certificats/obtenir.

Exemple d’utilisation :

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

Obtient un certificat supprimé

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

Paramètres

Retours

L’opération getIssuer retourne les ressources d’émetteur de certificat spécifiées dans le coffre de clés spécifié. Cette opération nécessite l’autorisation certificates/manageissuers/getissuers.

Exemple d’utilisation :

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

Obtient l’émetteur de certificat spécifié.

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

Paramètres

Retours

Importe un certificat valide existant, contenant une clé privée, dans Azure Key Vault. Le certificat à importer peut être au format PFX ou PEM. Si le certificat est au format PEM, il doit contenir la clé ainsi que des certificats X509. Cette opération exige l’autorisation de certificates/d’importation.

Exemple d’utilisation :

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

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

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

Importe un certificat à partir de la valeur de secret d’un certificat

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

Paramètres

Retours

Récupère les certificats dans le coffre actuel qui sont dans un état supprimé et prêts pour la récupération ou la purge. Cette opération inclut des informations spécifiques à la suppression. Cette opération nécessite l’autorisation certificats/get/list. Cette opération ne peut être activée que sur les coffres avec suppression réversible.

Exemple d’utilisation :

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

Répertorie les certificats supprimés

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

Paramètres

Retours

Itère la dernière version de tous les certificats dans le coffre. L’identificateur de certificat complet et les attributs sont fournis dans la réponse. Aucune valeur n’est retournée pour les certificats. Cette opération nécessite l’autorisation certificats/liste.

Exemple d’utilisation :

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

Répertorier toutes les versions du certificat spécifié.

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

Paramètres

Retours

Retourne les versions d’un certificat dans le coffre de clés spécifié. Cette opération nécessite l’autorisation certificats/liste.

Exemple d’utilisation :

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

Répertorier les versions d’un certificat.

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

Paramètres

Retours

Retourne l’ensemble des ressources de l’émetteur de certificat dans le coffre de clés spécifié. Cette opération nécessite l’autorisation certificates/manageissuers/getissuers.

Exemple d’utilisation :

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

Répertorier les émetteurs de certificat.

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

Paramètres

Retours

Effectue la fusion d’un certificat ou d’une chaîne de certificats avec une paire de clés actuellement disponible dans le service. Cette opération nécessite l’autorisation certificates/create.

Exemple d’utilisation :

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

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

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

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

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

Fusionne une demande de certificat signé dans un certificat en attente

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

Paramètres

Retours

Effectue une suppression irréversible du certificat spécifié, sans possibilité de récupération. L’opération n’est pas disponible si le niveau de récupération ne spécifie pas « Purgeable ». Cette opération nécessite l’autorisation de certificat/vidage.

Exemple d’utilisation :

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

Obtient un certificat supprimé

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

Paramètres

Retours

Restaure un certificat sauvegardé et toutes ses versions dans un coffre. Cette opération nécessite l’autorisation certificats/restauration.

Exemple d’utilisation :

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

Restaure un certificat à partir d’une sauvegarde

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

Paramètres

Retours

Définit les contacts de certificat pour le coffre de clés. Cette opération nécessite l’autorisation certificates/managecontacts.

Exemple d’utilisation :

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

Définit les contacts de certificat.

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

Paramètres

Retours

Mises à jour la stratégie de certificat pour le certificat spécifié. Cette opération nécessite l’autorisation certificats/mise à jour. Obtient la stratégie d’un certificat

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

Paramètres

Retours

Applique la mise à jour spécifiée sur le certificat donné ; les seuls éléments mis à jour sont les attributs du certificat. Cette opération nécessite l’autorisation certificats/mise à jour.

Exemple d’utilisation :

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

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

Mises à jour un certificat

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

Paramètres

Retours

L’opération updateIssuer effectue une mise à jour sur l’entité émettrice de certificat spécifiée. Cette opération nécessite l’autorisation certificates/setissuers.

Exemple d’utilisation :

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

Mises à jour l’émetteur de certificat spécifié.

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

Paramètres

Retours