@azure/keyvault-admin 4.2.0-alpha.20220105.2 → 4.2.0-alpha.20220302.2

package/README.md

@@ -9,6 +9,7 @@ The package `@azure/keyvault-admin` provides support for administrative Key Vaul
 > Note: This package cannot be used in the browser due to Azure Key Vault service limitations, please refer to [this document](https://github.com/Azure/azure-sdk-for-js/blob/main/samples/cors/ts/README.md) for guidance.
 
 Key links:
+
 - [Source code][package-gh]
 - [Package (npm)][package-npm]
 - [API Reference Documentation][docs]
@@ -220,6 +221,8 @@ We have samples both in JavaScript and TypeScript that show the access control a
 
 ## Troubleshooting
 
+See our [troubleshooting guide](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/keyvault/keyvault-admin/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

package/dist/index.js

@@ -5,13 +5,31 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var tslib = require('tslib');
 var coreClient = require('@azure/core-client');
 var coreRestPipeline = require('@azure/core-rest-pipeline');
-require('@azure/core-http');
-require('url');
 var coreTracing = require('@azure/core-tracing');
 var logger$1 = require('@azure/logger');
 var uuid = require('uuid');
 var coreLro = require('@azure/core-lro');
 
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n["default"] = e;
+    return Object.freeze(n);
+}
+
+var coreClient__namespace = /*#__PURE__*/_interopNamespace(coreClient);
+
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 /**
@@ -907,7 +925,7 @@ class RoleDefinitionsImpl {
      * @param options The options parameters.
      */
     delete(vaultBaseUrl, scope, roleDefinitionName, options) {
-        return this.client.sendOperationRequest({ vaultBaseUrl, scope, roleDefinitionName, options }, deleteOperationSpec);
+        return this.client.sendOperationRequest({ vaultBaseUrl, scope, roleDefinitionName, options }, deleteOperationSpec$1);
     }
     /**
      * Creates or updates a custom role definition.
@@ -929,7 +947,7 @@ class RoleDefinitionsImpl {
      * @param options The options parameters.
      */
     get(vaultBaseUrl, scope, roleDefinitionName, options) {
-        return this.client.sendOperationRequest({ vaultBaseUrl, scope, roleDefinitionName, options }, getOperationSpec);
+        return this.client.sendOperationRequest({ vaultBaseUrl, scope, roleDefinitionName, options }, getOperationSpec$1);
     }
     /**
      * Get all role definitions that are applicable at scope and above.
@@ -952,8 +970,8 @@ class RoleDefinitionsImpl {
     }
 }
 // Operation Specifications
-const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
-const deleteOperationSpec = {
+const serializer$2 = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
+const deleteOperationSpec$1 = {
     path: "/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName}",
     httpMethod: "DELETE",
     responses: {
@@ -970,7 +988,7 @@ const deleteOperationSpec = {
         roleDefinitionName
     ],
     headerParameters: [accept],
-    serializer
+    serializer: serializer$2
 };
 const createOrUpdateOperationSpec = {
     path: "/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName}",
@@ -992,9 +1010,9 @@ const createOrUpdateOperationSpec = {
     ],
     headerParameters: [accept, contentType],
     mediaType: "json",
-    serializer
+    serializer: serializer$2
 };
-const getOperationSpec = {
+const getOperationSpec$1 = {
     path: "/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName}",
     httpMethod: "GET",
     responses: {
@@ -1012,7 +1030,7 @@ const getOperationSpec = {
         roleDefinitionName
     ],
     headerParameters: [accept],
-    serializer
+    serializer: serializer$2
 };
 const listOperationSpec = {
     path: "/{scope}/providers/Microsoft.Authorization/roleDefinitions",
@@ -1028,7 +1046,7 @@ const listOperationSpec = {
     queryParameters: [apiVersion, filter],
     urlParameters: [vaultBaseUrl, scope],
     headerParameters: [accept],
-    serializer
+    serializer: serializer$2
 };
 const listNextOperationSpec = {
     path: "{nextLink}",
@@ -1048,7 +1066,7 @@ const listNextOperationSpec = {
         nextLink
     ],
     headerParameters: [accept],
-    serializer
+    serializer: serializer$2
 };
 
 /*
@@ -1075,7 +1093,7 @@ class RoleAssignmentsImpl {
      * @param options The options parameters.
      */
     delete(vaultBaseUrl, scope, roleAssignmentName, options) {
-        return this.client.sendOperationRequest({ vaultBaseUrl, scope, roleAssignmentName, options }, deleteOperationSpec$1);
+        return this.client.sendOperationRequest({ vaultBaseUrl, scope, roleAssignmentName, options }, deleteOperationSpec);
     }
     /**
      * Creates a role assignment.
@@ -1096,7 +1114,7 @@ class RoleAssignmentsImpl {
      * @param options The options parameters.
      */
     get(vaultBaseUrl, scope, roleAssignmentName, options) {
-        return this.client.sendOperationRequest({ vaultBaseUrl, scope, roleAssignmentName, options }, getOperationSpec$1);
+        return this.client.sendOperationRequest({ vaultBaseUrl, scope, roleAssignmentName, options }, getOperationSpec);
     }
     /**
      * Gets role assignments for a scope.
@@ -1119,8 +1137,8 @@ class RoleAssignmentsImpl {
     }
 }
 // Operation Specifications
-const serializer$1 = coreClient.createSerializer(Mappers, /* isXml */ false);
-const deleteOperationSpec$1 = {
+const serializer$1 = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
+const deleteOperationSpec = {
     path: "/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}",
     httpMethod: "DELETE",
     responses: {
@@ -1161,7 +1179,7 @@ const createOperationSpec = {
     mediaType: "json",
     serializer: serializer$1
 };
-const getOperationSpec$1 = {
+const getOperationSpec = {
     path: "/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}",
     httpMethod: "GET",
     responses: {
@@ -1225,7 +1243,7 @@ const listForScopeNextOperationSpec = {
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-class KeyVaultClientContext extends coreClient.ServiceClient {
+class KeyVaultClientContext extends coreClient__namespace.ServiceClient {
     /**
      * Initializes a new instance of the KeyVaultClientContext class.
      * @param apiVersion Api Version
@@ -1320,7 +1338,7 @@ class KeyVaultClient extends KeyVaultClientContext {
     }
 }
 // Operation Specifications
-const serializer$2 = coreClient.createSerializer(Mappers, /* isXml */ false);
+const serializer = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
 const fullBackupOperationSpec = {
     path: "/backup",
     httpMethod: "POST",
@@ -1338,7 +1356,7 @@ const fullBackupOperationSpec = {
     urlParameters: [vaultBaseUrl],
     headerParameters: [accept, contentType],
     mediaType: "json",
-    serializer: serializer$2
+    serializer
 };
 const fullBackupStatusOperationSpec = {
     path: "/backup/{jobId}/pending",
@@ -1354,7 +1372,7 @@ const fullBackupStatusOperationSpec = {
     queryParameters: [apiVersion],
     urlParameters: [vaultBaseUrl, jobId],
     headerParameters: [accept],
-    serializer: serializer$2
+    serializer
 };
 const fullRestoreOperationOperationSpec = {
     path: "/restore",
@@ -1373,7 +1391,7 @@ const fullRestoreOperationOperationSpec = {
     urlParameters: [vaultBaseUrl],
     headerParameters: [accept, contentType],
     mediaType: "json",
-    serializer: serializer$2
+    serializer
 };
 const restoreStatusOperationSpec = {
     path: "/restore/{jobId}/pending",
@@ -1389,7 +1407,7 @@ const restoreStatusOperationSpec = {
     queryParameters: [apiVersion],
     urlParameters: [vaultBaseUrl, jobId],
     headerParameters: [accept],
-    serializer: serializer$2
+    serializer
 };
 const selectiveKeyRestoreOperationOperationSpec = {
     path: "/keys/{keyName}/restore",
@@ -1408,7 +1426,7 @@ const selectiveKeyRestoreOperationOperationSpec = {
     urlParameters: [vaultBaseUrl, keyName],
     headerParameters: [accept, contentType],
     mediaType: "json",
-    serializer: serializer$2
+    serializer
 };
 
 // Copyright (c) Microsoft Corporation.
@@ -1637,7 +1655,7 @@ const mappings = {
 };
 
 // Copyright (c) Microsoft Corporation.
-const withTrace = createTraceFunction("Azure.KeyVault.Admin.KeyVaultAccessControlClient");
+const withTrace$3 = createTraceFunction("Azure.KeyVault.Admin.KeyVaultAccessControlClient");
 /**
  * The KeyVaultAccessControlClient provides methods to manage
  * access control and role assignments in any given Azure Key Vault instance.
@@ -1697,7 +1715,7 @@ class KeyVaultAccessControlClient {
      * @param options - The optional parameters.
      */
     createRoleAssignment(roleScope, name, roleDefinitionId, principalId, options = {}) {
-        return withTrace("createRoleAssignment", options, async (updatedOptions) => {
+        return withTrace$3("createRoleAssignment", options, async (updatedOptions) => {
             const response = await this.client.roleAssignments.create(this.vaultUrl, roleScope, name, {
                 properties: {
                     roleDefinitionId,
@@ -1722,7 +1740,7 @@ class KeyVaultAccessControlClient {
      * @param options - The optional parameters.
      */
     deleteRoleAssignment(roleScope, name, options = {}) {
-        return withTrace("deleteRoleAssignment", options, async (updatedOptions) => {
+        return withTrace$3("deleteRoleAssignment", options, async (updatedOptions) => {
             await this.client.roleAssignments.delete(this.vaultUrl, roleScope, name, updatedOptions);
         });
     }
@@ -1742,7 +1760,7 @@ class KeyVaultAccessControlClient {
      * @param options - The optional parameters.
      */
     getRoleAssignment(roleScope, name, options = {}) {
-        return withTrace("getRoleAssignment", options, async (updatedOptions) => {
+        return withTrace$3("getRoleAssignment", options, async (updatedOptions) => {
             const response = await this.client.roleAssignments.get(this.vaultUrl, roleScope, name, updatedOptions);
             return mappings.roleAssignment.generatedToPublic(response);
         });
@@ -1757,7 +1775,7 @@ class KeyVaultAccessControlClient {
         return tslib.__asyncGenerator(this, arguments, function* listRoleAssignmentsPage_1() {
             if (!continuationState.continuationToken) {
                 const optionsComplete = options || {};
-                const currentSetResponse = yield tslib.__await(withTrace("listRoleAssignments", optionsComplete, async (updatedOptions) => {
+                const currentSetResponse = yield tslib.__await(withTrace$3("listRoleAssignments", optionsComplete, async (updatedOptions) => {
                     return this.client.roleAssignments.listForScope(this.vaultUrl, roleScope, updatedOptions);
                 }));
                 continuationState.continuationToken = currentSetResponse.nextLink;
@@ -1766,7 +1784,7 @@ class KeyVaultAccessControlClient {
                 }
             }
             while (continuationState.continuationToken) {
-                const currentSetResponse = yield tslib.__await(withTrace("listRoleAssignments", options || {}, async (updatedOptions) => {
+                const currentSetResponse = yield tslib.__await(withTrace$3("listRoleAssignments", options || {}, async (updatedOptions) => {
                     return this.client.roleAssignments.listForScopeNext(this.vaultUrl, roleScope, continuationState.continuationToken, updatedOptions);
                 }));
                 continuationState.continuationToken = currentSetResponse.nextLink;
@@ -1838,14 +1856,14 @@ class KeyVaultAccessControlClient {
         return tslib.__asyncGenerator(this, arguments, function* listRoleDefinitionsPage_1() {
             if (!continuationState.continuationToken) {
                 const optionsComplete = options || {};
-                const currentSetResponse = yield tslib.__await(withTrace("listRoleDefinitions", optionsComplete, (updatedOptions) => this.client.roleDefinitions.list(this.vaultUrl, roleScope, updatedOptions)));
+                const currentSetResponse = yield tslib.__await(withTrace$3("listRoleDefinitions", optionsComplete, (updatedOptions) => this.client.roleDefinitions.list(this.vaultUrl, roleScope, updatedOptions)));
                 continuationState.continuationToken = currentSetResponse.nextLink;
                 if (currentSetResponse.value) {
                     yield yield tslib.__await(currentSetResponse.value.map(mappings.roleDefinition.generatedToPublic, this));
                 }
             }
             while (continuationState.continuationToken) {
-                const currentSetResponse = yield tslib.__await(withTrace("listRoleDefinitions", options, (updatedOptions) => this.client.roleDefinitions.listNext(this.vaultUrl, roleScope, continuationState.continuationToken, updatedOptions)));
+                const currentSetResponse = yield tslib.__await(withTrace$3("listRoleDefinitions", options, (updatedOptions) => this.client.roleDefinitions.listNext(this.vaultUrl, roleScope, continuationState.continuationToken, updatedOptions)));
                 continuationState.continuationToken = currentSetResponse.nextLink;
                 if (currentSetResponse.value) {
                     yield yield tslib.__await(currentSetResponse.value.map(mappings.roleDefinition.generatedToPublic, this));
@@ -1919,7 +1937,7 @@ class KeyVaultAccessControlClient {
      * @param options - The optional parameters.
      */
     getRoleDefinition(roleScope, name, options = {}) {
-        return withTrace("getRoleDefinition", options, async (updatedOptions) => {
+        return withTrace$3("getRoleDefinition", options, async (updatedOptions) => {
             const response = await this.client.roleDefinitions.get(this.vaultUrl, roleScope, name, updatedOptions);
             return mappings.roleDefinition.generatedToPublic(response);
         });
@@ -1942,7 +1960,7 @@ class KeyVaultAccessControlClient {
      * @param options - The optional parameters.
      */
     setRoleDefinition(roleScope, options = {}) {
-        return withTrace("setRoleDefinition", options, async (updatedOptions) => {
+        return withTrace$3("setRoleDefinition", options, async (updatedOptions) => {
             const response = await this.client.roleDefinitions.createOrUpdate(this.vaultUrl, roleScope, options.roleDefinitionName || uuid.v4(), {
                 properties: {
                     description: options.description,
@@ -1969,7 +1987,7 @@ class KeyVaultAccessControlClient {
      * @param options - The optional parameters.
      */
     deleteRoleDefinition(roleScope, name, options = {}) {
-        return withTrace("deleteRoleDefinition", options, async (updatedOptions) => {
+        return withTrace$3("deleteRoleDefinition", options, async (updatedOptions) => {
             await this.client.roleDefinitions.delete(this.vaultUrl, roleScope, name, updatedOptions);
         });
     }
@@ -1996,6 +2014,8 @@ var KnownRoleType;
     /** Custom role. */
     KnownRoleType["CustomRole"] = "CustomRole";
 })(KnownRoleType || (KnownRoleType = {}));
+/** Known values of {@link DataAction} that the service accepts. */
+exports.KnownKeyVaultDataAction = void 0;
 (function (KnownDataAction) {
     /** Read HSM key metadata. */
     KnownDataAction["ReadHsmKey"] = "Microsoft.KeyVault/managedHsm/keys/read/action";
@@ -2066,6 +2086,8 @@ var KnownRoleType;
     /** Generate random numbers. */
     KnownDataAction["RandomNumbersGenerate"] = "Microsoft.KeyVault/managedHsm/rng/action";
 })(exports.KnownKeyVaultDataAction || (exports.KnownKeyVaultDataAction = {}));
+/** Known values of {@link RoleScope} that the service accepts. */
+exports.KnownKeyVaultRoleScope = void 0;
 (function (KnownRoleScope) {
     /** Global scope */
     KnownRoleScope["Global"] = "/";
@@ -2154,7 +2176,7 @@ class KeyVaultAdminPollOperation {
 /**
  * @internal
  */
-const withTrace$1 = createTraceFunction("Azure.KeyVault.Admin.KeyVaultBackupPoller");
+const withTrace$2 = createTraceFunction("Azure.KeyVault.Admin.KeyVaultBackupPoller");
 /**
  * The backup Key Vault's poll operation.
  */
@@ -2170,13 +2192,13 @@ class KeyVaultBackupPollOperation extends KeyVaultAdminPollOperation {
      * Tracing the fullBackup operation
      */
     fullBackup(options) {
-        return withTrace$1("fullBackup", options, (updatedOptions) => this.client.fullBackup(this.vaultUrl, updatedOptions));
+        return withTrace$2("fullBackup", options, (updatedOptions) => this.client.fullBackup(this.vaultUrl, updatedOptions));
     }
     /**
      * Tracing the fullBackupStatus operation
      */
     fullBackupStatus(jobId, options) {
-        return withTrace$1("fullBackupStatus", options, (updatedOptions) => this.client.fullBackupStatus(this.vaultUrl, jobId, updatedOptions));
+        return withTrace$2("fullBackupStatus", options, (updatedOptions) => this.client.fullBackupStatus(this.vaultUrl, jobId, updatedOptions));
     }
     /**
      * Reaches to the service and updates the backup's poll operation.
@@ -2251,7 +2273,7 @@ class KeyVaultBackupPoller extends KeyVaultAdminPoller {
 /**
  * @internal
  */
-const withTrace$2 = createTraceFunction("Azure.KeyVault.Admin.KeyVaultRestorePoller");
+const withTrace$1 = createTraceFunction("Azure.KeyVault.Admin.KeyVaultRestorePoller");
 /**
  * An interface representing a restore Key Vault's poll operation.
  */
@@ -2269,13 +2291,13 @@ class KeyVaultRestorePollOperation extends KeyVaultAdminPollOperation {
      * Tracing the fullRestore operation
      */
     fullRestore(options) {
-        return withTrace$2("fullRestore", options, (updatedOptions) => this.client.fullRestoreOperation(this.vaultUrl, updatedOptions));
+        return withTrace$1("fullRestore", options, (updatedOptions) => this.client.fullRestoreOperation(this.vaultUrl, updatedOptions));
     }
     /**
      * Tracing the restoreStatus operation.
      */
     async restoreStatus(jobId, options) {
-        return withTrace$2("restoreStatus", options, (updatedOptions) => this.client.restoreStatus(this.vaultUrl, jobId, updatedOptions));
+        return withTrace$1("restoreStatus", options, (updatedOptions) => this.client.restoreStatus(this.vaultUrl, jobId, updatedOptions));
     }
     /**
      * Reaches to the service and updates the restore poll operation.
@@ -2353,7 +2375,7 @@ class KeyVaultRestorePoller extends KeyVaultAdminPoller {
 /**
  * @internal
  */
-const withTrace$3 = createTraceFunction("Azure.KeyVault.Admin.KeyVaultSelectiveKeyRestorePoller");
+const withTrace = createTraceFunction("Azure.KeyVault.Admin.KeyVaultSelectiveKeyRestorePoller");
 /**
  * The selective restore Key Vault's poll operation.
  */
@@ -2369,13 +2391,13 @@ class KeyVaultSelectiveKeyRestorePollOperation extends KeyVaultAdminPollOperatio
      * Tracing the selectiveRestore operation
      */
     selectiveRestore(keyName, options) {
-        return withTrace$3("selectiveRestore", options, (updatedOptions) => this.client.selectiveKeyRestoreOperation(this.vaultUrl, keyName, updatedOptions));
+        return withTrace("selectiveRestore", options, (updatedOptions) => this.client.selectiveKeyRestoreOperation(this.vaultUrl, keyName, updatedOptions));
     }
     /**
      * Tracing the restoreStatus operation.
      */
     restoreStatus(jobId, options) {
-        return withTrace$3("restoreStatus", options, (updatedOptions) => this.client.restoreStatus(this.vaultUrl, jobId, updatedOptions));
+        return withTrace("restoreStatus", options, (updatedOptions) => this.client.restoreStatus(this.vaultUrl, jobId, updatedOptions));
     }
     /**
      * Reaches to the service and updates the selective restore poll operation.