Recovery Points - Get

Reference

Service:: Recovery Services - Backup

API Version:: 2024-10-01

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.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}?api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
containerName	path	True	string	Container name associated with backed up item.
fabricName	path	True	string	Fabric name associated with backed up item.
protectedItemName	path	True	string	Backed up item name whose backup data needs to be fetched.
recoveryPointId	path	True	string	RecoveryPointID represents the backed up data to be fetched.
resourceGroupName	path	True	string	The name of the resource group where the recovery services vault is present.
subscriptionId	path	True	string	The subscription Id.
vaultName	path	True	string	The name of the recovery services vault.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	RecoveryPointResource	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account.

Examples

Get Azure Vm Recovery Point Details

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rshhtestmdvmrg/providers/Microsoft.RecoveryServices/vaults/rshvault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/protectedItems/VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/recoveryPoints/26083826328862?api-version=2024-10-01

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rshhtestmdvmrg/providers/Microsoft.RecoveryServices/vaults/rshvault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/protectedItems/VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/recoveryPoints/26083826328862",
  "name": "26083826328862",
  "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints",
  "properties": {
    "objectType": "IaasVMRecoveryPoint",
    "recoveryPointType": "CrashConsistent",
    "recoveryPointTime": "2017-11-22T22:32:46.6088472Z",
    "recoveryPointAdditionalInfo": "",
    "sourceVMStorageType": "NormalStorage",
    "isSourceVMEncrypted": false,
    "isInstantIlrSessionActive": false,
    "recoveryPointTierDetails": [
      {
        "type": "HardenedRP",
        "status": "Valid"
      }
    ],
    "recoveryPointMoveReadinessInfo": {
      "ArchivedRP": {
        "isReadyForMove": true
      }
    },
    "isManagedVirtualMachine": true,
    "virtualMachineSize": "Standard_D1",
    "originalStorageAccountOption": false,
    "zones": [
      "1"
    ],
    "isPrivateAccessEnabledOnAnyDisk": true
  }
}

Definitions

Name	Description
AzureFileShareRecoveryPoint	Azure File Share workload specific backup copy.
AzureWorkloadPointInTimeRecoveryPoint	Recovery point specific to PointInTime
AzureWorkloadRecoveryPoint	Workload specific recovery point, specifically encapsulates full/diff recovery point
AzureWorkloadSAPHanaPointInTimeRecoveryPoint	Recovery point specific to PointInTime in SAPHana
AzureWorkloadSAPHanaRecoveryPoint	SAPHana specific recoverypoint, specifically encapsulates full/diff recoverypoints
AzureWorkloadSQLPointInTimeRecoveryPoint	Recovery point specific to PointInTime
AzureWorkloadSQLRecoveryPoint	SQL specific recoverypoint, specifically encapsulates full/diff recoverypoint along with extended info
AzureWorkloadSQLRecoveryPointExtendedInfo	Extended info class details
BEKDetails	BEK is bitlocker encryption key.
CloudError	An error response from the Container Instance service.
CloudErrorBody	An error response from the Container Instance service.
DiskInformation	Disk information
ErrorAdditionalInfo	The resource management error additional info.
ExtendedLocation	The extended location of Recovery point where VM was present.
GenericRecoveryPoint	Generic backup copy.
IaasVMRecoveryPoint	IaaS VM workload specific backup copy.
KEKDetails	KEK is encryption key for BEK.
KeyAndSecretDetails	BEK is bitlocker key. KEK is encryption key for BEK If the VM was encrypted then we will store following details : Secret(BEK) - Url + Backup Data + vaultId. Key(KEK) - Url + Backup Data + vaultId. EncryptionMechanism BEK and KEK can potentially have different vault ids.
PointInTimeRange	Provides details for log ranges
RecoveryPointDiskConfiguration	Disk configuration
RecoveryPointMoveReadinessInfo
RecoveryPointProperties	Properties of Recovery Point
RecoveryPointResource	Base class for backup copies. Workload-specific backup copies are derived from this class.
RecoveryPointTierInformationV2	RecoveryPoint Tier Information V2
RecoveryPointTierStatus	Recovery point tier status.
RecoveryPointTierType	Recovery point tier type.
RestorePointType	Type of restore point
SQLDataDirectory	SQLDataDirectory info
SQLDataDirectoryType	Type of data directory mapping

