recovery_points

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

Overview

Name	recovery_points
Type	Resource
Id	azure.recovery_services_backup_passive_stamp.recovery_points

Fields

The following fields are returned by SELECT queries:

get_access_token

Name	Datatype	Description
id	string	Resource Id represents the complete path to the resource.
name	string	Resource name associated with the resource.
accessTokenString	string	Access token used for authentication.
bMSActiveRegion	string	Active region name of BMS Stamp.
backupManagementType	string	Backup Management Type.
containerName	string	Container Unique name.
containerType	string	Container Type.
coordinatorServiceStampId	string	CoordinatorServiceStampId to be used by BCM in restore call.
coordinatorServiceStampUri	string	CoordinatorServiceStampUri to be used by BCM in restore call.
datasourceContainerName	string	Datasource Container Unique Name.
datasourceId	string	Datasource Id.
datasourceName	string	Datasource Friendly Name.
datasourceType	string	Datasource Type.
eTag	string	Optional ETag.
location	string	Resource location.
objectType	string	Type of the specific object - used for deserializing. Required.
protectionContainerId	integer	Protected item container id.
protectionServiceStampId	string	ProtectionServiceStampId to be used by BCM in restore call.
protectionServiceStampUri	string	ProtectionServiceStampUri to be used by BCM in restore call.
recoveryPointId	string	Recovery Point Id.
recoveryPointTime	string	Recovery Point Time.
resourceGroupName	string	Resource Group name of the source vault.
resourceId	string	Resource Id of the source vault.
resourceName	string	Resource Name of the source vault.
rpIsManagedVirtualMachine	boolean	Recovery point information: Managed virtual machine.
rpOriginalSAOption	boolean	Recovery point information: Original SA option.
rpTierInformation	object	Recovery point Tier Information.
rpVMSizeDescription	string	Recovery point information: VM size description.
subscriptionId	string	Subscription Id of the source vault.
tags	object	Resource tags.
tokenExtendedInformation	string	Extended Information about the token like FileSpec etc.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_access_token	select	vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, subscription_id		Returns the Access token for communication between BMS and Protection service. Returns the Access token for communication between BMS and Protection service.

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. Required.
fabric_name	string	Fabric name associated with the container. Required.
protected_item_name	string	Name of the Protected Item. Required.
recovery_point_id	string	Recovery Point Id. Required.
resource_group_name	string	The name of the resource group where the recovery services vault is present. Required.
subscription_id	string
vault_name	string	The name of the recovery services vault. Required.

SELECT examples

get_access_token

Returns the Access token for communication between BMS and Protection service. Returns the Access token for communication between BMS and Protection service.

SELECT
id,
name,
accessTokenString,
bMSActiveRegion,
backupManagementType,
containerName,
containerType,
coordinatorServiceStampId,
coordinatorServiceStampUri,
datasourceContainerName,
datasourceId,
datasourceName,
datasourceType,
eTag,
location,
objectType,
protectionContainerId,
protectionServiceStampId,
protectionServiceStampUri,
recoveryPointId,
recoveryPointTime,
resourceGroupName,
resourceId,
resourceName,
rpIsManagedVirtualMachine,
rpOriginalSAOption,
rpTierInformation,
rpVMSizeDescription,
subscriptionId,
tags,
tokenExtendedInformation,
type
FROM azure.recovery_services_backup_passive_stamp.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
;