recovery_points

Creates, updates, deletes, gets or lists a recovery_points resource.

Overview

Name	recovery_points
Type	Resource
Id	azure.data_protection.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.
objectType	string	Required. Default value is None.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
objectType	string	Required. Default value is None.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	resource_group_name, vault_name, backup_instance_name, recovery_point_id, subscription_id		Gets a Recovery Point using recoveryPointId for a Datasource.
list	select	resource_group_name, vault_name, backup_instance_name, subscription_id	$filter, $skipToken	Returns a list of Recovery Points for a DataSource in a vault.

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
backup_instance_name	string	The name of the backup instance. Required.
recovery_point_id	string	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 backup vault. Required.
$filter	string	OData filter options. Default value is None.
$skipToken	string	skipToken Filter. Default value is None.

SELECT examples

get

Gets a Recovery Point using recoveryPointId for a Datasource.

SELECT
id,
name,
objectType,
systemData,
type
FROM azure.data_protection.recovery_points
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND backup_instance_name = '{{ backup_instance_name }}' -- required
AND recovery_point_id = '{{ recovery_point_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a list of Recovery Points for a DataSource in a vault.

SELECT
id,
name,
objectType,
systemData,
type
FROM azure.data_protection.recovery_points
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND backup_instance_name = '{{ backup_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $skipToken = '{{ $skipToken }}'
;