typescript

page_type	languages	products	urlFragment
sample	typescript	azure azure-key-vault	keyvault-secrets-typescript

Azure Key Vault Keys client library samples for TypeScript

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

File Name	Description
backupAndRestore.ts	Backs up an Azure Key Vault secret to a local file and restores from it.
deleteAndRecover.ts	Deletes a secret and then recovers a deleted secret (this sample requires soft-delete to run).
helloWorld.ts	Uses a SecretClient to create, read, and update a secret in various ways.
listOperations.ts	Uses a SecretClient to iterate over secrets and their versions.
purgeAllSecrets.ts	Purges all deleted secrets from an Azure Key Vault.

Prerequisites

The sample programs are compatible with Node.js >=12.0.0.

Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the TypeScript documentation. Install the TypeScript compiler using:

npm install -g typescript

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

• Azure Key Vault

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

2. Compile the samples:

npm run build

3. 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.

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

node dist/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 dist/backupAndRestore.js

Next Steps

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