CloudHsmClusters Interface

Package:

com.azure.resourcemanager.hardwaresecuritymodules.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-hardwaresecuritymodules:1.1.0

public interface CloudHsmClusters

Resource collection API of CloudHsmClusters.

Method Summary

Modifier and Type	Method and Description
abstract BackupResult	backup(String resourceGroupName, String cloudHsmClusterName) Create a backup of the Cloud HSM Cluster in the specified subscription.
abstract BackupResult	backup(String resourceGroupName, String cloudHsmClusterName, BackupRequestProperties backupRequestProperties, Context context) Create a backup of the Cloud HSM Cluster in the specified subscription.
abstract Blank	define(String name) Begins definition for a new CloudHsmCluster resource.
abstract void	delete(String resourceGroupName, String cloudHsmClusterName, Context context) Deletes the specified Cloud HSM Cluster.
abstract void	deleteById(String id) Deletes the specified Cloud HSM Cluster.
abstract void	deleteByIdWithResponse(String id, Context context) Deletes the specified Cloud HSM Cluster.
abstract void	deleteByResourceGroup(String resourceGroupName, String cloudHsmClusterName) Deletes the specified Cloud HSM Cluster.
abstract CloudHsmCluster	getById(String id) Gets the specified Cloud HSM Cluster.
abstract Response<CloudHsmCluster>	getByIdWithResponse(String id, Context context) Gets the specified Cloud HSM Cluster.
abstract CloudHsmCluster	getByResourceGroup(String resourceGroupName, String cloudHsmClusterName) Gets the specified Cloud HSM Cluster.
abstract Response<CloudHsmCluster>	getByResourceGroupWithResponse(String resourceGroupName, String cloudHsmClusterName, Context context) Gets the specified Cloud HSM Cluster.
abstract PagedIterable<CloudHsmCluster>	list() The List operation gets information about the Cloud HSM Clusters associated with the subscription.
abstract PagedIterable<CloudHsmCluster>	list(String skiptoken, Context context) The List operation gets information about the Cloud HSM Clusters associated with the subscription.
abstract PagedIterable<CloudHsmCluster>	listByResourceGroup(String resourceGroupName) The List operation gets information about the Cloud HSM Clusters associated with the subscription and within the specified resource group.
abstract PagedIterable<CloudHsmCluster>	listByResourceGroup(String resourceGroupName, String skiptoken, Context context) The List operation gets information about the Cloud HSM Clusters associated with the subscription and within the specified resource group.
abstract RestoreResult	restore(String resourceGroupName, String cloudHsmClusterName, RestoreRequestProperties restoreRequestProperties) Restores all key materials of a specified Cloud HSM Cluster.
abstract RestoreResult	restore(String resourceGroupName, String cloudHsmClusterName, RestoreRequestProperties restoreRequestProperties, Context context) Restores all key materials of a specified Cloud HSM Cluster.
abstract BackupResult	validateBackupProperties(String resourceGroupName, String cloudHsmClusterName) Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription.
abstract BackupResult	validateBackupProperties(String resourceGroupName, String cloudHsmClusterName, BackupRequestProperties backupRequestProperties, Context context) Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription.
abstract RestoreResult	validateRestoreProperties(String resourceGroupName, String cloudHsmClusterName) Queued validating pre restore operation.
abstract RestoreResult	validateRestoreProperties(String resourceGroupName, String cloudHsmClusterName, RestoreRequestProperties restoreRequestProperties, Context context) Queued validating pre restore operation.

Method Details

backup

public abstract BackupResult backup(String resourceGroupName, String cloudHsmClusterName)

Create a backup of the Cloud HSM Cluster in the specified subscription.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

Returns:

the response.

backup

public abstract BackupResult backup(String resourceGroupName, String cloudHsmClusterName, BackupRequestProperties backupRequestProperties, Context context)

Create a backup of the Cloud HSM Cluster in the specified subscription.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

backupRequestProperties - Azure storage Resource Uri.

context - The context to associate with this operation.

Returns:

the response.

define

public abstract CloudHsmCluster.DefinitionStages.Blank define(String name)

