@azure/keyvault-admin 4.3.1-alpha.20221107.3 → 4.4.0-beta.1

package/dist/index.js

@@ -629,6 +629,70 @@ const SelectiveKeyRestoreOperation = {
         }
     }
 };
+const UpdateSettingRequest = {
+    type: {
+        name: "Composite",
+        className: "UpdateSettingRequest",
+        modelProperties: {
+            value: {
+                serializedName: "value",
+                required: true,
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
+const Setting = {
+    type: {
+        name: "Composite",
+        className: "Setting",
+        modelProperties: {
+            name: {
+                serializedName: "name",
+                required: true,
+                type: {
+                    name: "String"
+                }
+            },
+            value: {
+                serializedName: "value",
+                required: true,
+                type: {
+                    name: "String"
+                }
+            },
+            type: {
+                serializedName: "type",
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
+const SettingsListResult = {
+    type: {
+        name: "Composite",
+        className: "SettingsListResult",
+        modelProperties: {
+            settings: {
+                serializedName: "settings",
+                readOnly: true,
+                type: {
+                    name: "Sequence",
+                    element: {
+                        type: {
+                            name: "Composite",
+                            className: "Setting"
+                        }
+                    }
+                }
+            }
+        }
+    }
+};
 const RoleAssignmentFilter = {
     type: {
         name: "Composite",
@@ -738,6 +802,9 @@ var Mappers = /*#__PURE__*/Object.freeze({
     RestoreOperation: RestoreOperation,
     SelectiveKeyRestoreOperationParameters: SelectiveKeyRestoreOperationParameters,
     SelectiveKeyRestoreOperation: SelectiveKeyRestoreOperation,
+    UpdateSettingRequest: UpdateSettingRequest,
+    Setting: Setting,
+    SettingsListResult: SettingsListResult,
     RoleAssignmentFilter: RoleAssignmentFilter,
     RoleDefinitionFilter: RoleDefinitionFilter,
     KeyVaultClientFullBackupHeaders: KeyVaultClientFullBackupHeaders,
@@ -886,6 +953,16 @@ const keyName = {
         }
     }
 };
+const settingName = {
+    parameterPath: "settingName",
+    mapper: {
+        serializedName: "setting-name",
+        required: true,
+        type: {
+            name: "String"
+        }
+    }
+};
 
 /*
  * Copyright (c) Microsoft Corporation.
@@ -1246,7 +1323,7 @@ class KeyVaultClientContext extends coreClient__namespace.ServiceClient {
         const defaults = {
             requestContentType: "application/json; charset=utf-8"
         };
-        const packageDetails = `azsdk-js-keyvault-admin/4.3.1`;
+        const packageDetails = `azsdk-js-keyvault-admin/4.4.0-beta.1`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -1278,8 +1355,7 @@ class KeyVaultClient extends KeyVaultClientContext {
         this.roleAssignments = new RoleAssignmentsImpl(this);
     }
     /**
-     * Creates a full backup using a user-provided SAS token to an Azure blob storage container. This
-     * operation is supported only by the Managed HSM service.
+     * Creates a full backup using a user-provided SAS token to an Azure blob storage container.
      * @param vaultBaseUrl The vault name, for example https://myvault.vault.azure.net.
      * @param options The options parameters.
      */
@@ -1323,6 +1399,33 @@ class KeyVaultClient extends KeyVaultClientContext {
     selectiveKeyRestoreOperation(vaultBaseUrl, keyName, options) {
         return this.sendOperationRequest({ vaultBaseUrl, keyName, options }, selectiveKeyRestoreOperationOperationSpec);
     }
+    /**
+     * Description of the pool setting to be updated
+     * @param vaultBaseUrl The vault name, for example https://myvault.vault.azure.net.
+     * @param settingName The name of the account setting. Must be a valid settings option.
+     * @param value The value of the pool setting.
+     * @param options The options parameters.
+     */
+    updateSetting(vaultBaseUrl, settingName, value, options) {
+        return this.sendOperationRequest({ vaultBaseUrl, settingName, value, options }, updateSettingOperationSpec);
+    }
+    /**
+     * Retrieves the setting object of a specified setting name.
+     * @param vaultBaseUrl The vault name, for example https://myvault.vault.azure.net.
+     * @param settingName The name of the account setting. Must be a valid settings option.
+     * @param options The options parameters.
+     */
+    getSetting(vaultBaseUrl, settingName, options) {
+        return this.sendOperationRequest({ vaultBaseUrl, settingName, options }, getSettingOperationSpec);
+    }
+    /**
+     * Retrieves a list of all the available account settings that can be configured.
+     * @param vaultBaseUrl The vault name, for example https://myvault.vault.azure.net.
+     * @param options The options parameters.
+     */
+    getSettings(vaultBaseUrl, options) {
+        return this.sendOperationRequest({ vaultBaseUrl, options }, getSettingsOperationSpec);
+    }
 }
 // Operation Specifications
 const serializer = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
@@ -1415,17 +1518,70 @@ const selectiveKeyRestoreOperationOperationSpec = {
     mediaType: "json",
     serializer
 };
+const updateSettingOperationSpec = {
+    path: "/settings/{setting-name}",
+    httpMethod: "PATCH",
+    responses: {
+        200: {
+            bodyMapper: Setting
+        },
+        default: {
+            bodyMapper: KeyVaultError
+        }
+    },
+    requestBody: {
+        parameterPath: { value: ["value"] },
+        mapper: Object.assign(Object.assign({}, UpdateSettingRequest), { required: true })
+    },
+    queryParameters: [apiVersion],
+    urlParameters: [vaultBaseUrl, settingName],
+    headerParameters: [accept, contentType],
+    mediaType: "json",
+    serializer
+};
+const getSettingOperationSpec = {
+    path: "/settings/{setting-name}",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Setting
+        },
+        default: {
+            bodyMapper: KeyVaultError
+        }
+    },
+    queryParameters: [apiVersion],
+    urlParameters: [vaultBaseUrl, settingName],
+    headerParameters: [accept],
+    serializer
+};
+const getSettingsOperationSpec = {
+    path: "/settings",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: SettingsListResult
+        },
+        default: {
+            bodyMapper: KeyVaultError
+        }
+    },
+    queryParameters: [apiVersion],
+    urlParameters: [vaultBaseUrl],
+    headerParameters: [accept],
+    serializer
+};
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 /**
  * Current version of the Key Vault Admin SDK.
  */
-const SDK_VERSION = "4.3.1";
+const SDK_VERSION = "4.4.0-beta.1";
 /**
  * The latest supported Key Vault service API version.
  */
-const LATEST_API_VERSION = "7.3";
+const LATEST_API_VERSION = "7.4-preview.1";
 
 // Copyright (c) Microsoft Corporation.
 /**
@@ -1832,12 +1988,12 @@ class KeyVaultAccessControlClient {
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-/** Known values of {@link ApiVersion73} that the service accepts. */
-var KnownApiVersion73;
-(function (KnownApiVersion73) {
-    /** Api Version '7.3' */
-    KnownApiVersion73["Seven3"] = "7.3";
-})(KnownApiVersion73 || (KnownApiVersion73 = {}));
+/** Known values of {@link ApiVersion74Preview1} that the service accepts. */
+var KnownApiVersion74Preview1;
+(function (KnownApiVersion74Preview1) {
+    /** Api Version '7.4-preview.1' */
+    KnownApiVersion74Preview1["Seven4Preview1"] = "7.4-preview.1";
+})(KnownApiVersion74Preview1 || (KnownApiVersion74Preview1 = {}));
 /** Known values of {@link RoleType} that the service accepts. */
 var KnownRoleType;
 (function (KnownRoleType) {
@@ -1931,6 +2087,11 @@ var KnownRoleDefinitionType;
 (function (KnownRoleDefinitionType) {
     KnownRoleDefinitionType["MicrosoftAuthorizationRoleDefinitions"] = "Microsoft.Authorization/roleDefinitions";
 })(KnownRoleDefinitionType || (KnownRoleDefinitionType = {}));
+/** Known values of {@link SettingTypeEnum} that the service accepts. */
+var KnownSettingTypeEnum;
+(function (KnownSettingTypeEnum) {
+    KnownSettingTypeEnum["Boolean"] = "boolean";
+})(KnownSettingTypeEnum || (KnownSettingTypeEnum = {}));
 
 // Copyright (c) Microsoft Corporation.
 /**
@@ -2460,8 +2621,97 @@ class KeyVaultBackupClient {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+function makeSetting(generatedSetting) {
+    if (generatedSetting.type === "boolean") {
+        return {
+            name: generatedSetting.name,
+            value: generatedSetting.value === "true" ? true : false,
+            kind: "boolean",
+        };
+    }
+    else {
+        return {
+            name: generatedSetting.name,
+            value: generatedSetting.value,
+        };
+    }
+}
+/**
+ * The KeyVaultSettingsClient provides asynchronous methods to create, update, get and list
+ * settings for the Azure Key Vault.
+ */
+class KeyVaultSettingsClient {
+    /**
+     * Creates an instance of the KeyVaultSettingsClient.
+     *
+     * Example usage:
+     * ```ts
+     * import { KeyVaultSettingsClient } from "@azure/keyvault-admin";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * let vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
+     * let credentials = new DefaultAzureCredential();
+     *
+     * let client = new KeyVaultSettingsClient(vaultUrl, credentials);
+     * ```
+     * @param vaultUrl - the URL of the Key Vault. It should have this shape: `https://${your-key-vault-name}.vault.azure.net`. You should validate that this URL references a valid Key Vault or Managed HSM resource. See https://aka.ms/azsdk/blog/vault-uri for details.
+     * @param credential - An object that implements the `TokenCredential` interface used to authenticate requests to the service. Use the \@azure/identity package to create a credential that suits your needs.
+     * @param options - options used to configure Key Vault API requests.
+  
+     */
+    constructor(vaultUrl, credential, options = {}) {
+        this.vaultUrl = vaultUrl;
+        const apiVersion = options.serviceVersion || LATEST_API_VERSION;
+        const clientOptions = Object.assign(Object.assign({}, options), { loggingOptions: {
+                logger: logger.info,
+                additionalAllowedHeaderNames: [
+                    "x-ms-keyvault-region",
+                    "x-ms-keyvault-network-info",
+                    "x-ms-keyvault-service-version",
+                ],
+            } });
+        this.client = new KeyVaultClient(apiVersion, clientOptions);
+        this.client.pipeline.addPolicy(coreRestPipeline.bearerTokenAuthenticationPolicy({
+            credential,
+            scopes: [],
+            challengeCallbacks: keyvaultCommon.createKeyVaultChallengeCallbacks(options),
+        }));
+    }
+    /**
+     * Updates the named account setting.
+     *
+     * @param settingName - the name of the account setting. Must be a valid settings option.
+     * @param value - the value of the pool setting.
+     * @param options - the optional parameters.
+     */
+    async updateSetting(settingName, value, options = {}) {
+        return makeSetting(await this.client.updateSetting(this.vaultUrl, settingName, String(value), options));
+    }
+    /**
+     * Get the value of a specific account setting.
+     *
+     * @param settingName - the name of the setting.
+     * @param options - the optional parameters.
+     */
+    async getSetting(settingName, options = {}) {
+        return makeSetting(await this.client.getSetting(this.vaultUrl, settingName, options));
+    }
+    /**
+     * List the account's settings.
+     *
+     * @param options - the optional parameters.
+     */
+    async getSettings(options = {}) {
+        var _a;
+        const { settings } = await this.client.getSettings(this.vaultUrl, options);
+        return { settings: (_a = settings === null || settings === void 0 ? void 0 : settings.map(makeSetting)) !== null && _a !== void 0 ? _a : [] };
+    }
+}
+
 exports.KeyVaultAccessControlClient = KeyVaultAccessControlClient;
 exports.KeyVaultBackupClient = KeyVaultBackupClient;
+exports.KeyVaultSettingsClient = KeyVaultSettingsClient;
 exports.LATEST_API_VERSION = LATEST_API_VERSION;
 exports.SDK_VERSION = SDK_VERSION;
 //# sourceMappingURL=index.js.map