@azure/arm-hardwaresecuritymodules 2.0.0-beta.1 → 2.0.0-beta.2

package/src/operationsInterfaces/cloudHsmClusters.ts

@@ -18,7 +18,17 @@ import {
   CloudHsmClustersUpdateResponse,
   CloudHsmClustersGetOptionalParams,
   CloudHsmClustersGetResponse,
-  CloudHsmClustersDeleteOptionalParams
+  CloudHsmClustersDeleteOptionalParams,
+  CloudHsmClustersDeleteResponse,
+  CloudHsmClustersValidateBackupPropertiesOptionalParams,
+  CloudHsmClustersValidateBackupPropertiesResponse,
+  CloudHsmClustersBackupOptionalParams,
+  CloudHsmClustersBackupResponse,
+  CloudHsmClustersValidateRestorePropertiesOptionalParams,
+  CloudHsmClustersValidateRestorePropertiesResponse,
+  RestoreRequestProperties,
+  CloudHsmClustersRestoreOptionalParams,
+  CloudHsmClustersRestoreResponse,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -32,20 +42,20 @@ export interface CloudHsmClusters {
    */
   listByResourceGroup(
     resourceGroupName: string,
-    options?: CloudHsmClustersListByResourceGroupOptionalParams
+    options?: CloudHsmClustersListByResourceGroupOptionalParams,
   ): PagedAsyncIterableIterator<CloudHsmCluster>;
   /**
    * The List operation gets information about the Cloud HSM Clusters associated with the subscription.
    * @param options The options parameters.
    */
   listBySubscription(
-    options?: CloudHsmClustersListBySubscriptionOptionalParams
+    options?: CloudHsmClustersListBySubscriptionOptionalParams,
   ): PagedAsyncIterableIterator<CloudHsmCluster>;
   /**
    * Create or Update a Cloud HSM Cluster in the specified subscription.
    * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
-   *                            Cloud HSM Cluster names must be between 3 and 24 characters in length.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
    * @param location The geo-location where the resource lives
    * @param options The options parameters.
    */
@@ -53,7 +63,7 @@ export interface CloudHsmClusters {
     resourceGroupName: string,
     cloudHsmClusterName: string,
     location: string,
-    options?: CloudHsmClustersCreateOrUpdateOptionalParams
+    options?: CloudHsmClustersCreateOrUpdateOptionalParams,
   ): Promise<
     SimplePollerLike<
       OperationState<CloudHsmClustersCreateOrUpdateResponse>,
@@ -64,7 +74,7 @@ export interface CloudHsmClusters {
    * Create or Update a Cloud HSM Cluster in the specified subscription.
    * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
-   *                            Cloud HSM Cluster names must be between 3 and 24 characters in length.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
    * @param location The geo-location where the resource lives
    * @param options The options parameters.
    */
@@ -72,19 +82,19 @@ export interface CloudHsmClusters {
     resourceGroupName: string,
     cloudHsmClusterName: string,
     location: string,
-    options?: CloudHsmClustersCreateOrUpdateOptionalParams
+    options?: CloudHsmClustersCreateOrUpdateOptionalParams,
   ): Promise<CloudHsmClustersCreateOrUpdateResponse>;
   /**
    * Update a Cloud HSM Cluster in the specified subscription.
    * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
-   *                            Cloud HSM Cluster names must be between 3 and 24 characters in length.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
    * @param options The options parameters.
    */
   beginUpdate(
     resourceGroupName: string,
     cloudHsmClusterName: string,
-    options?: CloudHsmClustersUpdateOptionalParams
+    options?: CloudHsmClustersUpdateOptionalParams,
   ): Promise<
     SimplePollerLike<
       OperationState<CloudHsmClustersUpdateResponse>,
@@ -95,48 +105,175 @@ export interface CloudHsmClusters {
    * Update a Cloud HSM Cluster in the specified subscription.
    * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
-   *                            Cloud HSM Cluster names must be between 3 and 24 characters in length.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
    * @param options The options parameters.
    */
   beginUpdateAndWait(
     resourceGroupName: string,
     cloudHsmClusterName: string,
-    options?: CloudHsmClustersUpdateOptionalParams
+    options?: CloudHsmClustersUpdateOptionalParams,
   ): Promise<CloudHsmClustersUpdateResponse>;
   /**
    * Gets the specified Cloud HSM Cluster
    * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
-   *                            Cloud HSM Cluster names must be between 3 and 24 characters in length.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
    * @param options The options parameters.
    */
   get(
     resourceGroupName: string,
     cloudHsmClusterName: string,
-    options?: CloudHsmClustersGetOptionalParams
+    options?: CloudHsmClustersGetOptionalParams,
   ): Promise<CloudHsmClustersGetResponse>;
   /**
    * Deletes the specified Cloud HSM Cluster
    * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
-   *                            Cloud HSM Cluster names must be between 3 and 24 characters in length.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
    * @param options The options parameters.
    */
   beginDelete(
     resourceGroupName: string,
     cloudHsmClusterName: string,
-    options?: CloudHsmClustersDeleteOptionalParams
-  ): Promise<SimplePollerLike<OperationState<void>, void>>;
+    options?: CloudHsmClustersDeleteOptionalParams,
+  ): Promise<
+    SimplePollerLike<
+      OperationState<CloudHsmClustersDeleteResponse>,
+      CloudHsmClustersDeleteResponse
+    >
+  >;
   /**
    * Deletes the specified Cloud HSM Cluster
    * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
-   *                            Cloud HSM Cluster names must be between 3 and 24 characters in length.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
    * @param options The options parameters.
    */
   beginDeleteAndWait(
     resourceGroupName: string,
     cloudHsmClusterName: string,
-    options?: CloudHsmClustersDeleteOptionalParams
-  ): Promise<void>;
+    options?: CloudHsmClustersDeleteOptionalParams,
+  ): Promise<CloudHsmClustersDeleteResponse>;
+  /**
+   * Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster
+   * resource in the specified subscription.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
+   * @param options The options parameters.
+   */
+  beginValidateBackupProperties(
+    resourceGroupName: string,
+    cloudHsmClusterName: string,
+    options?: CloudHsmClustersValidateBackupPropertiesOptionalParams,
+  ): Promise<
+    SimplePollerLike<
+      OperationState<CloudHsmClustersValidateBackupPropertiesResponse>,
+      CloudHsmClustersValidateBackupPropertiesResponse
+    >
+  >;
+  /**
+   * Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster
+   * resource in the specified subscription.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
+   * @param options The options parameters.
+   */
+  beginValidateBackupPropertiesAndWait(
+    resourceGroupName: string,
+    cloudHsmClusterName: string,
+    options?: CloudHsmClustersValidateBackupPropertiesOptionalParams,
+  ): Promise<CloudHsmClustersValidateBackupPropertiesResponse>;
+  /**
+   * Create a backup of the Cloud HSM Cluster in the specified subscription
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
+   * @param options The options parameters.
+   */
+  beginBackup(
+    resourceGroupName: string,
+    cloudHsmClusterName: string,
+    options?: CloudHsmClustersBackupOptionalParams,
+  ): Promise<
+    SimplePollerLike<
+      OperationState<CloudHsmClustersBackupResponse>,
+      CloudHsmClustersBackupResponse
+    >
+  >;
+  /**
+   * Create a backup of the Cloud HSM Cluster in the specified subscription
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
+   * @param options The options parameters.
+   */
+  beginBackupAndWait(
+    resourceGroupName: string,
+    cloudHsmClusterName: string,
+    options?: CloudHsmClustersBackupOptionalParams,
+  ): Promise<CloudHsmClustersBackupResponse>;
+  /**
+   * Queued validating pre restore operation
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
+   * @param options The options parameters.
+   */
+  beginValidateRestoreProperties(
+    resourceGroupName: string,
+    cloudHsmClusterName: string,
+    options?: CloudHsmClustersValidateRestorePropertiesOptionalParams,
+  ): Promise<
+    SimplePollerLike<
+      OperationState<CloudHsmClustersValidateRestorePropertiesResponse>,
+      CloudHsmClustersValidateRestorePropertiesResponse
+    >
+  >;
+  /**
+   * Queued validating pre restore operation
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
+   * @param options The options parameters.
+   */
+  beginValidateRestorePropertiesAndWait(
+    resourceGroupName: string,
+    cloudHsmClusterName: string,
+    options?: CloudHsmClustersValidateRestorePropertiesOptionalParams,
+  ): Promise<CloudHsmClustersValidateRestorePropertiesResponse>;
+  /**
+   * Restores all key materials of a specified Cloud HSM Cluster
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
+   * @param restoreRequestProperties Restore Operation Required properties
+   * @param options The options parameters.
+   */
+  beginRestore(
+    resourceGroupName: string,
+    cloudHsmClusterName: string,
+    restoreRequestProperties: RestoreRequestProperties,
+    options?: CloudHsmClustersRestoreOptionalParams,
+  ): Promise<
+    SimplePollerLike<
+      OperationState<CloudHsmClustersRestoreResponse>,
+      CloudHsmClustersRestoreResponse
+    >
+  >;
+  /**
+   * Restores all key materials of a specified Cloud HSM Cluster
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
+   * @param restoreRequestProperties Restore Operation Required properties
+   * @param options The options parameters.
+   */
+  beginRestoreAndWait(
+    resourceGroupName: string,
+    cloudHsmClusterName: string,
+    restoreRequestProperties: RestoreRequestProperties,
+    options?: CloudHsmClustersRestoreOptionalParams,
+  ): Promise<CloudHsmClustersRestoreResponse>;
 }

package/src/operationsInterfaces/dedicatedHsmOperations.ts

@@ -19,8 +19,9 @@ import {
   DedicatedHsmUpdateOptionalParams,
   DedicatedHsmUpdateResponse,
   DedicatedHsmDeleteOptionalParams,
+  DedicatedHsmDeleteResponse,
   DedicatedHsmGetOptionalParams,
-  DedicatedHsmGetResponse
+  DedicatedHsmGetResponse,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -29,35 +30,35 @@ export interface DedicatedHsmOperations {
   /**
    * The List operation gets information about the dedicated hsms associated with the subscription and
    * within the specified resource group.
-   * @param resourceGroupName The name of the Resource Group to which the dedicated HSM belongs.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param options The options parameters.
    */
   listByResourceGroup(
     resourceGroupName: string,
-    options?: DedicatedHsmListByResourceGroupOptionalParams
+    options?: DedicatedHsmListByResourceGroupOptionalParams,
   ): PagedAsyncIterableIterator<DedicatedHsm>;
   /**
    * The List operation gets information about the dedicated HSMs associated with the subscription.
    * @param options The options parameters.
    */
   listBySubscription(
-    options?: DedicatedHsmListBySubscriptionOptionalParams
+    options?: DedicatedHsmListBySubscriptionOptionalParams,
   ): PagedAsyncIterableIterator<DedicatedHsm>;
   /**
    * Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified
    * dedicated hsm resource. The operation returns properties of each egress endpoint.
-   * @param resourceGroupName The name of the Resource Group to which the dedicated hsm belongs.
-   * @param name The name of the dedicated HSM.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param name Name of the dedicated Hsm
    * @param options The options parameters.
    */
   listOutboundNetworkDependenciesEndpoints(
     resourceGroupName: string,
     name: string,
-    options?: DedicatedHsmListOutboundNetworkDependenciesEndpointsOptionalParams
+    options?: DedicatedHsmListOutboundNetworkDependenciesEndpointsOptionalParams,
   ): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint>;
   /**
    * Create or Update a dedicated HSM in the specified subscription.
-   * @param resourceGroupName The name of the Resource Group to which the resource belongs.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param name Name of the dedicated Hsm
    * @param parameters Parameters to create or update the dedicated hsm
    * @param options The options parameters.
@@ -66,7 +67,7 @@ export interface DedicatedHsmOperations {
     resourceGroupName: string,
     name: string,
     parameters: DedicatedHsm,
-    options?: DedicatedHsmCreateOrUpdateOptionalParams
+    options?: DedicatedHsmCreateOrUpdateOptionalParams,
   ): Promise<
     SimplePollerLike<
       OperationState<DedicatedHsmCreateOrUpdateResponse>,
@@ -75,7 +76,7 @@ export interface DedicatedHsmOperations {
   >;
   /**
    * Create or Update a dedicated HSM in the specified subscription.
-   * @param resourceGroupName The name of the Resource Group to which the resource belongs.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param name Name of the dedicated Hsm
    * @param parameters Parameters to create or update the dedicated hsm
    * @param options The options parameters.
@@ -84,18 +85,18 @@ export interface DedicatedHsmOperations {
     resourceGroupName: string,
     name: string,
     parameters: DedicatedHsm,
-    options?: DedicatedHsmCreateOrUpdateOptionalParams
+    options?: DedicatedHsmCreateOrUpdateOptionalParams,
   ): Promise<DedicatedHsmCreateOrUpdateResponse>;
   /**
    * Update a dedicated HSM in the specified subscription.
-   * @param resourceGroupName The name of the Resource Group to which the server belongs.
-   * @param name Name of the dedicated HSM
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param name Name of the dedicated Hsm
    * @param options The options parameters.
    */
   beginUpdate(
     resourceGroupName: string,
     name: string,
-    options?: DedicatedHsmUpdateOptionalParams
+    options?: DedicatedHsmUpdateOptionalParams,
   ): Promise<
     SimplePollerLike<
       OperationState<DedicatedHsmUpdateResponse>,
@@ -104,46 +105,51 @@ export interface DedicatedHsmOperations {
   >;
   /**
    * Update a dedicated HSM in the specified subscription.
-   * @param resourceGroupName The name of the Resource Group to which the server belongs.
-   * @param name Name of the dedicated HSM
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param name Name of the dedicated Hsm
    * @param options The options parameters.
    */
   beginUpdateAndWait(
     resourceGroupName: string,
     name: string,
-    options?: DedicatedHsmUpdateOptionalParams
+    options?: DedicatedHsmUpdateOptionalParams,
   ): Promise<DedicatedHsmUpdateResponse>;
   /**
    * Deletes the specified Azure Dedicated HSM.
-   * @param resourceGroupName The name of the Resource Group to which the dedicated HSM belongs.
-   * @param name The name of the dedicated HSM to delete
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param name Name of the dedicated Hsm
    * @param options The options parameters.
    */
   beginDelete(
     resourceGroupName: string,
     name: string,
-    options?: DedicatedHsmDeleteOptionalParams
-  ): Promise<SimplePollerLike<OperationState<void>, void>>;
+    options?: DedicatedHsmDeleteOptionalParams,
+  ): Promise<
+    SimplePollerLike<
+      OperationState<DedicatedHsmDeleteResponse>,
+      DedicatedHsmDeleteResponse
+    >
+  >;
   /**
    * Deletes the specified Azure Dedicated HSM.
-   * @param resourceGroupName The name of the Resource Group to which the dedicated HSM belongs.
-   * @param name The name of the dedicated HSM to delete
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param name Name of the dedicated Hsm
    * @param options The options parameters.
    */
   beginDeleteAndWait(
     resourceGroupName: string,
     name: string,
-    options?: DedicatedHsmDeleteOptionalParams
-  ): Promise<void>;
+    options?: DedicatedHsmDeleteOptionalParams,
+  ): Promise<DedicatedHsmDeleteResponse>;
   /**
    * Gets the specified Azure dedicated HSM.
-   * @param resourceGroupName The name of the Resource Group to which the dedicated hsm belongs.
-   * @param name The name of the dedicated HSM.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param name Name of the dedicated Hsm
    * @param options The options parameters.
    */
   get(
     resourceGroupName: string,
     name: string,
-    options?: DedicatedHsmGetOptionalParams
+    options?: DedicatedHsmGetOptionalParams,
   ): Promise<DedicatedHsmGetResponse>;
 }

package/src/operationsInterfaces/index.ts

@@ -10,5 +10,7 @@ export * from "./cloudHsmClusters";
 export * from "./cloudHsmClusterPrivateLinkResources";
 export * from "./cloudHsmClusterPrivateEndpointConnections";
 export * from "./privateEndpointConnections";
-export * from "./operations";
+export * from "./cloudHsmClusterBackupStatus";
+export * from "./cloudHsmClusterRestoreStatus";
 export * from "./dedicatedHsmOperations";
+export * from "./operations";

package/src/operationsInterfaces/operations.ts

@@ -7,16 +7,16 @@
  */
 
 import { PagedAsyncIterableIterator } from "@azure/core-paging";
-import { DedicatedHsmOperation, OperationsListOptionalParams } from "../models";
+import { Operation, OperationsListOptionalParams } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
 /** Interface representing a Operations. */
 export interface Operations {
   /**
-   * Get a list of Dedicated HSM operations.
+   * Get a list of Hardware Security Modules operations.
    * @param options The options parameters.
    */
   list(
-    options?: OperationsListOptionalParams
-  ): PagedAsyncIterableIterator<DedicatedHsmOperation>;
+    options?: OperationsListOptionalParams,
+  ): PagedAsyncIterableIterator<Operation>;
 }