AzureFileShareRecoveryPoint

Azure File Share workload specific backup copy.

Name	Type	Description
fileShareSnapshotUri	string	Contains Url to the snapshot of fileshare, if applicable
objectType	string: AzureFileShareRecoveryPoint	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
recoveryPointProperties	RecoveryPointProperties	Properties of Recovery Point
recoveryPointSizeInGB	integer	Contains recovery point size
recoveryPointTime	string	Time at which this backup copy was created.
recoveryPointType	string	Type of the backup copy. Specifies whether it is a crash consistent backup or app consistent.

AzureWorkloadPointInTimeRecoveryPoint

Recovery point specific to PointInTime

Name	Type	Description
objectType	string: AzureWorkloadPointInTimeRecoveryPoint	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
recoveryPointMoveReadinessInfo	<string, RecoveryPointMoveReadinessInfo>	Eligibility of RP to be moved to another tier
recoveryPointProperties	RecoveryPointProperties	Properties of Recovery Point
recoveryPointTierDetails	RecoveryPointTierInformationV2[]	Recovery point tier information.
recoveryPointTimeInUTC	string	UTC time at which recovery point was created
timeRanges	PointInTimeRange[]	List of log ranges
type	RestorePointType	Type of restore point

AzureWorkloadRecoveryPoint

Workload specific recovery point, specifically encapsulates full/diff recovery point

Name	Type	Description
objectType	string: AzureWorkloadRecoveryPoint	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
recoveryPointMoveReadinessInfo	<string, RecoveryPointMoveReadinessInfo>	Eligibility of RP to be moved to another tier
recoveryPointProperties	RecoveryPointProperties	Properties of Recovery Point
recoveryPointTierDetails	RecoveryPointTierInformationV2[]	Recovery point tier information.
recoveryPointTimeInUTC	string	UTC time at which recovery point was created
type	RestorePointType	Type of restore point

AzureWorkloadSAPHanaPointInTimeRecoveryPoint

Recovery point specific to PointInTime in SAPHana

Name	Type	Description
objectType	string: AzureWorkloadSAPHanaPointInTimeRecoveryPoint	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
recoveryPointMoveReadinessInfo	<string, RecoveryPointMoveReadinessInfo>	Eligibility of RP to be moved to another tier
recoveryPointProperties	RecoveryPointProperties	Properties of Recovery Point
recoveryPointTierDetails	RecoveryPointTierInformationV2[]	Recovery point tier information.
recoveryPointTimeInUTC	string	UTC time at which recovery point was created
timeRanges	PointInTimeRange[]	List of log ranges
type	RestorePointType	Type of restore point

AzureWorkloadSAPHanaRecoveryPoint

SAPHana specific recoverypoint, specifically encapsulates full/diff recoverypoints

Name	Type	Description
objectType	string: AzureWorkloadSAPHanaRecoveryPoint	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
recoveryPointMoveReadinessInfo	<string, RecoveryPointMoveReadinessInfo>	Eligibility of RP to be moved to another tier
recoveryPointProperties	RecoveryPointProperties	Properties of Recovery Point
recoveryPointTierDetails	RecoveryPointTierInformationV2[]	Recovery point tier information.
recoveryPointTimeInUTC	string	UTC time at which recovery point was created
type	RestorePointType	Type of restore point

AzureWorkloadSQLPointInTimeRecoveryPoint

Recovery point specific to PointInTime

Name	Type	Description
extendedInfo	AzureWorkloadSQLRecoveryPointExtendedInfo	Extended Info that provides data directory details. Will be populated in two cases: When a specific recovery point is accessed using GetRecoveryPoint Or when ListRecoveryPoints is called for Log RP only with ExtendedInfo query filter
objectType	string: AzureWorkloadSQLPointInTimeRecoveryPoint	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
recoveryPointMoveReadinessInfo	<string, RecoveryPointMoveReadinessInfo>	Eligibility of RP to be moved to another tier
recoveryPointProperties	RecoveryPointProperties	Properties of Recovery Point
recoveryPointTierDetails	RecoveryPointTierInformationV2[]	Recovery point tier information.
recoveryPointTimeInUTC	string	UTC time at which recovery point was created
timeRanges	PointInTimeRange[]	List of log ranges
type	RestorePointType	Type of restore point

