Skill v1.0.1
currentAutomated scan100/100+4 new
version: "1.0.1" name: azure-keyvault-keys-ts description: "Manage cryptographic keys using Azure Key Vault Keys SDK for JavaScript (@azure/keyvault-keys). Use when creating, encrypting/decrypting, signing, or rotating keys." risk: critical source: community date_added: "2026-02-27"
Azure Key Vault Keys SDK for TypeScript
Manage cryptographic keys with Azure Key Vault.
Installation
# Keys SDKnpm install @azure/keyvault-keys @azure/keyvault-secrets @azure/identity
Environment Variables
KEY_VAULT_URL=https://<vault-name>.vault.azure.net# OrAZURE_KEYVAULT_NAME=<vault-name>
Authentication
import { DefaultAzureCredential } from "@azure/identity";import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";import { SecretClient } from "@azure/keyvault-secrets";const credential = new DefaultAzureCredential();const vaultUrl = `https://${process.env.AZURE_KEYVAULT_NAME}.vault.azure.net`;const keyClient = new KeyClient(vaultUrl, credential);const secretClient = new SecretClient(vaultUrl, credential);
Execution boundaries
Examples are independent fragments and reuse names; do not concatenate them into one script. Use approved test vaults and least-privilege identity. Purge is irreversible and can be blocked by purge protection; key deletion/rotation can break dependent workloads. Confirm exact vault/object/version and recovery plan before mutation. Example expiration dates are historical, not recommended live values.
Secrets Operations
Create/Set Secret
const secret = await secretClient.setSecret("MySecret", "secret-value");// With attributesconst secretWithAttrs = await secretClient.setSecret("MySecret", "value", {enabled: true,expiresOn: new Date("2025-12-31"),contentType: "application/json",tags: { environment: "production" }});
Get Secret
// Get latest versionconst secret = await secretClient.getSecret("MySecret");console.log(secret.name); // Never log secret values.// Get specific versionconst specificSecret = await secretClient.getSecret("MySecret", {version: secret.properties.version});
List Secrets
for await (const secretProperties of secretClient.listPropertiesOfSecrets()) {console.log(secretProperties.name);}// List versionsfor await (const version of secretClient.listPropertiesOfSecretVersions("MySecret")) {console.log(version.version);}
Delete Secret
// Soft deleteconst deletePoller = await secretClient.beginDeleteSecret("MySecret");await deletePoller.pollUntilDone();// Purge (permanent)await secretClient.purgeDeletedSecret("MySecret");// Recoverconst recoverPoller = await secretClient.beginRecoverDeletedSecret("MySecret");await recoverPoller.pollUntilDone();
Keys Operations
Create Keys
// Generic keyconst key = await keyClient.createKey("MyKey", "RSA");// RSA key with sizeconst rsaKey = await keyClient.createRsaKey("MyRsaKey", { keySize: 2048 });// Elliptic Curve keyconst ecKey = await keyClient.createEcKey("MyEcKey", { curve: "P-256" });// With attributesconst keyWithAttrs = await keyClient.createKey("MyKey", "RSA", {enabled: true,expiresOn: new Date("2025-12-31"),tags: { purpose: "encryption" },keyOps: ["encrypt", "decrypt", "sign", "verify"]});
Get Key
const key = await keyClient.getKey("MyKey");console.log(key.name, key.keyType);
List Keys
for await (const keyProperties of keyClient.listPropertiesOfKeys()) {console.log(keyProperties.name);}
Rotate Key
// Manual rotationconst rotatedKey = await keyClient.rotateKey("MyKey");// Set rotation policyawait keyClient.updateKeyRotationPolicy("MyKey", {lifetimeActions: [{ action: "Rotate", timeBeforeExpiry: "P30D" }],expiresIn: "P90D"});
Delete Key
const deletePoller = await keyClient.beginDeleteKey("MyKey");await deletePoller.pollUntilDone();// Purgeawait keyClient.purgeDeletedKey("MyKey");
Cryptographic Operations
Create CryptographyClient
import { CryptographyClient } from "@azure/keyvault-keys";// From key objectconst cryptoClient = new CryptographyClient(key, credential);// From key IDconst cryptoClient = new CryptographyClient(key.id!, credential);
Encrypt/Decrypt
// Encryptconst encryptResult = await cryptoClient.encrypt({algorithm: "RSA-OAEP",plaintext: Buffer.from("My secret message")});// Decryptconst decryptResult = await cryptoClient.decrypt({algorithm: "RSA-OAEP",ciphertext: encryptResult.result});// Use decrypted bytes only in the authorized application; do not log them.
Sign/Verify
import { createHash } from "node:crypto";// Create digestconst hash = createHash("sha256").update("My message").digest();// Signconst signResult = await cryptoClient.sign("RS256", hash);// Verifyconst verifyResult = await cryptoClient.verify("RS256", hash, signResult.result);console.log("Valid:", verifyResult.result);
Wrap/Unwrap Keys
// Wrap a key (encrypt it for storage)const wrapResult = await cryptoClient.wrapKey("RSA-OAEP", Buffer.from("key-material"));// Unwrapconst unwrapResult = await cryptoClient.unwrapKey("RSA-OAEP", wrapResult.result);
Backup and Restore
// Backupconst keyBackup = await keyClient.backupKey("MyKey");const secretBackup = await secretClient.backupSecret("MySecret");// Restore only within the same subscription and Azure geography.const restoredKey = await keyClient.restoreKeyBackup(keyBackup!);const restoredSecret = await secretClient.restoreSecretBackup(secretBackup!);
Key Types
import {KeyClient,KeyVaultKey,KeyProperties,DeletedKey,CryptographyClient,KnownEncryptionAlgorithms,KnownSignatureAlgorithms} from "@azure/keyvault-keys";import {SecretClient,KeyVaultSecret,SecretProperties,DeletedSecret} from "@azure/keyvault-secrets";
Error Handling
try {const secret = await secretClient.getSecret("NonExistent");} catch (error: any) {if (error.code === "SecretNotFound") {console.log("Secret does not exist");} else {throw error;}}
Best Practices
- Use DefaultAzureCredential - Works across dev and production
- Enable soft-delete - Required for production vaults
- Set expiration dates - On both keys and secrets
- Use key rotation policies - Automate key rotation
- Limit key operations - Only grant needed operations (encrypt, sign, etc.)
- Browser not supported - These SDKs are Node.js only
When to Use
This skill is applicable to execute the workflow or actions described in the overview.
Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.