CloudHsmCluster Interface

Package:

com.azure.resourcemanager.hardwaresecuritymodules.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-hardwaresecuritymodules:1.0.0-beta.3

public interface CloudHsmCluster

An immutable client-side representation of CloudHsmCluster.

Method Summary

Modifier and Type	Method and Description
abstract BackupResult	backup() Create a backup of the Cloud HSM Cluster in the specified subscription.
abstract BackupResult	backup(BackupRequestProperties backupRequestProperties, Context context) Create a backup of the Cloud HSM Cluster in the specified subscription.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract ManagedServiceIdentity	identity() Gets the identity property: Managed service identity (system assigned and/or user assigned identities).
abstract CloudHsmClusterInner	innerModel() Gets the inner com.azure.resourcemanager.hardwaresecuritymodules.fluent.models.CloudHsmClusterInner object.
abstract String	location() Gets the location property: The geo-location where the resource lives.
abstract String	name() Gets the name property: The name of the resource.
abstract CloudHsmClusterProperties	properties() Gets the properties property: Properties of the Cloud HSM Cluster.
abstract CloudHsmCluster	refresh() Refreshes the resource to sync with Azure.
abstract CloudHsmCluster	refresh(Context context) Refreshes the resource to sync with Azure.
abstract Region	region() Gets the region of the resource.
abstract String	regionName() Gets the name of the resource region.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract RestoreResult	restore(RestoreRequestProperties restoreRequestProperties) Restores all key materials of a specified Cloud HSM Cluster.
abstract RestoreResult	restore(RestoreRequestProperties restoreRequestProperties, Context context) Restores all key materials of a specified Cloud HSM Cluster.
abstract CloudHsmClusterSku	sku() Gets the sku property: SKU details.
abstract SystemData	systemData() Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
abstract Map<String,String>	tags() Gets the tags property: Resource tags.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the CloudHsmCluster resource.
abstract BackupResult	validateBackupProperties() 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(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() Queued validating pre restore operation.
abstract RestoreResult	validateRestoreProperties(RestoreRequestProperties restoreRequestProperties, Context context) Queued validating pre restore operation.

Method Details

backup

public abstract BackupResult backup()

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

Returns:

backup operation Result.

backup

public abstract BackupResult backup(BackupRequestProperties backupRequestProperties, Context context)

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

Parameters:

backupRequestProperties - Azure storage Resource Uri.

context - The context to associate with this operation.

Returns:

backup operation Result.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

identity

public abstract ManagedServiceIdentity identity()

Gets the identity property: Managed service identity (system assigned and/or user assigned identities).

Returns:

the identity value.

innerModel

public abstract CloudHsmClusterInner innerModel()

Gets the inner com.azure.resourcemanager.hardwaresecuritymodules.fluent.models.CloudHsmClusterInner object.

Returns:

the inner object.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

properties

public abstract CloudHsmClusterProperties properties()

Gets the properties property: Properties of the Cloud HSM Cluster.

Returns:

the properties value.

refresh

public abstract CloudHsmCluster refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract CloudHsmCluster refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

restore

public abstract RestoreResult restore(RestoreRequestProperties restoreRequestProperties)

Restores all key materials of a specified Cloud HSM Cluster.

Parameters:

restoreRequestProperties - Restore Operation Required properties.

Returns:

restore operation properties.

restore

public abstract RestoreResult restore(RestoreRequestProperties restoreRequestProperties, Context context)

Restores all key materials of a specified Cloud HSM Cluster.

Parameters:

restoreRequestProperties - Restore Operation Required properties.

context - The context to associate with this operation.

Returns:

restore operation properties.

sku

public abstract CloudHsmClusterSku sku()

Gets the sku property: SKU details.

Returns:

the sku value.

systemData

public abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract CloudHsmCluster.Update update()

Begins update for the CloudHsmCluster resource.

Returns:

the stage of resource update.

validateBackupProperties

public abstract BackupResult validateBackupProperties()

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

Returns:

backup operation Result.

validateBackupProperties

public abstract BackupResult validateBackupProperties(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:

backupRequestProperties - Backup Operation Required properties.

context - The context to associate with this operation.

Returns:

backup operation Result.

validateRestoreProperties

public abstract RestoreResult validateRestoreProperties()

Queued validating pre restore operation.

Returns:

restore operation properties.

validateRestoreProperties

public abstract RestoreResult validateRestoreProperties(RestoreRequestProperties restoreRequestProperties, Context context)

Queued validating pre restore operation.

Parameters:

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

context - The context to associate with this operation.

Returns:

restore operation properties.