Restorable Time Ranges - Find

Service:

Data Protection

API Version:

2024-04-01

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges?api-version=2024-04-01

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.

Request Body

Name	Required	Type	Description
sourceDataStoreType	True	RestoreSourceDataStoreType	Gets or sets the type of the source data store.
endTime		string	End time for the List Restore Ranges request. ISO 8601 format.
startTime		string	Start time for the List Restore Ranges request. ISO 8601 format.

Responses

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

Find Restorable Time Ranges

Sample request

HTTP

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/Blob-Backup/providers/Microsoft.DataProtection/backupVaults/ZBlobBackupVaultBVTD3/backupInstances/zblobbackuptestsa58/findRestorableTimeRanges?api-version=2024-04-01

{
  "sourceDataStoreType": "OperationalStore",
  "startTime": "2020-10-17T23:28:17.6829685Z",
  "endTime": "2021-02-24T00:35:17.6829685Z"
}

Java

import com.azure.resourcemanager.dataprotection.models.AzureBackupFindRestorableTimeRangesRequest;
import com.azure.resourcemanager.dataprotection.models.RestoreSourceDataStoreType;

/**
 * Samples for RestorableTimeRanges Find.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/
     * BackupInstanceOperations/FindRestorableTimeRanges.json
     */
    /**
     * Sample code: Find Restorable Time Ranges.
     * 
     * @param manager Entry point to DataProtectionManager.
     */
    public static void
        findRestorableTimeRanges(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager.restorableTimeRanges().findWithResponse("Blob-Backup", "ZBlobBackupVaultBVTD3", "zblobbackuptestsa58",
            new AzureBackupFindRestorableTimeRangesRequest()
                .withSourceDataStoreType(RestoreSourceDataStoreType.OPERATIONAL_STORE)
                .withStartTime("2020-10-17T23:28:17.6829685Z").withEndTime("2021-02-24T00:35:17.6829685Z"),
            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 typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python find_restorable_time_ranges.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.restorable_time_ranges.find(
        resource_group_name="Blob-Backup",
        vault_name="ZBlobBackupVaultBVTD3",
        backup_instance_name="zblobbackuptestsa58",
        parameters={
            "endTime": "2021-02-24T00:35:17.6829685Z",
            "sourceDataStoreType": "OperationalStore",
            "startTime": "2020-10-17T23:28:17.6829685Z",
        },
    )
    print(response)


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dataprotection/armdataprotection/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json
func ExampleRestorableTimeRangesClient_Find() {
	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)
	}
	res, err := clientFactory.NewRestorableTimeRangesClient().Find(ctx, "Blob-Backup", "ZBlobBackupVaultBVTD3", "zblobbackuptestsa58", armdataprotection.AzureBackupFindRestorableTimeRangesRequest{
		EndTime:             to.Ptr("2021-02-24T00:35:17.6829685Z"),
		SourceDataStoreType: to.Ptr(armdataprotection.RestoreSourceDataStoreTypeOperationalStore),
		StartTime:           to.Ptr("2020-10-17T23:28:17.6829685Z"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AzureBackupFindRestorableTimeRangesResponseResource = armdataprotection.AzureBackupFindRestorableTimeRangesResponseResource{
	// 	Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges"),
	// 	ID: to.Ptr("zblobbackuptestsa58"),
	// 	Properties: &armdataprotection.AzureBackupFindRestorableTimeRangesResponse{
	// 		ObjectType: to.Ptr("AzureBackupFindRestorableTimeRangesResponse"),
	// 		RestorableTimeRanges: []*armdataprotection.RestorableTimeRange{
	// 			{
	// 				EndTime: to.Ptr("2021-02-24T00:35:17.0000000Z"),
	// 				ObjectType: to.Ptr("RestorableTimeRange"),
	// 				StartTime: to.Ptr("2021-02-23T18:33:51.6349708Z"),
	// 		}},
	// 	},
	// }
}

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
 *
 * @summary
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json
 */
async function findRestorableTimeRanges() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "04cf684a-d41f-4550-9f70-7708a3a2283b";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "Blob-Backup";
  const vaultName = "ZBlobBackupVaultBVTD3";
  const backupInstanceName = "zblobbackuptestsa58";
  const parameters = {
    endTime: "2021-02-24T00:35:17.6829685Z",
    sourceDataStoreType: "OperationalStore",
    startTime: "2020-10-17T23:28:17.6829685Z",
  };
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.restorableTimeRanges.find(
    resourceGroupName,
    vaultName,
    backupInstanceName,
    parameters,
  );
  console.log(result);
}

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

{
  "id": "zblobbackuptestsa58",
  "type": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges",
  "properties": {
    "restorableTimeRanges": [
      {
        "startTime": "2021-02-23T18:33:51.6349708Z",
        "endTime": "2021-02-24T00:35:17.0000000Z",
        "objectType": "RestorableTimeRange"
      }
    ],
    "objectType": "AzureBackupFindRestorableTimeRangesResponse"
  }
}

Definitions

Name	Description
AzureBackupFindRestorableTimeRangesRequest	List Restore Ranges Request
AzureBackupFindRestorableTimeRangesResponse	List Restore Ranges Response
AzureBackupFindRestorableTimeRangesResponseResource	List Restore Ranges Response
CloudError	CloudError
createdByType	The type of identity that created the resource.
Error	The resource management error response.
ErrorAdditionalInfo	The resource management error additional info.
RestorableTimeRange
RestoreSourceDataStoreType	Gets or sets the type of the source data store.
systemData	Metadata pertaining to creation and last modification of the resource.

AzureBackupFindRestorableTimeRangesRequest

List Restore Ranges Request

Name	Type	Description
endTime	string	End time for the List Restore Ranges request. ISO 8601 format.
sourceDataStoreType	RestoreSourceDataStoreType	Gets or sets the type of the source data store.
startTime	string	Start time for the List Restore Ranges request. ISO 8601 format.

AzureBackupFindRestorableTimeRangesResponse

List Restore Ranges Response

Name	Type	Description
objectType	string
restorableTimeRanges	RestorableTimeRange[]	Returns the Restore Ranges available on the Backup Instance.

AzureBackupFindRestorableTimeRangesResponseResource

List Restore Ranges Response

Name	Type	Description
id	string	Resource Id represents the complete path to the resource.
name	string	Resource name associated with the resource.
properties	AzureBackupFindRestorableTimeRangesResponse	AzureBackupFindRestorableTimeRangesResponseResource 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/...

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.

RestorableTimeRange

Name	Type	Description
endTime	string	End time for the available restore range
objectType	string
startTime	string	Start time for the available restore range

RestoreSourceDataStoreType

Gets or sets the type of the source data store.

Name	Type	Description
ArchiveStore	string
OperationalStore	string
VaultStore	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.