Share via

Azure Key Vault Certificates client library samples for JavaScript

  • Code Sample
Browse code

These sample programs show how to use the JavaScript client libraries for Azure Key Vault Certificates in some common scenarios.

File Name Description
backupAndRestore.js Creates a self-signed certificate, then makes a backup from it, then deletes it and purges it, and finally restores it.
contacts.js Creates, updates, and deletes certificate contacts.
deleteAndRecover.js Creates a self-signed certificate, deletes it, and then recovers it (soft-delete is required for this sample to run).
helloWorld.js Uses a CertificateClient in various ways to read a certificate as well as update a certificate's tags.
importCertificate.js Imports a PFX and PEM certificate and then deletes them.
issuers.js Creates, updates and deletes certificate issuers.
listCertificates.js List certificates, lists a certificate's versions, and lists deleted certificates in various ways.
mergeCertificate.js Creates a certificate with an unknown issuer and signs it using a fake certificate authority and the mergeCertificate API.
operations.js Uses a CertificateClient to create, update, and delete a certificate's operation.

Prerequisites

The sample programs are compatible with LTS versions of Node.js.

You need an Azure subscription and the following Azure resources to run these sample programs:

To quickly create the needed Key Vault resources in Azure and to receive a connection string for them, you can deploy our sample template by clicking:

If creating the Key Vault manually using the Azure Portal, be aware that the samples require that the soft-delete feature be enabled. Our template above will enable this feature automatically, but it is possible to enable it manually using the Azure CLI. See the documentation for enabling soft-delete in Key Vault for more information.

Samples retrieve credentials to access the service endpoint from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function.

Adapting the samples to run in the browser may require some additional consideration. For details, please see the package README.

Setup

To run the samples using the published version of the package:

  1. Install the dependencies using npm:
npm install

  1. Edit the file sample.env, adding the correct credentials to access the Azure service and run the samples. Then rename the file from sample.env to just .env. The sample programs will read this file automatically.

  2. Run whichever samples you like (note that some samples may require additional setup, see the table above):

node backupAndRestore.js

Alternatively, run a single sample with the correct environment variables set (setting up the .env file is not required if you do this), for example (cross-platform):

npx cross-env KEYVAULT_URI="<keyvault uri>" node backupAndRestore.js

Next Steps

Take a look at our API Documentation for more information about the APIs that are available in the clients.