recovery_points
Creates, updates, deletes, gets or lists a recovery_points
resource.
Overview
Name | recovery_points |
Type | Resource |
Id | azure.recovery_services_backup.recovery_points |
Fields
The following fields are returned by SELECT
queries:
- get
- list
Name | Datatype | Description |
---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name | string | The name of the resource |
properties | object | RecoveryPointResource properties |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Name | Datatype | Description |
---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name | string | The name of the resource |
properties | object | RecoveryPointResource properties |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | vaultName , resourceGroupName , subscriptionId , fabricName , containerName , protectedItemName , recoveryPointId | api-version | Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation. To know the status of the operation, call the GetProtectedItemOperationResult API. |
list | select | vaultName , resourceGroupName , subscriptionId , fabricName , containerName , protectedItemName | api-version , $filter | Lists the backup copies for the backed up item. |
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 |
---|---|---|
containerName | string | Container name associated with the backed up item. |
fabricName | string | Fabric name associated with the backed up item. |
protectedItemName | string | Backed up item whose backup copies are to be fetched. |
recoveryPointId | string | RecoveryPointID represents the backed up data to be fetched. |
resourceGroupName | string | The name of the resource group where the recovery services vault is present. |
subscriptionId | string | The subscription Id. |
vaultName | string | The name of the recovery services vault. |
$filter | string | OData filter options. |
api-version | string | Client Api Version. |
SELECT
examples
- get
- list
Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation.
To know the status of the operation, call the GetProtectedItemOperationResult API.
SELECT
id,
name,
properties,
type
FROM azure.recovery_services_backup.recovery_points
WHERE vaultName = '{{ vaultName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND fabricName = '{{ fabricName }}' -- required
AND containerName = '{{ containerName }}' -- required
AND protectedItemName = '{{ protectedItemName }}' -- required
AND recoveryPointId = '{{ recoveryPointId }}' -- required
AND api-version = '{{ api-version }}'
;
Lists the backup copies for the backed up item.
SELECT
id,
name,
properties,
type
FROM azure.recovery_services_backup.recovery_points
WHERE vaultName = '{{ vaultName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND fabricName = '{{ fabricName }}' -- required
AND containerName = '{{ containerName }}' -- required
AND protectedItemName = '{{ protectedItemName }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
;