cloud_hsm_cluster_backup_status
Creates, updates, deletes, gets or lists a cloud_hsm_cluster_backup_status resource.
Overview
| Name | cloud_hsm_cluster_backup_status |
| Type | Resource |
| Id | azure.hardware_security_modules.cloud_hsm_cluster_backup_status |
Fields
The following fields are returned by SELECT queries:
- get
Cloud HSM Cluster Backup Operation status returned
| Name | Datatype | Description |
|---|---|---|
properties | object | Properties of the Cloud HSM Cluster |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, cloudHsmClusterName, jobId | Gets the backup operation status of the specified Cloud HSM Cluster |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
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. |
jobId | string | The id returned as part of the backup request |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
SELECT examples
- get
Gets the backup operation status of the specified Cloud HSM Cluster
SELECT
properties
FROM azure.hardware_security_modules.cloud_hsm_cluster_backup_status
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND cloudHsmClusterName = '{{ cloudHsmClusterName }}' -- required
AND jobId = '{{ jobId }}' -- required
;