AzureWorkloadSQLRecoveryPoint

SQL specific recoverypoint, specifically encapsulates full/diff recoverypoint along with extended info

Name	Type	Description
extendedInfo	AzureWorkloadSQLRecoveryPointExtendedInfo	Extended Info that provides data directory details. Will be populated in two cases: When a specific recovery point is accessed using GetRecoveryPoint Or when ListRecoveryPoints is called for Log RP only with ExtendedInfo query filter
objectType	string: AzureWorkloadSQLRecoveryPoint	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
recoveryPointMoveReadinessInfo	<string, RecoveryPointMoveReadinessInfo>	Eligibility of RP to be moved to another tier
recoveryPointProperties	RecoveryPointProperties	Properties of Recovery Point
recoveryPointTierDetails	RecoveryPointTierInformationV2[]	Recovery point tier information.
recoveryPointTimeInUTC	string	UTC time at which recovery point was created
type	RestorePointType	Type of restore point

AzureWorkloadSQLRecoveryPointExtendedInfo

Extended info class details

Name	Type	Description
dataDirectoryPaths	SQLDataDirectory[]	List of data directory paths during restore operation.
dataDirectoryTimeInUTC	string	UTC time at which data directory info was captured

BEKDetails

BEK is bitlocker encryption key.

Name	Type	Description
secretData	string	BEK data.
secretUrl	string	Secret is BEK.
secretVaultId	string	ID of the Key Vault where this Secret is stored.

CloudError

An error response from the Container Instance service.

Name	Type	Description
error	CloudErrorBody	The error object.

CloudErrorBody

An error response from the Container Instance service.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

DiskInformation

Disk information

Name	Type	Description
lun	integer
name	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ExtendedLocation

The extended location of Recovery point where VM was present.

Name	Type	Description
name	string	Name of the extended location.
type	string	Type of the extended location. Possible values include: 'EdgeZone'

GenericRecoveryPoint

Generic backup copy.

Name	Type	Description
friendlyName	string	Friendly name of the backup copy.
objectType	string: GenericRecoveryPoint	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
recoveryPointAdditionalInfo	string	Additional information associated with this backup copy.
recoveryPointProperties	RecoveryPointProperties	Properties of Recovery Point
recoveryPointTime	string	Time at which this backup copy was created.
recoveryPointType	string	Type of the backup copy.

IaasVMRecoveryPoint

IaaS VM workload specific backup copy.

Name	Type	Description
extendedLocation	ExtendedLocation	Extended location of the VM recovery point, should be null if VM is in public cloud
isInstantIlrSessionActive	boolean	Is the session to recover items from this backup copy still active.
isManagedVirtualMachine	boolean	Whether VM is with Managed Disks
isPrivateAccessEnabledOnAnyDisk	boolean	This flag denotes if any of the disks in the VM are using Private access network setting
isSourceVMEncrypted	boolean	Identifies whether the VM was encrypted when the backup copy is created.
keyAndSecret	KeyAndSecretDetails	Required details for recovering an encrypted VM. Applicable only when IsSourceVMEncrypted is true.
objectType	string: IaasVMRecoveryPoint	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
originalStorageAccountOption	boolean	Original Storage Account Option
osType	string	OS type
recoveryPointAdditionalInfo	string	Additional information associated with this backup copy.
recoveryPointDiskConfiguration	RecoveryPointDiskConfiguration	Disk configuration
recoveryPointMoveReadinessInfo	<string, RecoveryPointMoveReadinessInfo>	Eligibility of RP to be moved to another tier
recoveryPointProperties	RecoveryPointProperties	Properties of Recovery Point
recoveryPointTierDetails	RecoveryPointTierInformationV2[]	Recovery point tier information.
recoveryPointTime	string	Time at which this backup copy was created.
recoveryPointType	string	Type of the backup copy.
securityType	string	Security Type of the Disk
sourceVMStorageType	string	Storage type of the VM whose backup copy is created.
virtualMachineSize	string	Virtual Machine Size
zones	string[]	Identifies the zone of the VM at the time of backup. Applicable only for zone-pinned Vms

