Skip to content

Commit b53596a

Browse files
Merge pull request #239288 from AbhishekMallick01/May-26-2023-QS
QS freshness - updated article
2 parents 91761b5 + 9ea3761 commit b53596a

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

articles/backup/backup-azure-dataprotection-use-rest-api-restore-disks.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Restore Azure Disks using Azure Data Protection REST API
33
description: In this article, learn how to restore Azure Disks using Azure Data protection REST API.
4-
ms.topic: conceptual
5-
ms.date: 10/06/2021
4+
ms.topic: how-to
5+
ms.date: 05/25/2023
66
ms.assetid: 30f4e7ff-2a55-4a85-be44-55feedc24607
77
author: jyothisuri
88
ms.author: jsuri
@@ -12,16 +12,12 @@ ms.author: jsuri
1212

1313
This article describes how to restore [disks](disk-backup-overview.md) using Azure Backup.
1414

15+
Azure Disk Backup offers a turnkey solution that provides snapshot lifecycle management for managed disks by automating periodic creation of snapshots and retaining it for configured duration using backup policy. You can manage the disk snapshots with zero infrastructure cost and without the need for custom scripting or any management overhead. This is a crash-consistent backup solution that takes point-in-time backup of a managed disk using incremental snapshots with support for multiple backups per day. It's also an agent-less solution and doesn't impact production application performance. It supports backup and restore of both OS and data disks (including shared disks), whether or not they're currently attached to a running Azure virtual machine.
16+
1517
>[!Note]
1618
>- Currently, the Original-Location Recovery (OLR) option to restore by replacing the existing source disk (from where the backups were taken) isn't supported.
1719
>- You can restore from a recovery point to create a new disk in the same resource group of the source disk or in any other resource group. It's known as Alternate-Location Recovery (ALR).
1820
19-
In this article, you'll learn how to:
20-
21-
- Restore to create a new disk
22-
23-
- Track the restore operation status
24-
2521
## Prerequisites
2622