package/src/operationsInterfaces/privateEndpointConnections.ts

@@ -9,7 +9,7 @@
 import { PagedAsyncIterableIterator } from "@azure/core-paging";
 import {
   PrivateEndpointConnection,
-  PrivateEndpointConnectionsListByCloudHsmClusterOptionalParams
+  PrivateEndpointConnectionsListByCloudHsmClusterOptionalParams,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -20,12 +20,12 @@ export interface PrivateEndpointConnections {
    * HSM Cluster
    * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param cloudHsmClusterName The name of the Cloud HSM Cluster within the specified resource group.
-   *                            Cloud HSM Cluster names must be between 3 and 24 characters in length.
+   *                            Cloud HSM Cluster names must be between 3 and 23 characters in length.
    * @param options The options parameters.
    */
   listByCloudHsmCluster(
     resourceGroupName: string,
     cloudHsmClusterName: string,
-    options?: PrivateEndpointConnectionsListByCloudHsmClusterOptionalParams
+    options?: PrivateEndpointConnectionsListByCloudHsmClusterOptionalParams,
   ): PagedAsyncIterableIterator<PrivateEndpointConnection>;
 }

package/src/pagingHelper.ts

@@ -28,7 +28,7 @@ export function getContinuationToken(page: unknown): string | undefined {
 
 export function setContinuationToken(
   page: unknown,
-  continuationToken: string | undefined
+  continuationToken: string | undefined,
 ): void {
   if (typeof page !== "object" || page === null || !continuationToken) {
     return;