Begins definition for a new CloudHsmCluster resource.

Parameters:

name - resource name.

Returns:

the first stage of the new CloudHsmCluster definition.

delete

public abstract void delete(String resourceGroupName, String cloudHsmClusterName, Context context)

Deletes the specified Cloud HSM Cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Deletes the specified Cloud HSM Cluster.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes the specified Cloud HSM Cluster.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String cloudHsmClusterName)

Deletes the specified Cloud HSM Cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

getById

public abstract CloudHsmCluster getById(String id)

Gets the specified Cloud HSM Cluster.

Parameters:

id - the resource ID.

Returns:

the specified Cloud HSM Cluster along with Response<T>.

getByIdWithResponse

public abstract Response<CloudHsmCluster> getByIdWithResponse(String id, Context context)

Gets the specified Cloud HSM Cluster.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the specified Cloud HSM Cluster along with Response<T>.

getByResourceGroup

public abstract CloudHsmCluster getByResourceGroup(String resourceGroupName, String cloudHsmClusterName)

Gets the specified Cloud HSM Cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

Returns:

the specified Cloud HSM Cluster.

getByResourceGroupWithResponse

public abstract Response<CloudHsmCluster> getByResourceGroupWithResponse(String resourceGroupName, String cloudHsmClusterName, Context context)

Gets the specified Cloud HSM Cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

context - The context to associate with this operation.

Returns:

the specified Cloud HSM Cluster along with Response<T>.

list

public abstract PagedIterable<CloudHsmCluster> list()

The List operation gets information about the Cloud HSM Clusters associated with the subscription.

Returns:

the response of a CloudHsmCluster list operation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<CloudHsmCluster> list(String skiptoken, Context context)

The List operation gets information about the Cloud HSM Clusters associated with the subscription.

Parameters:

skiptoken - The page-continuation token to use with a paged version of this API.

context - The context to associate with this operation.

Returns:

the response of a CloudHsmCluster list operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<CloudHsmCluster> listByResourceGroup(String resourceGroupName)

The List operation gets information about the Cloud HSM Clusters associated with the subscription and within the specified resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

the response of a CloudHsmCluster list operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<CloudHsmCluster> listByResourceGroup(String resourceGroupName, String skiptoken, Context context)

The List operation gets information about the Cloud HSM Clusters associated with the subscription and within the specified resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

skiptoken - The page-continuation token to use with a paged version of this API.

context - The context to associate with this operation.

Returns:

the response of a CloudHsmCluster list operation as paginated response with PagedIterable<T>.

restore

public abstract RestoreResult restore(String resourceGroupName, String cloudHsmClusterName, RestoreRequestProperties restoreRequestProperties)

Restores all key materials of a specified Cloud HSM Cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

restoreRequestProperties - Restore Operation Required properties.

Returns:

the response.

restore

public abstract RestoreResult restore(String resourceGroupName, String cloudHsmClusterName, RestoreRequestProperties restoreRequestProperties, Context context)

Restores all key materials of a specified Cloud HSM Cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

restoreRequestProperties - Restore Operation Required properties.

context - The context to associate with this operation.

Returns:

the response.

validateBackupProperties

public abstract BackupResult validateBackupProperties(String resourceGroupName, String cloudHsmClusterName)

Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

Returns:

the response.

validateBackupProperties

public abstract BackupResult validateBackupProperties(String resourceGroupName, String cloudHsmClusterName, BackupRequestProperties backupRequestProperties, Context context)

Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

backupRequestProperties - Backup Operation Required properties.

context - The context to associate with this operation.

Returns:

the response.

validateRestoreProperties

public abstract RestoreResult validateRestoreProperties(String resourceGroupName, String cloudHsmClusterName)

Queued validating pre restore operation.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

Returns:

the response.

validateRestoreProperties

public abstract RestoreResult validateRestoreProperties(String resourceGroupName, String cloudHsmClusterName, RestoreRequestProperties restoreRequestProperties, Context context)

Queued validating pre restore operation.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

restoreRequestProperties - Optional Parameters to validate prior performing a restore operation.

context - The context to associate with this operation.

Returns:

the response.