Recovery Points - List

Service:

Data Protection

API Version:

2023-01-01

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=2023-01-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints?api-version=2023-01-01&$filter={$filter}&$skipToken={$skipToken}

URI Parameters

Name	In	Required	Type	Description
backupInstanceName	path	True	string	The name of the backup instance.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
vaultName	path	True	string	The name of the backup vault.
api-version	query	True	string	The API version to use for this operation.
$filter	query		string	OData filter options.
$skipToken	query		string	skipToken Filter.

Responses

Name	Type	Description
200 OK	AzureBackupRecoveryPointResourceList	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

List Recovery Points in a Vault

Sample Request

HTTP

GET https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/recoveryPoints?api-version=2023-01-01

Java

/** Samples for RecoveryPoints List. */
public final class Main {
    /*
     * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ListRecoveryPoints.json
     */
    /**
     * Sample code: List Recovery Points in a Vault.
     *
     * @param manager Entry point to DataProtectionManager.
     */
    public static void listRecoveryPointsInAVault(
        com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager
            .recoveryPoints()
            .list(
                "000pikumar",
                "PratikPrivatePreviewVault1",
                "testInstance1",
                null,
                null,
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python list_recovery_points.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataProtectionMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="04cf684a-d41f-4550-9f70-7708a3a2283b",
    )

    response = client.recovery_points.list(
        resource_group_name="000pikumar",
        vault_name="PratikPrivatePreviewVault1",
        backup_instance_name="testInstance1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ListRecoveryPoints.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdataprotection_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dataprotection/armdataprotection/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1b33e81bbdc28fcd6644a1315b8d7b1b6d030590/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ListRecoveryPoints.json
func ExampleRecoveryPointsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRecoveryPointsClient().NewListPager("000pikumar", "PratikPrivatePreviewVault1", "testInstance1", &armdataprotection.RecoveryPointsClientListOptions{Filter: nil,
		SkipToken: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AzureBackupRecoveryPointResourceList = armdataprotection.AzureBackupRecoveryPointResourceList{
		// 	Value: []*armdataprotection.AzureBackupRecoveryPointResource{
		// 		{
		// 			Name: to.Ptr("7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5e35"),
		// 			Type: to.Ptr("microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints"),
		// 			ID: to.Ptr("/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"),
		// 			Properties: &armdataprotection.AzureBackupDiscreteRecoveryPoint{
		// 				ObjectType: to.Ptr("AzureBackupDiscreteRecoveryPoint"),
		// 				ExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-03-01T13:00:00Z"); return t}()),
		// 				FriendlyName: to.Ptr("panbha4"),
		// 				RecoveryPointDataStoresDetails: []*armdataprotection.RecoveryPointDataStoreDetails{
		// 					{
		// 						Type: to.Ptr("Snapshot"),
		// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00Z"); return t}()),
		// 						ID: to.Ptr("0ff03512-b333-4509-a6c7-12164c8b1dce"),
		// 						MetaData: to.Ptr("123456"),
		// 					},
		// 					{
		// 						Type: to.Ptr("BackupStorage"),
		// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00Z"); return t}()),
		// 						ID: to.Ptr("5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1"),
		// 						MetaData: to.Ptr("123456"),
		// 				}},
		// 				RecoveryPointTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00Z"); return t}()),
		// 				RecoveryPointType: to.Ptr("Full"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25"),
		// 			Type: to.Ptr("microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints"),
		// 			ID: to.Ptr("/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"),
		// 			Properties: &armdataprotection.AzureBackupDiscreteRecoveryPoint{
		// 				ObjectType: to.Ptr("AzureBackupDiscreteRecoveryPoint"),
		// 				FriendlyName: to.Ptr("panbha4"),
		// 				RecoveryPointDataStoresDetails: []*armdataprotection.RecoveryPointDataStoreDetails{
		// 					{
		// 						Type: to.Ptr("Snapshot"),
		// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00Z"); return t}()),
		// 						ID: to.Ptr("808cfd30-722e-4bab-85f6-4a9d01ffc6f2"),
		// 						MetaData: to.Ptr("123456"),
		// 					},
		// 					{
		// 						Type: to.Ptr("BackupStorage"),
		// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00Z"); return t}()),
		// 						ID: to.Ptr("798cfd30-722e-4bab-85f6-4a9d01ffc6f3"),
		// 						MetaData: to.Ptr("123456"),
		// 				}},
		// 				RecoveryPointTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00Z"); return t}()),
		// 				RecoveryPointType: to.Ptr("Full"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DataProtectionClient } = require("@azure/arm-dataprotection");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns a list of Recovery Points for a DataSource in a vault.
 *
 * @summary Returns a list of Recovery Points for a DataSource in a vault.
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ListRecoveryPoints.json
 */
async function listRecoveryPointsInAVault() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "04cf684a-d41f-4550-9f70-7708a3a2283b";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "000pikumar";
  const vaultName = "PratikPrivatePreviewVault1";
  const backupInstanceName = "testInstance1";
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.recoveryPoints.list(
    resourceGroupName,
    vaultName,
    backupInstanceName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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"
          }
        ]
      }
    },
    {
      "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"
          }
        ]
      }
    }
  ]
}

Definitions

Name	Description
AzureBackupDiscreteRecoveryPoint	AzureBackupDiscreteRecoveryPoint
AzureBackupRecoveryPointResource	AzureBackupRecoveryPointResource
AzureBackupRecoveryPointResourceList	AzureBackupRecoveryPointResourceList
CloudError	CloudError
createdByType	The type of identity that created the resource.
Error	The resource management error response.
ErrorAdditionalInfo	The resource management error additional info.
RecoveryPointDataStoreDetails	RecoveryPointDataStoreDetails
RehydrationStatus
systemData	Metadata pertaining to creation and last modification of the resource.

AzureBackupDiscreteRecoveryPoint

AzureBackupDiscreteRecoveryPoint

Name	Type	Description
expiryTime	string
friendlyName	string
objectType	string: AzureBackupDiscreteRecoveryPoint
policyName	string
policyVersion	string
recoveryPointDataStoresDetails	RecoveryPointDataStoreDetails[]	RecoveryPointDataStoreDetails RecoveryPoint datastore details
recoveryPointId	string
recoveryPointTime	string
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: AzureBackupDiscreteRecoveryPoint	AzureBackupRecoveryPoint AzureBackupRecoveryPointResource properties
systemData	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	AzureBackupRecoveryPointResource[]	List of resources.

CloudError

CloudError

Name	Type	Description
error	Error	The resource management error response.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

The resource management error response.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	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.

RecoveryPointDataStoreDetails

RecoveryPointDataStoreDetails

Name	Type	Description
creationTime	string
expiryTime	string
id	string
metaData	string
rehydrationExpiryTime	string
rehydrationStatus	RehydrationStatus
state	string
type	string
visible	boolean

RehydrationStatus

Name	Type	Description
COMPLETED	string
CREATE_IN_PROGRESS	string
DELETED	string
DELETE_IN_PROGRESS	string
FAILED	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.