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

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.
eTag	string	Optional ETag.
location	string	The geo-location where the resource lives.
objectType	string	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. Required. Default value is None.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
threatInfo	array	Recovery point threat information.
threatStatus	string	Threat status of the recovery point. Known values are: "Unknown", "Healthy", "UnHealthy", "Warning", and "NotAvailable". (Unknown, Healthy, UnHealthy, Warning, NotAvailable)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
eTag	string	Optional ETag.
location	string	The geo-location where the resource lives.
objectType	string	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. Required. Default value is None.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
threatInfo	array	Recovery point threat information.
threatStatus	string	Threat status of the recovery point. Known values are: "Unknown", "Healthy", "UnHealthy", "Warning", and "NotAvailable". (Unknown, Healthy, UnHealthy, Warning, NotAvailable)
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	vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, subscription_id		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	vault_name, resource_group_name, fabric_name, container_name, protected_item_name, subscription_id	$filter	Lists the backup copies for the backed up item.
update	update	resource_group_name, vault_name, fabric_name, container_name, protected_item_name, recovery_point_id, subscription_id		UpdateRecoveryPoint to update recovery point for given RecoveryPointID.

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
container_name	string	Name of the container whose details need to be fetched. Required.
fabric_name	string	The name of the BackupFabricResource. Required.
protected_item_name	string	Backed up item name whose details are to be fetched. Required.
recovery_point_id	string	RecoveryPointID represents the backed up data to be fetched. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The name of the VaultResource. Required.
$filter	string	OData filter options. Default value is None.

SELECT examples

get

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,
eTag,
location,
objectType,
systemData,
tags,
threatInfo,
threatStatus,
type
FROM azure.recovery_services_backup.recovery_points
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND container_name = '{{ container_name }}' -- required
AND protected_item_name = '{{ protected_item_name }}' -- required
AND recovery_point_id = '{{ recovery_point_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the backup copies for the backed up item.

SELECT
id,
name,
eTag,
location,
objectType,
systemData,
tags,
threatInfo,
threatStatus,
type
FROM azure.recovery_services_backup.recovery_points
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND container_name = '{{ container_name }}' -- required
AND protected_item_name = '{{ protected_item_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

UPDATE examples

update

UpdateRecoveryPoint to update recovery point for given RecoveryPointID.

UPDATE azure.recovery_services_backup.recovery_points
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND fabric_name = '{{ fabric_name }}' --required
AND container_name = '{{ container_name }}' --required
AND protected_item_name = '{{ protected_item_name }}' --required
AND recovery_point_id = '{{ recovery_point_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type;