Share via

CloudHsmClustersOperations interface

Package:
@azure/arm-hardwaresecuritymodules

Interface representing a CloudHsmClusters operations.

Properties

backup

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

Create or Update a Cloud HSM Cluster in the specified subscription.
delete
get

Gets the specified Cloud HSM Cluster
listByResourceGroup

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

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

Restores all key materials of a specified Cloud HSM Cluster
update

Update a Cloud HSM Cluster in the specified subscription.
validateBackupProperties

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

Queued validating pre restore operation

Property Details

backup

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

backup: (resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersBackupOptionalParams) => PollerLike<OperationState<BackupResult>, BackupResult>

Property Value

(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersBackupOptionalParams) => PollerLike<OperationState<BackupResult>, BackupResult>

createOrUpdate

Create or Update a Cloud HSM Cluster in the specified subscription.

createOrUpdate: (resourceGroupName: string, cloudHsmClusterName: string, body: CloudHsmCluster, options?: CloudHsmClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<CloudHsmCluster>, CloudHsmCluster>

Property Value

(resourceGroupName: string, cloudHsmClusterName: string, body: CloudHsmCluster, options?: CloudHsmClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<CloudHsmCluster>, CloudHsmCluster>

delete 

delete: (resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the specified Cloud HSM Cluster

get: (resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersGetOptionalParams) => Promise<CloudHsmCluster>

Property Value

(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersGetOptionalParams) => Promise<CloudHsmCluster>

listByResourceGroup

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

listByResourceGroup: (resourceGroupName: string, options?: CloudHsmClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<CloudHsmCluster, CloudHsmCluster[], PageSettings>

Property Value

(resourceGroupName: string, options?: CloudHsmClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<CloudHsmCluster, CloudHsmCluster[], PageSettings>

listBySubscription

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

listBySubscription: (options?: CloudHsmClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<CloudHsmCluster, CloudHsmCluster[], PageSettings>

Property Value

(options?: CloudHsmClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<CloudHsmCluster, CloudHsmCluster[], PageSettings>

restore

Restores all key materials of a specified Cloud HSM Cluster

restore: (resourceGroupName: string, cloudHsmClusterName: string, restoreRequestProperties: RestoreRequestProperties, options?: CloudHsmClustersRestoreOptionalParams) => PollerLike<OperationState<RestoreResult>, RestoreResult>

Property Value

(resourceGroupName: string, cloudHsmClusterName: string, restoreRequestProperties: RestoreRequestProperties, options?: CloudHsmClustersRestoreOptionalParams) => PollerLike<OperationState<RestoreResult>, RestoreResult>

update

Update a Cloud HSM Cluster in the specified subscription.

update: (resourceGroupName: string, cloudHsmClusterName: string, body: CloudHsmClusterPatchParameters, options?: CloudHsmClustersUpdateOptionalParams) => PollerLike<OperationState<CloudHsmCluster>, CloudHsmCluster>

Property Value

(resourceGroupName: string, cloudHsmClusterName: string, body: CloudHsmClusterPatchParameters, options?: CloudHsmClustersUpdateOptionalParams) => PollerLike<OperationState<CloudHsmCluster>, CloudHsmCluster>

validateBackupProperties

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

validateBackupProperties: (resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersValidateBackupPropertiesOptionalParams) => PollerLike<OperationState<BackupResult>, BackupResult>

Property Value

(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersValidateBackupPropertiesOptionalParams) => PollerLike<OperationState<BackupResult>, BackupResult>

validateRestoreProperties

Queued validating pre restore operation

validateRestoreProperties: (resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersValidateRestorePropertiesOptionalParams) => PollerLike<OperationState<RestoreResult>, RestoreResult>

Property Value

(resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersValidateRestorePropertiesOptionalParams) => PollerLike<OperationState<RestoreResult>, RestoreResult>