CloudHsmClusters interface
Interface representing a CloudHsmClusters.
Methods
Method Details
beginBackup(string, string, CloudHsmClustersBackupOptionalParams)
Create a backup of the Cloud HSM Cluster in the specified subscription
function beginBackup(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersBackupOptionalParams): Promise<SimplePollerLike<OperationState<CloudHsmClustersBackupResponse>, CloudHsmClustersBackupResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CloudHsmClustersBackupResponse>, CloudHsmClustersBackupResponse>>
beginBackupAndWait(string, string, CloudHsmClustersBackupOptionalParams)
Create a backup of the Cloud HSM Cluster in the specified subscription
function beginBackupAndWait(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersBackupOptionalParams): Promise<CloudHsmClustersBackupResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
The options parameters.
Returns
Promise<CloudHsmClustersBackupResponse>
beginCreateOrUpdate(string, string, string, CloudHsmClustersCreateOrUpdateOptionalParams)
Create or Update a Cloud HSM Cluster in the specified subscription.
function beginCreateOrUpdate(resourceGroupName: string, cloudHsmClusterName: string, location: string, options?: CloudHsmClustersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CloudHsmCluster>, CloudHsmCluster>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
- location
-
string
The geo-location where the resource lives
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CloudHsmCluster>, CloudHsmCluster>>
beginCreateOrUpdateAndWait(string, string, string, CloudHsmClustersCreateOrUpdateOptionalParams)
Create or Update a Cloud HSM Cluster in the specified subscription.
function beginCreateOrUpdateAndWait(resourceGroupName: string, cloudHsmClusterName: string, location: string, options?: CloudHsmClustersCreateOrUpdateOptionalParams): Promise<CloudHsmCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
- location
-
string
The geo-location where the resource lives
The options parameters.
Returns
Promise<CloudHsmCluster>
beginDelete(string, string, CloudHsmClustersDeleteOptionalParams)
Deletes the specified Cloud HSM Cluster
function beginDelete(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<CloudHsmClustersDeleteHeaders>, CloudHsmClustersDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CloudHsmClustersDeleteHeaders>, CloudHsmClustersDeleteHeaders>>
beginDeleteAndWait(string, string, CloudHsmClustersDeleteOptionalParams)
Deletes the specified Cloud HSM Cluster
function beginDeleteAndWait(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersDeleteOptionalParams): Promise<CloudHsmClustersDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
The options parameters.
Returns
Promise<CloudHsmClustersDeleteHeaders>
beginRestore(string, string, RestoreRequestProperties, CloudHsmClustersRestoreOptionalParams)
Restores all key materials of a specified Cloud HSM Cluster
function beginRestore(resourceGroupName: string, cloudHsmClusterName: string, restoreRequestProperties: RestoreRequestProperties, options?: CloudHsmClustersRestoreOptionalParams): Promise<SimplePollerLike<OperationState<CloudHsmClustersRestoreResponse>, CloudHsmClustersRestoreResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
- restoreRequestProperties
- RestoreRequestProperties
Restore Operation Required properties
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CloudHsmClustersRestoreResponse>, CloudHsmClustersRestoreResponse>>
beginRestoreAndWait(string, string, RestoreRequestProperties, CloudHsmClustersRestoreOptionalParams)
Restores all key materials of a specified Cloud HSM Cluster
function beginRestoreAndWait(resourceGroupName: string, cloudHsmClusterName: string, restoreRequestProperties: RestoreRequestProperties, options?: CloudHsmClustersRestoreOptionalParams): Promise<CloudHsmClustersRestoreResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
- restoreRequestProperties
- RestoreRequestProperties
Restore Operation Required properties
The options parameters.
Returns
Promise<CloudHsmClustersRestoreResponse>
beginUpdate(string, string, CloudHsmClustersUpdateOptionalParams)
Update a Cloud HSM Cluster in the specified subscription.
function beginUpdate(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CloudHsmCluster>, CloudHsmCluster>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CloudHsmCluster>, CloudHsmCluster>>
beginUpdateAndWait(string, string, CloudHsmClustersUpdateOptionalParams)
Update a Cloud HSM Cluster in the specified subscription.
function beginUpdateAndWait(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersUpdateOptionalParams): Promise<CloudHsmCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
The options parameters.
Returns
Promise<CloudHsmCluster>
beginValidateBackupProperties(string, string, CloudHsmClustersValidateBackupPropertiesOptionalParams)
Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription.
function beginValidateBackupProperties(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersValidateBackupPropertiesOptionalParams): Promise<SimplePollerLike<OperationState<CloudHsmClustersValidateBackupPropertiesResponse>, CloudHsmClustersValidateBackupPropertiesResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CloudHsmClustersValidateBackupPropertiesResponse>, CloudHsmClustersValidateBackupPropertiesResponse>>
beginValidateBackupPropertiesAndWait(string, string, CloudHsmClustersValidateBackupPropertiesOptionalParams)
Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription.
function beginValidateBackupPropertiesAndWait(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersValidateBackupPropertiesOptionalParams): Promise<CloudHsmClustersValidateBackupPropertiesResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
The options parameters.
Returns
beginValidateRestoreProperties(string, string, CloudHsmClustersValidateRestorePropertiesOptionalParams)
Queued validating pre restore operation
function beginValidateRestoreProperties(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersValidateRestorePropertiesOptionalParams): Promise<SimplePollerLike<OperationState<CloudHsmClustersValidateRestorePropertiesResponse>, CloudHsmClustersValidateRestorePropertiesResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CloudHsmClustersValidateRestorePropertiesResponse>, CloudHsmClustersValidateRestorePropertiesResponse>>
beginValidateRestorePropertiesAndWait(string, string, CloudHsmClustersValidateRestorePropertiesOptionalParams)
Queued validating pre restore operation
function beginValidateRestorePropertiesAndWait(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersValidateRestorePropertiesOptionalParams): Promise<CloudHsmClustersValidateRestorePropertiesResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
The options parameters.
Returns
get(string, string, CloudHsmClustersGetOptionalParams)
Gets the specified Cloud HSM Cluster
function get(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersGetOptionalParams): Promise<CloudHsmCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- cloudHsmClusterName
-
string
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.
The options parameters.
Returns
Promise<CloudHsmCluster>
listByResourceGroup(string, CloudHsmClustersListByResourceGroupOptionalParams)
The List operation gets information about the Cloud HSM Clusters associated with the subscription and within the specified resource group.
function listByResourceGroup(resourceGroupName: string, options?: CloudHsmClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<CloudHsmCluster, CloudHsmCluster[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(CloudHsmClustersListBySubscriptionOptionalParams)
The List operation gets information about the Cloud HSM Clusters associated with the subscription.
function listBySubscription(options?: CloudHsmClustersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<CloudHsmCluster, CloudHsmCluster[], PageSettings>Parameters
The options parameters.
