Recovery Points - 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.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}?api-version=2025-08-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
container
|
path | True |
string |
Name of the container whose details need to be fetched. |
|
fabric
|
path | True |
string |
The name of the BackupFabricResource |
|
protected
|
path | True |
string |
Backed up item name whose details are to be fetched. |
|
recovery
|
path | True |
string |
RecoveryPointID represents the backed up data to be fetched. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
The name of the resource group. The name is case insensitive. |
|
subscription
|
path | True |
string minLength: 1 |
The ID of the target subscription. |
|
vault
|
path | True |
string |
The name of the VaultResource |
|
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Azure operation completed successfully. |
|
| Other Status Codes |
An unexpected error response. |
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
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=2025-08-01
Sample response
{
"name": "26083826328862",
"type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints",
"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",
"properties": {
"isInstantIlrSessionActive": false,
"isManagedVirtualMachine": true,
"isPrivateAccessEnabledOnAnyDisk": true,
"isSourceVMEncrypted": false,
"objectType": "IaasVMRecoveryPoint",
"originalStorageAccountOption": false,
"recoveryPointAdditionalInfo": "",
"recoveryPointMoveReadinessInfo": {
"ArchivedRP": {
"isReadyForMove": true
}
},
"recoveryPointTierDetails": [
{
"type": "HardenedRP",
"status": "Valid"
}
],
"recoveryPointTime": "2017-11-22T22:32:46.6088472Z",
"recoveryPointType": "CrashConsistent",
"sourceVMStorageType": "NormalStorage",
"virtualMachineSize": "Standard_D1",
"zones": [
"1"
]
}
}
Definitions
| Name | Description |
|---|---|
|
Azure |
Azure File Share workload specific backup copy. |
|
Azure |
Recovery point specific to PointInTime |
|
Azure |
Workload specific recovery point, specifically encapsulates full/diff recovery point |
|
Azure |
Recovery point specific to PointInTime in SAPAse |
|
Azure |
SAPAse specific recoverypoint, specifically encapsulates full/diff recoverypoints |
|
Azure |
Recovery point specific to PointInTime in SAPHana |
|
Azure |
SAPHana specific recoverypoint, specifically encapsulates full/diff recoverypoints |
|
Azure |
Recovery point specific to PointInTime |
|
Azure |
SQL specific recoverypoint, specifically encapsulates full/diff recoverypoint along with extended info |
|
Azure |
Extended info class details |
| BEKDetails |
BEK is bitlocker encryption key. |
|
created |
The type of identity that created the resource. |
|
Disk |
Disk information |
|
Error |
Error Detail class which encapsulates Code, Message and Recommendations. |
|
Error |
Error response |
|
Extended |
The extended location of Recovery point where VM was present. |
|
Generic |
Generic backup copy. |
|
Iaas |
IaaS VM workload specific backup copy. |
| KEKDetails |
KEK is encryption key for BEK. |
|
Key |
BEK is bitlocker key. KEK is encryption key for BEK If the VM was encrypted then we will store following details :
|
|
Point |
Provides details for log ranges |
|
Recovery |
Disk configuration |
|
Recovery |
|
|
Recovery |
Properties of Recovery Point |
|
Recovery |
Base class for backup copies. Workload-specific backup copies are derived from this class. |
|
Recovery |
Recovery point tier information. |
|
Recovery |
RecoveryPoint Tier Information V2 |
|
Recovery |
Recovery point tier status. |
|
Recovery |
Recovery point tier type. |
|
Restore |
Type of restore point |
|
SQLData |
SQLDataDirectory info |
|
SQLData |
Type of data directory mapping |
|
system |
Metadata pertaining to creation and last modification of the resource. |
AzureFileShareRecoveryPoint
Azure File Share workload specific backup copy.
| Name | Type | Description |
|---|---|---|
| fileShareSnapshotUri |
string |
Contains Url to the snapshot of fileshare, if applicable |
| objectType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
| recoveryPointProperties |
Properties of Recovery Point |
|
| recoveryPointSizeInGB |
integer (int32) |
Contains recovery point size |
| recoveryPointTierDetails |
Recovery point tier information. |
|
| recoveryPointTime |
string (date-time) |
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: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
| recoveryPointMoveReadinessInfo |
<string,
Recovery |
Eligibility of RP to be moved to another tier |
| recoveryPointProperties |
Properties of Recovery Point |
|
| recoveryPointTierDetails |
Recovery point tier information. |
|
| recoveryPointTimeInUTC |
string (date-time) |
UTC time at which recovery point was created |
| timeRanges |
List of log ranges |
|
| type |
Type of restore point |
AzureWorkloadRecoveryPoint
Workload specific recovery point, specifically encapsulates full/diff recovery point
| Name | Type | Description |
|---|---|---|
| objectType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
| recoveryPointMoveReadinessInfo |
<string,
Recovery |
Eligibility of RP to be moved to another tier |
| recoveryPointProperties |
Properties of Recovery Point |
|
| recoveryPointTierDetails |
Recovery point tier information. |
|
| recoveryPointTimeInUTC |
string (date-time) |
UTC time at which recovery point was created |
| type |
Type of restore point |
AzureWorkloadSAPAsePointInTimeRecoveryPoint
Recovery point specific to PointInTime in SAPAse
| Name | Type | Description |
|---|---|---|
| objectType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
| recoveryPointMoveReadinessInfo |
<string,
Recovery |
Eligibility of RP to be moved to another tier |
| recoveryPointProperties |
Properties of Recovery Point |
|
| recoveryPointTierDetails |
Recovery point tier information. |
|
| recoveryPointTimeInUTC |
string (date-time) |
UTC time at which recovery point was created |
| timeRanges |
List of log ranges |
|
| type |
Type of restore point |
AzureWorkloadSAPAseRecoveryPoint
SAPAse specific recoverypoint, specifically encapsulates full/diff recoverypoints
| Name | Type | Description |
|---|---|---|
| objectType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
| recoveryPointMoveReadinessInfo |
<string,
Recovery |
Eligibility of RP to be moved to another tier |
| recoveryPointProperties |
Properties of Recovery Point |
|
| recoveryPointTierDetails |
Recovery point tier information. |
|
| recoveryPointTimeInUTC |
string (date-time) |
UTC time at which recovery point was created |
| type |
Type of restore point |
AzureWorkloadSAPHanaPointInTimeRecoveryPoint
Recovery point specific to PointInTime in SAPHana
| Name | Type | Description |
|---|---|---|
| objectType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
| recoveryPointMoveReadinessInfo |
<string,
Recovery |
Eligibility of RP to be moved to another tier |
| recoveryPointProperties |
Properties of Recovery Point |
|
| recoveryPointTierDetails |
Recovery point tier information. |
|
| recoveryPointTimeInUTC |
string (date-time) |
UTC time at which recovery point was created |
| timeRanges |
List of log ranges |
|
| type |
Type of restore point |
AzureWorkloadSAPHanaRecoveryPoint
SAPHana specific recoverypoint, specifically encapsulates full/diff recoverypoints
| Name | Type | Description |
|---|---|---|
| objectType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
| recoveryPointMoveReadinessInfo |
<string,
Recovery |
Eligibility of RP to be moved to another tier |
| recoveryPointProperties |
Properties of Recovery Point |
|
| recoveryPointTierDetails |
Recovery point tier information. |
|
| recoveryPointTimeInUTC |
string (date-time) |
UTC time at which recovery point was created |
| type |
Type of restore point |
AzureWorkloadSQLPointInTimeRecoveryPoint
Recovery point specific to PointInTime
| Name | Type | Description |
|---|---|---|
| extendedInfo |
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: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
| recoveryPointMoveReadinessInfo |
<string,
Recovery |
Eligibility of RP to be moved to another tier |
| recoveryPointProperties |
Properties of Recovery Point |
|
| recoveryPointTierDetails |
Recovery point tier information. |
|
| recoveryPointTimeInUTC |
string (date-time) |
UTC time at which recovery point was created |
| timeRanges |
List of log ranges |
|
| type |
Type of restore point |
AzureWorkloadSQLRecoveryPoint
SQL specific recoverypoint, specifically encapsulates full/diff recoverypoint along with extended info
| Name | Type | Description |
|---|---|---|
| extendedInfo |
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: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
| recoveryPointMoveReadinessInfo |
<string,
Recovery |
Eligibility of RP to be moved to another tier |
| recoveryPointProperties |
Properties of Recovery Point |
|
| recoveryPointTierDetails |
Recovery point tier information. |
|
| recoveryPointTimeInUTC |
string (date-time) |
UTC time at which recovery point was created |
| type |
Type of restore point |
AzureWorkloadSQLRecoveryPointExtendedInfo
Extended info class details
| Name | Type | Description |
|---|---|---|
| dataDirectoryPaths |
List of data directory paths during restore operation. |
|
| dataDirectoryTimeInUTC |
string (date-time) |
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. |
createdByType
The type of identity that created the resource.
| Value | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DiskInformation
Disk information
| Name | Type | Description |
|---|---|---|
| lun |
integer (int32) |
|
| name |
string |
ErrorDetail
Error Detail class which encapsulates Code, Message and Recommendations.
| Name | Type | Description |
|---|---|---|
| code |
string |
Error code. |
| message |
string |
Error Message related to the Code. |
| recommendations |
string[] |
List of recommendation strings. |
ErrorResponse
Error response
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
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: |
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 |
Properties of Recovery Point |
|
| recoveryPointTime |
string (date-time) |
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 |
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 |
Required details for recovering an encrypted VM. Applicable only when IsSourceVMEncrypted is true. |
|
| objectType | string: |
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 |
Disk configuration |
|
| recoveryPointMoveReadinessInfo |
<string,
Recovery |
Eligibility of RP to be moved to another tier |
| recoveryPointProperties |
Properties of Recovery Point |
|
| recoveryPointTierDetails |
Recovery point tier information. |
|
| recoveryPointTime |
string (date-time) |
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 |
BEK is bitlocker encryption key. |
|
| encryptionMechanism |
string |
Encryption mechanism: None/ SinglePass/ DoublePass |
| kekDetails |
KEK is encryption key for BEK. |
PointInTimeRange
Provides details for log ranges
| Name | Type | Description |
|---|---|---|
| endTime |
string (date-time) |
End time of the time range for log recovery. |
| startTime |
string (date-time) |
Start time of the time range for log recovery. |
RecoveryPointDiskConfiguration
Disk configuration
| Name | Type | Description |
|---|---|---|
| excludedDiskList |
Information of disks excluded from backup |
|
| includedDiskList |
Information of disks included in backup |
|
| numberOfDisksAttachedToVm |
integer (int32) |
Number of disks attached to the VM |
| numberOfDisksIncludedInBackup |
integer (int32) |
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 |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location |
string |
The geo-location where the resource lives |
| name |
string |
The name of the resource |
| properties |
RecoveryPoint:
|
RecoveryPointResource properties |
| systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
| tags |
object |
Resource tags. |
| type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
RecoveryPointTierInformation
Recovery point tier information.
| Name | Type | Description |
|---|---|---|
| extendedInfo |
object |
Recovery point tier status. |
| status |
Recovery point tier status. |
|
| type |
Recovery point tier type. |
RecoveryPointTierInformationV2
RecoveryPoint Tier Information V2
| Name | Type | Description |
|---|---|---|
| extendedInfo |
object |
Recovery point tier status. |
| status |
Recovery point tier status. |
|
| type |
Recovery point tier type. |
RecoveryPointTierStatus
Recovery point tier status.
| Value | Description |
|---|---|
| Invalid | |
| Valid | |
| Disabled | |
| Deleted | |
| Rehydrated |
RecoveryPointTierType
Recovery point tier type.
| Value | Description |
|---|---|
| Invalid | |
| InstantRP | |
| HardenedRP | |
| ArchivedRP |
RestorePointType
Type of restore point
| Value | Description |
|---|---|
| Invalid | |
| Full | |
| Log | |
| Differential | |
| Incremental | |
| SnapshotFull | |
| SnapshotCopyOnlyFull |
SQLDataDirectory
SQLDataDirectory info
| Name | Type | Description |
|---|---|---|
| logicalName |
string |
Logical name of the file |
| path |
string |
File path |
| type |
Type of data directory mapping |
SQLDataDirectoryType
Type of data directory mapping
| Value | Description |
|---|---|
| Invalid | |
| Data | |
| Log |
systemData
Metadata pertaining to creation and last modification of the resource.
| Name | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
The timestamp of resource creation (UTC). |
| createdBy |
string |
The identity that created the resource. |
| createdByType |
The type of identity that created the resource. |
|
| lastModifiedAt |
string (date-time) |
The timestamp of resource last modification (UTC) |
| lastModifiedBy |
string |
The identity that last modified the resource. |
| lastModifiedByType |
The type of identity that last modified the resource. |