azure-sdk-for-js/sdk/keyvault
Jeremy Meng cf8d25ff5e
Fix compiler errors in tests and samples (#31649)
After moving to ESM/tshy, we no longer build tests/samples. This PR
enables running "typecheck" as an optional rush bulk command, and fixes
some of the errors found.

The known errors reported on files from vite/vitest/chai are ignored.

The update-snippets dev-tool command throws error of reading undefined
in some cases, adding a null check fixes it.

Snippets are updated as well after snippets.spec.ts files are fixed.
2024-11-06 13:31:08 -08:00
..
arm-keyvault [EngSys] move to vendored version of cross-env via dev-tool 2024-11-02 00:48:06 +00:00
arm-keyvault-profile-2020-09-01-hybrid [EngSys] move to vendored version of cross-env via dev-tool 2024-11-02 00:48:06 +00:00
keyvault-admin Fix compiler errors in tests and samples (#31649) 2024-11-06 13:31:08 -08:00
keyvault-certificates [EngSys] move to vendored version of cross-env via dev-tool 2024-11-02 00:48:06 +00:00
keyvault-common [EngSys] move to vendored version of cross-env via dev-tool 2024-11-02 00:48:06 +00:00
keyvault-keys Fix compiler errors in tests and samples (#31649) 2024-11-06 13:31:08 -08:00
keyvault-secrets [EngSys] move to vendored version of cross-env via dev-tool 2024-11-02 00:48:06 +00:00
perf-tests [EngSys] remove "audit" NPM script and it's related file 2024-10-25 19:28:06 +00:00
README.md Fix doc warnings in various README files (#22267) 2022-06-15 14:53:44 -07:00
TROUBLESHOOTING.md [keyvault] Update migration and troubleshooting guides (#26521) 2023-08-03 14:36:48 -07:00
ci.mgmt.yml refresh-10 (#21581) 2022-04-27 10:42:43 +08:00
ci.yml Add `keyvault` trigger when updating eng/common/testproxy (#24774) 2023-02-14 13:52:55 -08:00
test-resources-post.ps1 [keyvault] Migrate to federated credentials (#30210) 2024-07-05 10:16:57 -07:00
test-resources.bicep [Key Vault] Migrate to Bicep (#30869) 2024-08-22 16:37:29 -07:00
test-resources.json [Key Vault] Migrate to Bicep (#30869) 2024-08-22 16:37:29 -07:00

README.md

Azure Key Vault client libraries for JavaScript

Azure Key Vault is a Microsoft-managed service providing cloud keys, secrets, and certificate storage and utility that is highly available, secure, durable, scalable, and redundant.

Libraries for resource management

To manage your Azure Key Vault resources via the Azure Resource Manager, you would use the below package.

NPM Package Reference
@azure/arm-keyvault API Reference for @azure/arm-keyvault

Libraries for data access

There are three packages to work with Key Vault keys, secrets and certificates respectively. A fourth package, @azure/keyvault-admin is also available for administrative tasks on your Key Vault instance.

NPM Package Reference Samples
@azure/keyvault-keys API Reference for @azure/keyvault-keys Samples for working with keys
@azure/keyvault-secrets API Reference for @azure/keyvault-secrets Samples for working with secrets
@azure/keyvault-certificates API Reference for @azure/keyvault-certificates Samples for working with certificates
@azure/keyvault-admin API Reference for @azure/keyvault-admin Samples for administrative tasks

Features

  • Key Vault Keys
    • Create keys using elliptic curve or RSA encryption, optionally backed by Hardware Security Modules (HSM).
    • Import, delete and update keys.
    • Get one or more keys and deleted keys.
    • Recover a deleted key and restore a backed up key.
    • Get the versions and the attributes of a key.
    • Encrypting, decrypting, signing, verifying, wrapping and unwrapping data with keys.
  • Key Vault Secrets
    • Get, set and delete a secret.
    • Update a secret and it's attributes.
    • Backup and restore a secret.
    • Get, purge or recover a deleted secret.
    • Get all the versions of a secret, or secrets, or deleted secrets.
  • Key Vault Certificates
    • Get, set and delete a certificate.
    • Update a certificate, its attributes, issuer, policy, operation and contacts.
    • Backup and restore a certificate.
    • Get, purge or recover a deleted certificate.
    • Get all the versions of a certificate, or certificates, or deleted certificates.
  • Key Vault Admin
    • Get, set, list, and delete Key Vault RBAC (Role-Based Access Control) role assignments.
    • Get, set, list, and delete Key Vault RBAC (Role-Based Access Control) role definitions.
    • Backup and restore Azure Key Vault Managed HSM instances, including selective restore of specific keys.