2723
- [Create a Backup vault](backup-azure-dataprotection-use-rest-api-create-update-backup-vault.md)
@@ -65,7 +61,7 @@ Once you submit the *GET* request, this returns response as 200 (OK) and the lis
6561
|200 OK | [AzureBackupRecoveryPointResourceList](/rest/api/dataprotection/recovery-points/list#azurebackuprecoverypointresourcelist) | OK |
6662
|Other Status codes | [CloudError](/rest/api/dataprotection/recovery-points/list#clouderror) | Error response describes the reason for the operation failure. |
6763

68-
##### Example response for list of recovery points
64+
**Example response for list of recovery points**
6965

7066
```http
7167
HTTP/1.1 200 OK
@@ -151,13 +147,13 @@ X-Powered-By: ASP.NET
151147
}
152148
```
153149

154-
Select the relevant recovery points from the above list and proceed to prepare the restore request. We'll choose a recovery point named _a3d02fc3ab8a4c3a8cc26688c26d3356_ from the above list to restore.
150+
Select the relevant recovery points from the above list and proceed to prepare the restore request. We'll choose a recovery point named `a3d02fc3ab8a4c3a8cc26688c26d3356` from the above list to restore.
155151

156152
### Prepare the restore request
157153

158154
Construct the Azure Resource Manager (ARM) ID of the new disk to be created with the target resource group (to which permissions were assigned as detailed [above](#set-up-permissions)) and the required disk name.
159155

160-
For example, we'll use a disk named _APITestDisk2_, under a resource group _targetrg_, present in the same region as the backed-up disk, but under a different subscription.
156+
For example, we'll use a disk named `APITestDisk2`, under a resource group `targetrg`, present in the same region as the backed-up disk, but under a different subscription.
161157

162158
#### Construct the request body for restore request
163159

@@ -237,16 +233,16 @@ We have constructed a section of the same in the [above section](#construct-the-
237233

238234
The _validate restore request_ is an [asynchronous operation](../azure-resource-manager/management/async-operations.md). So, this operation creates another operation that needs to be tracked separately.
239235

240-
It returns two responses: 202 (Accepted) when another operation is created, and then 200 (OK) when that operation completes.
236+
It returns two responses: 202 (Accepted) when another operation is created, and 200 (OK) when that operation completes.
241237

242238
|Name |Type |Description |
243239
|---------|---------|---------|
244240
|200 OK | | Status of validate request |
245241
|202 Accepted | | Accepted |
246242

247-
###### Example response to restore validate request
243+
**Example response to restore validate request**
248244

249-
Once the *POST* operation is submitted, it'll return the initial response as 202 (Accepted) with an _Azure-asyncOperation_ header.
245+
Once the *POST* operation is submitted, it will return the initial response as 202 (Accepted) with an _Azure-asyncOperation_ header.
250246

251247
```http
252248
HTTP/1.1 202 Accepted
@@ -267,7 +263,7 @@ Location: https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxx
267263
X-Powered-By: ASP.NET
268264
```
269265

270-
Track the _Azure-AsyncOperation_ header with a simple *GET* request. When the request is successful, it returns 200 (OK) with a success status response.
266+
Track the _Azure-AsyncOperation_ header with a *GET* request. When the request is successful, it returns 200 (OK) with a success status response.
271267

272268
```http
273269
GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZmMzNDFmYWMtZWJlMS00NGJhLWE4YTgtMDNjYjI4Y2M5OTExOzVlNzMxZDBiLTQ3MDQtNDkzNS1hYmNjLWY4YWEzY2UzNTk1ZQ==?api-version=2021-01-01
@@ -329,16 +325,16 @@ The only change from the validate restore request body is to remove the _restore
329325

330326
The _trigger restore request_ is an [asynchronous operation](../azure-resource-manager/management/async-operations.md). So, this operation creates another operation that needs to be tracked separately.
331327

332-
It returns two responses: 202 (Accepted) when another operation is created, and then 200 (OK) when that operation completes.
328+
It returns two responses: 202 (Accepted) when another operation is created, and 200 (OK) when that operation completes.
333329

334330
|Name |Type |Description |
335331
|---------|---------|---------|
336332
|200 OK | | Status of restore request |
337333
|202 Accepted | | Accepted |
338334

339-
##### Example response to trigger restore request
335+
**Example response to trigger restore request**
340336

341-
Once the *POST* operation is submitted, it'll return the initial response as 202 (Accepted) with an _Azure-asyncOperation_ header.
337+
Once the *POST* operation is submitted, it will return the initial response as 202 (Accepted) with an _Azure-asyncOperation_ header.
342338

343339
```http
344340
HTTP/1.1 202 Accepted
@@ -359,7 +355,7 @@ Location: https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxx
359355
X-Powered-By: ASP.NET
360356
```
361357

362-
Track the _Azure-AsyncOperation_ header with a simple *GET* request. When the request is successful, it'll return 200 (OK) with a job ID that should be further tracked for completion of restore request.
358+
Track the _Azure-AsyncOperation_ header with a *GET* request. When the request is successful, it will return 200 (OK) with a job ID that should be further tracked for completion of restore request.
363359

364360
```http
365361
GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZmMzNDFmYWMtZWJlMS00NGJhLWE4YTgtMDNjYjI4Y2M5OTExO2Q1NDIzY2VjLTczYjYtNDY5ZC1hYmRjLTc1N2Q0ZTJmOGM5OQ==?api-version=2021-01-01
@@ -381,7 +377,7 @@ GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
381377

382378
The _trigger restore requests_ triggered the restore job. To track the resultant Job ID, use the [GET Jobs API](/rest/api/dataprotection/jobs/get).
383379

384-
Use the simple GET command to track the _JobId_ present in the [trigger restore response](#example-response-to-trigger-restore-request) above.
380+
Use the *GET* command to track the _JobId_ present in the [trigger restore response](#response-to-trigger-restore-requests) above.
385381

386382
```http
387383
GET /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/TestBkpVaultRG/providers/Microsoft.DataProtection/backupVaults/testBkpVault/backupJobs/c4bd49a1-0645-4eec-b207-feb818962852?api-version=2021-01-01

0 commit comments

Comments
 (0)