Skip to content

Commit 3564656

Browse files
Merge pull request #239637 from AbhishekMallick01/May-29-2023-QS
QS freshness - Article updates
2 parents 9570566 + 4e92510 commit 3564656

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

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

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
---
22
title: Back up Azure Disks using Azure Data Protection REST API.
33
description: In this article, learn how to configure, initiate, and manage backup operations of Azure Disks using REST API.
4-
ms.topic: conceptual
5-
ms.date: 10/06/2021
4+
ms.topic: how-to
5+
ms.date: 05/30/2023
66
ms.assetid: 6050a941-89d7-4b27-9976-69898cc34cde
77
author: jyothisuri
88
ms.author: jsuri
9+
ms.custom: engagement-fy23
910
---
1011

1112
# Back up Azure Disks using Azure Data Protection via REST API
1213

1314
This article describes how to manage backups for Azure Disks via REST API.
1415

16+
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.
17+
1518
For information on the Azure Disk backup region availability, supported scenarios and limitations, see the [support matrix](disk-backup-support-matrix.md).
1619

1720
## Prerequisites
@@ -52,7 +55,7 @@ You need to assign a few permissions via RBAC to the vault (represented by vault
5255

5356
### Prepare the request to configure backup
5457

55-
Once the relevant permissions are set to the vault and the disk, and the vault and policy are configured, we can prepare the request to configure backup. The following is the request body to configure backup for an Azure Disk. The Azure Resource Manager ID (ARM ID) of the Azure Disk and its details are mentioned in the _datasourceinfo_ section and the policy information is present in the _policyinfo_ section where the snapshot resource group is provided as one of the policy parameters.
58+
Once the relevant permissions are set to the vault and the disk, and the vault and policy are configured, we can prepare the request to configure backup. The following is the request body to configure backup for an Azure Disk. The Azure Resource Manager ID (ARM ID) of the Azure Disk and its details are mentioned in the `datasourceinfo` section and the policy information is present in the `policyinfo` section where the snapshot resource group is provided as one of the policy parameters.
5659

5760
```json
5861
{
@@ -101,7 +104,7 @@ POST https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
101104

102105
The [request body](#prepare-the-request-to-configure-backup) that we prepared earlier will be used to provide details of the Azure Disk to be protected.
103106

104-
#### Example request body
107+
**Example request body**
105108

106109
```json
107110
{
@@ -136,17 +139,17 @@ The [request body](#prepare-the-request-to-configure-backup) that we prepared ea
136139

137140
Backup request validation is an [asynchronous operation](../azure-resource-manager/management/async-operations.md). So, this operation creates another operation that needs to be tracked separately.
138141

139-
It returns two responses: 202 (Accepted) when another operation is created and then 200 (OK) when that operation completes.
142+
It returns two responses: 202 (Accepted) when another operation is created and 200 (OK) when that operation completes.
140143

141144
|Name |Type |Description |
142145
|---------|---------|---------|
143146
|202 Accepted | | The operation will be completed asynchronously |
144147
|200 OK | [OperationJobExtendedInfo](/rest/api/dataprotection/backup-instances/validate-for-backup#operationjobextendedinfo) | Accepted |
145148
| Other Status codes | [CloudError](/rest/api/dataprotection/backup-instances/validate-for-backup#clouderror) | Error response describing why the operation failed |
146149

147-
##### Example responses for validate backup request
150+
**Example responses for validate backup request**
148151

149-
###### Error response
152+
##### Error response
150153

151154
If the given disk is already protected, it returns the response as HTTP 400 (Bad request) and states that the given disk is protected to a backup vault along with details.
152155

@@ -196,7 +199,7 @@ X-Powered-By: ASP.NET
196199
}
197200
```
198201

199-
###### Tracking response
202+
##### Track response
200203

201204
If the datasource is unprotected, then the API proceeds for further validations and creates a tracking operation.
202205

@@ -459,7 +462,7 @@ DELETE "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/Test
459462

460463
*DELETE* protection is an [asynchronous operation](../azure-resource-manager/management/async-operations.md). So, this operation creates another operation that needs to be tracked separately.
461464

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

464467
|Name |Type |Description |
465468
|---------|---------|---------|

0 commit comments

Comments
 (0)