recovery_point

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

Overview

Name	recovery_point
Type	Resource
Id	azure.recovery_services_data_replication.recovery_point

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.
customProperties	object	Recovery point model custom properties. Required.
provisioningState	string	Gets or sets the provisioning state of the recovery point item. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
recoveryPointTime	string (date-time)	Gets or sets the recovery point time. Required.
recoveryPointType	string	Gets or sets the recovery point type. Required. Known values are: "ApplicationConsistent" and "CrashConsistent". (ApplicationConsistent, CrashConsistent)
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.
customProperties	object	Recovery point model custom properties. Required.
provisioningState	string	Gets or sets the provisioning state of the recovery point item. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
recoveryPointTime	string (date-time)	Gets or sets the recovery point time. Required.
recoveryPointType	string	Gets or sets the recovery point type. Required. Known values are: "ApplicationConsistent" and "CrashConsistent". (ApplicationConsistent, CrashConsistent)
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, protected_item_name, recovery_point_name, subscription_id		Gets the details of the recovery point of a protected item.
list	select	resource_group_name, vault_name, protected_item_name, subscription_id		Gets the list of recovery points of the given protected 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
protected_item_name	string	The protected item name. Required.
recovery_point_name	string	The recovery point name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The vault name. Required.

SELECT examples

get

Gets the details of the recovery point of a protected item.

SELECT
id,
name,
customProperties,
provisioningState,
recoveryPointTime,
recoveryPointType,
systemData,
type
FROM azure.recovery_services_data_replication.recovery_point
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND protected_item_name = '{{ protected_item_name }}' -- required
AND recovery_point_name = '{{ recovery_point_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of recovery points of the given protected item.

SELECT
id,
name,
customProperties,
provisioningState,
recoveryPointTime,
recoveryPointType,
systemData,
type
FROM azure.recovery_services_data_replication.recovery_point
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND protected_item_name = '{{ protected_item_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;