backups_volume_latest_restore_status
Creates, updates, deletes, gets or lists a backups_volume_latest_restore_status resource.
Overview
| Name | backups_volume_latest_restore_status |
| Type | Resource |
| Id | azure_isv.netapp.backups_volume_latest_restore_status |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
errorMessage | string | Displays error message if the restore is in an error state |
healthy | boolean | Restore health status |
mirrorState | string | The status of the restore |
relationshipStatus | string | Status of the restore SnapMirror relationship |
totalTransferBytes | integer (int64) | Displays the total bytes transferred |
unhealthyReason | string | Reason for the unhealthy restore relationship |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, accountName, poolName, volumeName | Get the latest status of the restore for a volume |
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 |
|---|---|---|
accountName | string | The name of the NetApp account |
poolName | string | The name of the capacity pool |
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. |
volumeName | string | The name of the volume |
SELECT examples
- get
Get the latest status of the restore for a volume
SELECT
errorMessage,
healthy,
mirrorState,
relationshipStatus,
totalTransferBytes,
unhealthyReason
FROM azure_isv.netapp.backups_volume_latest_restore_status
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND poolName = '{{ poolName }}' -- required
AND volumeName = '{{ volumeName }}' -- required
;