KEKDetails

KEK is encryption key for BEK.

Name	Type	Description
keyBackupData	string	KEK data.
keyUrl	string	Key is KEK.
keyVaultId	string	Key Vault ID where this Key is stored.

KeyAndSecretDetails

BEK is bitlocker key. KEK is encryption key for BEK If the VM was encrypted then we will store following details :

Secret(BEK) - Url + Backup Data + vaultId.
Key(KEK) - Url + Backup Data + vaultId.
EncryptionMechanism BEK and KEK can potentially have different vault ids.

Name	Type	Description
bekDetails	BEKDetails	BEK is bitlocker encryption key.
encryptionMechanism	string	Encryption mechanism: None/ SinglePass/ DoublePass
kekDetails	KEKDetails	KEK is encryption key for BEK.

PointInTimeRange

Provides details for log ranges

Name	Type	Description
endTime	string	End time of the time range for log recovery.
startTime	string	Start time of the time range for log recovery.

RecoveryPointDiskConfiguration

Disk configuration

Name	Type	Description
excludedDiskList	DiskInformation[]	Information of disks excluded from backup
includedDiskList	DiskInformation[]	Information of disks included in backup
numberOfDisksAttachedToVm	integer	Number of disks attached to the VM
numberOfDisksIncludedInBackup	integer	Number of disks included in backup

RecoveryPointMoveReadinessInfo

Name	Type	Description
additionalInfo	string
isReadyForMove	boolean

RecoveryPointProperties

Properties of Recovery Point

Name	Type	Description
expiryTime	string	Expiry time of Recovery Point in UTC.
isSoftDeleted	boolean	Bool to indicate whether RP is in soft delete state or not
ruleName	string	Rule name tagged on Recovery Point that governs life cycle

RecoveryPointResource

Base class for backup copies. Workload-specific backup copies are derived from this class.

Name	Type	Description
eTag	string	Optional ETag.
id	string	Resource Id represents the complete path to the resource.
location	string	Resource location.
name	string	Resource name associated with the resource.
properties	RecoveryPoint: AzureFileShareRecoveryPoint AzureWorkloadPointInTimeRecoveryPoint AzureWorkloadRecoveryPoint AzureWorkloadSAPHanaPointInTimeRecoveryPoint AzureWorkloadSAPHanaRecoveryPoint AzureWorkloadSQLPointInTimeRecoveryPoint AzureWorkloadSQLRecoveryPoint GenericRecoveryPoint IaasVMRecoveryPoint	RecoveryPointResource properties
tags	object	Resource tags.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

RecoveryPointTierInformationV2

RecoveryPoint Tier Information V2

Name	Type	Description
extendedInfo	object	Recovery point tier status.
status	RecoveryPointTierStatus	Recovery point tier status.
type	RecoveryPointTierType	Recovery point tier type.

RecoveryPointTierStatus

Recovery point tier status.

Name	Type	Description
Deleted	string
Disabled	string
Invalid	string
Rehydrated	string
Valid	string

RecoveryPointTierType

Recovery point tier type.

Name	Type	Description
ArchivedRP	string
HardenedRP	string
InstantRP	string
Invalid	string

RestorePointType

Type of restore point

Name	Type	Description
Differential	string
Full	string
Incremental	string
Invalid	string
Log	string
SnapshotCopyOnlyFull	string
SnapshotFull	string

SQLDataDirectory

SQLDataDirectory info

Name	Type	Description
logicalName	string	Logical name of the file
path	string	File path
type	SQLDataDirectoryType	Type of data directory mapping

SQLDataDirectoryType

Type of data directory mapping

Name	Type	Description
Data	string
Invalid	string
Log	string

Share via