@azure/keyvault-keys 4.4.0-beta.2 → 4.4.0

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # Release History
 
+## 4.4.0 (2022-03-24)
+
+### Features Added
+
+- Added support for `KeyClient.getRandomBytes` which, when connected to a managed HSM, can be used to generate a byte array of a given length with random values.
+- Added support for Secure key Release from a Managed HSM.
+  - Added `KeyClient.releaseKey` to release a key from a Managed HSM.
+  - Added `exportable` and `releasePolicy` to `KeyVaultKey.properties`, `createKeyOptions`, and `importKeyOptions` in order to specify whether the key is exportable and to associate a release policy to a given key.
+- Added support for automated key rotation in Azure Key Vault and Managed HSM.
+  - Added `KeyClient.rotateKey` to rotate a key on-demand.
+  - Added `KeyClient.updateKeyRotationPolicy` to update a key's automated rotation policy.
+- Added support for `KeyClient.getCryptographyClient(keyName, options)` which provides a simple way to create a `CryptographyClient` for a given key (identified by its name).
+  - An optional `keyVersion` property may be used in the `options` parameter to create a cryptography client targeting a specific key version. The latest version is used by default.
+
+### Other Changes
+
+- This release updates `KeyClient` and `CryptographyClient` to support service version 7.3 by default.
+
+## 4.4.0-beta.4 (2022-02-08)
+
+### Features Added
+
+- Added `KeyReleasePolicy#immutable` flag to support immutable release policies. Once a release policy is marked as immutable, it can no longer be modified.
+
+## 4.4.0-beta.3 (2021-11-09)
+
+### Features Added
+
+- Support multi-tenant authentication against Key Vault and Managed HSM when using @azure/identity 2.0.0 or newer.
+
+### Breaking Changes
+
+- `KeyClient.getRandomBytes` will now return the generated bytes directly instead of wrapping them in a `RandomBytes` model.
+  - Since it's no longer used, `RandomBytes` has been removed from the public API.
+- `KeyReleasePolicy.data` has been renamed to `KeyReleasePolicy.encodedPolicy`.
+- `KeyClient.releaseKey`'s `target` parameter has been renamed to `targetAttestationToken`.
+
 ## 4.4.0-beta.2 (2021-10-05)
 
 ### Features Added
@@ -9,7 +46,6 @@
 - Added support for automated key rotation in Azure Key Vault.
   - Added `KeyClient.rotateKey` to rotate a key on-demand.
   - Added `KeyClient.updateKeyRotationPolicy` to update a key's automated rotation policy.
-- Added `JsonWebKey.key_ops` property to `JsonWebKey` in addition to the existing `JsonWebKey.keyOps` property in order to comply with the JSON Web Key spec.
 
 ## 4.4.0-beta.1 (2021-08-10)
 

package/README.md

@@ -80,7 +80,6 @@ Use the [Azure CLI][azure-cli] snippet below to create/get client secret credent
   {
     "appId": "generated-app-ID",
     "displayName": "dummy-app-name",
-    "name": "http://dummy-app-name",
     "password": "random-password",
     "tenant": "tenant-ID"
   }
@@ -206,7 +205,7 @@ const url = `https://${vaultName}.vault.azure.net`;
 
 // Change the Azure Key Vault service API version being used via the `serviceVersion` option
 const client = new KeyClient(url, credential, {
-  serviceVersion: "7.0" // Or 7.1
+  serviceVersion: "7.0", // Or 7.1
 });
 ```
 
@@ -308,7 +307,7 @@ const keyName = "MyKeyName";
 
 async function main() {
   const result = await client.createKey(keyName, "RSA", {
-    enabled: false
+    enabled: false,
   });
   console.log("result: ", result);
 }
@@ -338,7 +337,7 @@ const keyName = "MyKeyName";
 async function main() {
   const result = await client.createKey(keyName, "RSA");
   await client.updateKeyProperties(keyName, result.properties.version, {
-    enabled: false
+    enabled: false,
   });
 }
 
@@ -501,12 +500,12 @@ async function main() {
     lifetimeActions: [
       {
         action: "Rotate",
-        timeBeforeExpiry: "P30D"
-      }
+        timeBeforeExpiry: "P30D",
+      },
     ],
     // You may also specify the duration after which any newly rotated key will expire.
     // In this case, any new key versions will expire after 90 days.
-    expiresIn: "P90D"
+    expiresIn: "P90D",
   });
 
   // You can get the current key rotation policy of a given key by calling the getKeyRotationPolicy method.
@@ -652,7 +651,7 @@ async function main() {
 
   const encryptResult = await cryptographyClient.encrypt({
     algorithm: "RSA1_5",
-    plaintext: Buffer.from("My Message")
+    plaintext: Buffer.from("My Message"),
   });
   console.log("encrypt result: ", encryptResult.result);
 }
@@ -681,13 +680,13 @@ async function main() {
 
   const encryptResult = await cryptographyClient.encrypt({
     algorithm: "RSA1_5",
-    plaintext: Buffer.from("My Message")
+    plaintext: Buffer.from("My Message"),
   });
   console.log("encrypt result: ", encryptResult.result);
 
   const decryptResult = await cryptographyClient.decrypt({
     algorithm: "RSA1_5",
-    ciphertext: encryptResult.result
+    ciphertext: encryptResult.result,
   });
   console.log("decrypt result: ", decryptResult.result.toString());
 }
@@ -876,6 +875,8 @@ main();
 
 ## Troubleshooting
 
+See our [troubleshooting guide](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/keyvault/keyvault-keys/TROUBLESHOOTING.md) for details on how to diagnose various failure scenarios.
+
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
 ```javascript