Recovery Points - List
Returns a list of Recovery Points for a DataSource in a vault.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints?api-version=2025-02-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints?api-version=2025-02-01&$filter={$filter}&$skipToken={$skipToken}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
backup
|
path | True |
string |
The name of the backup instance. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string (uuid) |
The ID of the target subscription. The value must be an UUID. |
vault
|
path | True |
string |
The name of the backup vault. |
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
$filter
|
query |
string |
OData filter options. |
|
$skip
|
query |
string |
skipToken Filter. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
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
List Recovery Points in a Vault
Sample request
GET https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/recoveryPoints?api-version=2025-02-01
Sample response
{
"value": [
{
"id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
"name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5e35",
"type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints",
"properties": {
"objectType": "AzureBackupDiscreteRecoveryPoint",
"recoveryPointTime": "2019-03-01T13:00:00Z",
"recoveryPointType": "Full",
"friendlyName": "panbha4",
"expiryTime": "2023-03-01T13:00:00Z",
"recoveryPointDataStoresDetails": [
{
"id": "0ff03512-b333-4509-a6c7-12164c8b1dce",
"type": "Snapshot",
"creationTime": "2019-03-01T13:00:00Z",
"metaData": "123456"
},
{
"id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1",
"type": "BackupStorage",
"creationTime": "2019-03-01T13:00:00Z",
"metaData": "123456"
}
],
"recoveryPointState": "Completed"
}
},
{
"id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
"name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
"type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints",
"properties": {
"objectType": "AzureBackupDiscreteRecoveryPoint",
"recoveryPointTime": "2019-03-01T13:00:00Z",
"recoveryPointType": "Full",
"friendlyName": "panbha4",
"recoveryPointDataStoresDetails": [
{
"id": "808cfd30-722e-4bab-85f6-4a9d01ffc6f2",
"type": "Snapshot",
"creationTime": "2019-03-01T13:00:00Z",
"metaData": "123456"
},
{
"id": "798cfd30-722e-4bab-85f6-4a9d01ffc6f3",
"type": "BackupStorage",
"creationTime": "2019-03-01T13:00:00Z",
"metaData": "123456"
}
],
"recoveryPointState": "Completed"
}
}
]
}
Definitions
Name | Description |
---|---|
Azure |
AzureBackupDiscreteRecoveryPoint |
Azure |
AzureBackupRecoveryPointResource |
Azure |
AzureBackupRecoveryPointResourceList |
Cloud |
CloudError |
created |
The type of identity that created the resource. |
Error |
The resource management error response. |
Error |
The resource management error additional info. |
Recovery |
Specifies recovery point completeness. Partial (i.e., only some of the intended items were backed up), or Completed (i.e., ALL intended items were backed up). |
Recovery |
RecoveryPointDataStoreDetails |
Rehydration |
|
system |
Metadata pertaining to creation and last modification of the resource. |
AzureBackupDiscreteRecoveryPoint
AzureBackupDiscreteRecoveryPoint
Name | Type | Description |
---|---|---|
expiryTime |
string (date-time) |
|
friendlyName |
string |
|
objectType | string: | |
policyName |
string |
|
policyVersion |
string |
|
recoveryPointDataStoresDetails |
RecoveryPointDataStoreDetails |
|
recoveryPointId |
string |
|
recoveryPointState |
Specifies recovery point completeness. Partial (i.e., only some of the intended items were backed up), or Completed (i.e., ALL intended items were backed up). |
|
recoveryPointTime |
string (date-time) |
|
recoveryPointType |
string |
|
retentionTagName |
string |
|
retentionTagVersion |
string |
AzureBackupRecoveryPointResource
AzureBackupRecoveryPointResource
Name | Type | Description |
---|---|---|
id |
string |
Resource Id represents the complete path to the resource. |
name |
string |
Resource name associated with the resource. |
properties | AzureBackupRecoveryPoint: |
AzureBackupRecoveryPoint |
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
type |
string |
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... |
AzureBackupRecoveryPointResourceList
AzureBackupRecoveryPointResourceList
Name | Type | Description |
---|---|---|
nextLink |
string |
The uri to fetch the next page of resources. Call ListNext() fetches next page of resources. |
value |
List of resources. |
CloudError
CloudError
Name | Type | Description |
---|---|---|
error |
The resource management error response. |
createdByType
The type of identity that created the resource.
Value | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
Error
The resource management error response.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
Error[] |
The error details. |
message |
string |
The error message. |
target |
string |
The error target. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
RecoveryPointCompletionState
Specifies recovery point completeness. Partial (i.e., only some of the intended items were backed up), or Completed (i.e., ALL intended items were backed up).
Value | Description |
---|---|
Completed | |
Partial |
RecoveryPointDataStoreDetails
RecoveryPointDataStoreDetails
Name | Type | Description |
---|---|---|
creationTime |
string (date-time) |
|
expiryTime |
string (date-time) |
|
id |
string |
|
metaData |
string |
|
rehydrationExpiryTime |
string (date-time) |
|
rehydrationStatus | ||
state |
string |
|
type |
string |
|
visible |
boolean |
RehydrationStatus
Value | Description |
---|---|
COMPLETED | |
CREATE_IN_PROGRESS | |
DELETED | |
DELETE_IN_PROGRESS | |
FAILED |
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. |