@azure/keyvault-keys 4.4.0-alpha.20220105.2 → 4.4.0-alpha.20220127.2

package/CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### 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.
+
 ### Breaking Changes
 
 ### Bugs Fixed

package/dist/index.js

@@ -83,38 +83,25 @@ var KnownJsonWebKeyOperation;
     /** The SECG SECP256K1 elliptic curve. */
     KnownJsonWebKeyCurveName["P256K"] = "P-256K";
 })(exports.KnownKeyCurveNames || (exports.KnownKeyCurveNames = {}));
+/** Known values of {@link JsonWebKeyEncryptionAlgorithm} that the service accepts. */
+var KnownJsonWebKeyEncryptionAlgorithm;
 (function (KnownJsonWebKeyEncryptionAlgorithm) {
-    /** Encryption Algorithm - RSA-OAEP */
     KnownJsonWebKeyEncryptionAlgorithm["RSAOaep"] = "RSA-OAEP";
-    /** Encryption Algorithm - RSA-OAEP-256 */
     KnownJsonWebKeyEncryptionAlgorithm["RSAOaep256"] = "RSA-OAEP-256";
-    /** Encryption Algorithm - RSA1_5 */
     KnownJsonWebKeyEncryptionAlgorithm["RSA15"] = "RSA1_5";
-    /** Encryption Algorithm - A128GCM */
     KnownJsonWebKeyEncryptionAlgorithm["A128GCM"] = "A128GCM";
-    /** Encryption Algorithm - A192GCM */
     KnownJsonWebKeyEncryptionAlgorithm["A192GCM"] = "A192GCM";
-    /** Encryption Algorithm - A256GCM */
     KnownJsonWebKeyEncryptionAlgorithm["A256GCM"] = "A256GCM";
-    /** Encryption Algorithm - A128KW */
     KnownJsonWebKeyEncryptionAlgorithm["A128KW"] = "A128KW";
-    /** Encryption Algorithm - A192KW */
     KnownJsonWebKeyEncryptionAlgorithm["A192KW"] = "A192KW";
-    /** Encryption Algorithm - A256KW */
     KnownJsonWebKeyEncryptionAlgorithm["A256KW"] = "A256KW";
-    /** Encryption Algorithm - A128CBC */
     KnownJsonWebKeyEncryptionAlgorithm["A128CBC"] = "A128CBC";
-    /** Encryption Algorithm - A192CBC */
     KnownJsonWebKeyEncryptionAlgorithm["A192CBC"] = "A192CBC";
-    /** Encryption Algorithm - A256CBC */
     KnownJsonWebKeyEncryptionAlgorithm["A256CBC"] = "A256CBC";
-    /** Encryption Algorithm - A128CBCPAD */
     KnownJsonWebKeyEncryptionAlgorithm["A128Cbcpad"] = "A128CBCPAD";
-    /** Encryption Algorithm - A192CBCPAD */
     KnownJsonWebKeyEncryptionAlgorithm["A192Cbcpad"] = "A192CBCPAD";
-    /** Encryption Algorithm - A256CBCPAD */
     KnownJsonWebKeyEncryptionAlgorithm["A256Cbcpad"] = "A256CBCPAD";
-})(exports.KnownEncryptionAlgorithms || (exports.KnownEncryptionAlgorithms = {}));
+})(KnownJsonWebKeyEncryptionAlgorithm || (KnownJsonWebKeyEncryptionAlgorithm = {}));
 (function (KnownJsonWebKeySignatureAlgorithm) {
     /** RSASSA-PSS using SHA-256 and MGF1 with SHA-256, as described in https://tools.ietf.org/html/rfc7518 */
     KnownJsonWebKeySignatureAlgorithm["PS256"] = "PS256";
@@ -271,6 +258,12 @@ const KeyReleasePolicy = {
                     name: "String"
                 }
             },
+            immutable: {
+                serializedName: "immutable",
+                type: {
+                    name: "Boolean"
+                }
+            },
             encodedPolicy: {
                 serializedName: "data",
                 type: {
@@ -800,39 +793,12 @@ const KeyVerifyResult = {
         }
     }
 };
-const KeyExportParameters = {
-    type: {
-        name: "Composite",
-        className: "KeyExportParameters",
-        modelProperties: {
-            wrappingKey: {
-                serializedName: "wrappingKey",
-                type: {
-                    name: "Composite",
-                    className: "JsonWebKey"
-                }
-            },
-            wrappingKid: {
-                serializedName: "wrappingKid",
-                type: {
-                    name: "String"
-                }
-            },
-            enc: {
-                serializedName: "enc",
-                type: {
-                    name: "String"
-                }
-            }
-        }
-    }
-};
 const KeyReleaseParameters = {
     type: {
         name: "Composite",
         className: "KeyReleaseParameters",
         modelProperties: {
-            target: {
+            targetAttestationToken: {
                 constraints: {
                     MinLength: 1
                 },
@@ -1045,6 +1011,7 @@ const RandomBytes = {
         modelProperties: {
             value: {
                 serializedName: "value",
+                required: true,
                 type: {
                     name: "Base64Url"
                 }
@@ -1090,6 +1057,33 @@ const KeyProperties = {
         }
     }
 };
+const KeyExportParameters = {
+    type: {
+        name: "Composite",
+        className: "KeyExportParameters",
+        modelProperties: {
+            wrappingKey: {
+                serializedName: "wrappingKey",
+                type: {
+                    name: "Composite",
+                    className: "JsonWebKey"
+                }
+            },
+            wrappingKid: {
+                serializedName: "wrappingKid",
+                type: {
+                    name: "String"
+                }
+            },
+            enc: {
+                serializedName: "enc",
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
 const KeyAttributes = {
     type: {
         name: "Composite",
@@ -1183,7 +1177,6 @@ var Mappers = /*#__PURE__*/Object.freeze({
     KeySignParameters: KeySignParameters,
     KeyVerifyParameters: KeyVerifyParameters,
     KeyVerifyResult: KeyVerifyResult,
-    KeyExportParameters: KeyExportParameters,
     KeyReleaseParameters: KeyReleaseParameters,
     KeyReleaseResult: KeyReleaseResult,
     DeletedKeyListResult: DeletedKeyListResult,
@@ -1195,6 +1188,7 @@ var Mappers = /*#__PURE__*/Object.freeze({
     GetRandomBytesRequest: GetRandomBytesRequest,
     RandomBytes: RandomBytes,
     KeyProperties: KeyProperties,
+    KeyExportParameters: KeyExportParameters,
     KeyAttributes: KeyAttributes,
     DeletedKeyBundle: DeletedKeyBundle,
     DeletedKeyItem: DeletedKeyItem
@@ -1335,7 +1329,7 @@ class KeyVaultClientContext extends coreHttp.ServiceClient {
         if (!options) {
             options = {};
         }
-        const defaultUserAgent = `azsdk-js-${packageName.replace("@azure/", "")}/${packageVersion} ${coreHttp.getDefaultUserAgentValue()}`;
+        const defaultUserAgent = `azsdk-js-${packageName.replace(/@.*\//, "")}/${packageVersion} ${coreHttp.getDefaultUserAgentValue()}`;
         super(undefined, Object.assign(Object.assign({}, options), { userAgent: options.userAgent
                 ? `${options.userAgent} ${defaultUserAgent}`
                 : `${defaultUserAgent}` }));
@@ -1690,38 +1684,21 @@ class KeyVaultClient extends KeyVaultClientContext {
         };
         return this.sendOperationRequest(operationArguments, unwrapKeyOperationSpec);
     }
-    /**
-     * The export key operation is applicable to all key types. The target key must be marked exportable.
-     * This operation requires the keys/export permission.
-     * @param vaultBaseUrl The vault name, for example https://myvault.vault.azure.net.
-     * @param keyName The name of the key to get.
-     * @param keyVersion Adding the version parameter retrieves a specific version of a key.
-     * @param options The options parameters.
-     */
-    export(vaultBaseUrl, keyName, keyVersion, options) {
-        const operationArguments = {
-            vaultBaseUrl,
-            keyName,
-            keyVersion,
-            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
-        };
-        return this.sendOperationRequest(operationArguments, exportOperationSpec);
-    }
     /**
      * The release key operation is applicable to all key types. The target key must be marked exportable.
      * This operation requires the keys/release permission.
      * @param vaultBaseUrl The vault name, for example https://myvault.vault.azure.net.
      * @param keyName The name of the key to get.
      * @param keyVersion Adding the version parameter retrieves a specific version of a key.
-     * @param target The attestation assertion for the target of the key release.
+     * @param targetAttestationToken The attestation assertion for the target of the key release.
      * @param options The options parameters.
      */
-    release(vaultBaseUrl, keyName, keyVersion, target, options) {
+    release(vaultBaseUrl, keyName, keyVersion, targetAttestationToken, options) {
         const operationArguments = {
             vaultBaseUrl,
             keyName,
             keyVersion,
-            target,
+            targetAttestationToken,
             options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
         };
         return this.sendOperationRequest(operationArguments, releaseOperationSpec);
@@ -2270,35 +2247,6 @@ const unwrapKeyOperationSpec = {
     mediaType: "json",
     serializer
 };
-const exportOperationSpec = {
-    path: "/keys/{key-name}/{key-version}/export",
-    httpMethod: "POST",
-    responses: {
-        200: {
-            bodyMapper: KeyBundle
-        },
-        default: {
-            bodyMapper: KeyVaultError
-        }
-    },
-    requestBody: {
-        parameterPath: {
-            wrappingKey: ["options", "wrappingKey"],
-            wrappingKid: ["options", "wrappingKid"],
-            enc: ["options", "enc"]
-        },
-        mapper: Object.assign(Object.assign({}, KeyExportParameters), { required: true })
-    },
-    queryParameters: [apiVersion],
-    urlParameters: [
-        vaultBaseUrl,
-        keyName1,
-        keyVersion
-    ],
-    headerParameters: [contentType, accept],
-    mediaType: "json",
-    serializer
-};
 const releaseOperationSpec = {
     path: "/keys/{key-name}/{key-version}/release",
     httpMethod: "POST",
@@ -2312,7 +2260,7 @@ const releaseOperationSpec = {
     },
     requestBody: {
         parameterPath: {
-            target: ["target"],
+            targetAttestationToken: ["targetAttestationToken"],
             nonce: ["options", "nonce"],
             enc: ["options", "enc"]
         },
@@ -4150,6 +4098,40 @@ class CryptographyClient {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+(function (KnownEncryptionAlgorithms) {
+    /** Encryption Algorithm - RSA-OAEP */
+    KnownEncryptionAlgorithms["RSAOaep"] = "RSA-OAEP";
+    /** Encryption Algorithm - RSA-OAEP-256 */
+    KnownEncryptionAlgorithms["RSAOaep256"] = "RSA-OAEP-256";
+    /** Encryption Algorithm - RSA1_5 */
+    KnownEncryptionAlgorithms["RSA15"] = "RSA1_5";
+    /** Encryption Algorithm - A128GCM */
+    KnownEncryptionAlgorithms["A128GCM"] = "A128GCM";
+    /** Encryption Algorithm - A192GCM */
+    KnownEncryptionAlgorithms["A192GCM"] = "A192GCM";
+    /** Encryption Algorithm - A256GCM */
+    KnownEncryptionAlgorithms["A256GCM"] = "A256GCM";
+    /** Encryption Algorithm - A128KW */
+    KnownEncryptionAlgorithms["A128KW"] = "A128KW";
+    /** Encryption Algorithm - A192KW */
+    KnownEncryptionAlgorithms["A192KW"] = "A192KW";
+    /** Encryption Algorithm - A256KW */
+    KnownEncryptionAlgorithms["A256KW"] = "A256KW";
+    /** Encryption Algorithm - A128CBC */
+    KnownEncryptionAlgorithms["A128CBC"] = "A128CBC";
+    /** Encryption Algorithm - A192CBC */
+    KnownEncryptionAlgorithms["A192CBC"] = "A192CBC";
+    /** Encryption Algorithm - A256CBC */
+    KnownEncryptionAlgorithms["A256CBC"] = "A256CBC";
+    /** Encryption Algorithm - A128CBCPAD */
+    KnownEncryptionAlgorithms["A128Cbcpad"] = "A128CBCPAD";
+    /** Encryption Algorithm - A192CBCPAD */
+    KnownEncryptionAlgorithms["A192Cbcpad"] = "A192CBCPAD";
+    /** Encryption Algorithm - A256CBCPAD */
+    KnownEncryptionAlgorithms["A256Cbcpad"] = "A256CBCPAD";
+})(exports.KnownEncryptionAlgorithms || (exports.KnownEncryptionAlgorithms = {}));
+
 // Copyright (c) Microsoft Corporation.
 const withTrace$4 = createTraceFunction("Azure.KeyVault.Keys.KeyClient");
 /**