Merge pull request #252200 from AbhishekMallick-MS/Sep-18-2023-QS-BlobRestore

prmerger-automator[bot] · web-flow · commit 2525ece4f0fb · 2023-09-20T12:43:20.000Z
QS Freshness - Blob restore using REST
diff --git a/articles/backup/backup-azure-dataprotection-use-rest-api-restore-blobs.md b/articles/backup/backup-azure-dataprotection-use-rest-api-restore-blobs.md
@@ -2,7 +2,8 @@
 title: Restore blobs in a storage account using Azure Data Protection REST API
 description: In this article, learn how to restore blobs of a storage account using REST API.
 ms.topic: conceptual
-ms.date: 07/09/2021
+ms.date: 09/20/2023
+ms.custom: engagement-fy24
 ms.assetid: 9b8d21e6-3e23-4345-bb2b-e21040996afd
 author: AbhishekMallick-MS
 ms.author: v-abhmallick
@@ -15,25 +16,13 @@ This article describes how to restore [blobs](blob-backup-overview.md) to any po
 > [!IMPORTANT]
 > Before proceeding to restore Azure blobs using Azure Backup, see [important points](blob-restore.md#before-you-start).
 
-In this article, you'll learn how to:
-
-- Restore Azure blobs to point-in-time
-
-- Track the restore operation status
-
 ## Prerequisites
 
-- [Create a Backup vault](backup-azure-dataprotection-use-rest-api-create-update-backup-vault.md)
-
-- [Create a blob backup policy](backup-azure-dataprotection-use-rest-api-create-update-blob-policy.md)
+This article assumes that you have an operational-blob-backup configured for one or more of your storage accounts. [Learn how to configure a backup for block blob data](backup-azure-dataprotection-use-rest-api-backup-blobs.md), if not done.
 
-- [Configure a blob backup](backup-azure-dataprotection-use-rest-api-backup-blobs.md)
+To illustrate the restoration steps in this article, we will refer to blobs in a storage account named `"msblobbackup-f2df34eb-5628-4570-87b2-0331d797c67d"` protected with an existing Backup vault `TestBkpVault`, under the resource group `testBkpVaultRG`.
 
-We will refer to an existing backup vault _TestBkpVault_, under the resource group _testBkpVaultRG_, where blobs in a storage account named "msblobbackup-f2df34eb-5628-4570-87b2-0331d797c67d" in the examples.
-
-## Restoring Azure blobs within a storage account
-
-### Fetching the valid time range for restore
+## Fetching the valid time range for restore
 
 As the operational backup for blobs is continuous, there are no distinct points to restore from. Instead, we need to fetch the valid time-range under which blobs can be restored to any point-in-time. In this example, let's check for valid time-ranges to restore within the last 30 days.
 
@@ -49,7 +38,7 @@ For our example, this translates to
 POST https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/TestBkpVaultRG/providers/Microsoft.DataProtection/backupVaults/testBkpVault/backupInstances/msblobbackup-f2df34eb-5628-4570-87b2-0331d797c67d/findRestorableTimeRanges?api-version=2021-01-01
 ```
 
-#### Create the request body to fetch valid time ranges for restore
+### Create the request body to fetch valid time ranges for restore
 
 To trigger an operation to calculate valid time ranges, following are the components of a request body
 
@@ -59,7 +48,7 @@ To trigger an operation to calculate valid time ranges, following are the compon
 |startTime     |    String     |  Start time for the List Restore Ranges request. ISO 8601 format.       |
 |endTime     |    String     |    End time for the List Restore Ranges request. ISO 8601 format.     |
 
-##### Example request body to fetch valid time range
+#### Example request body to fetch valid time range
 
 The following request body defines properties required to fetch the time ranges of the continuous data which can be restored. Since blob backups reside in the storage account, the datastore is 'Operational'. You can give start and end time that helps to narrow the search process and return the available time range.
 
@@ -115,15 +104,13 @@ X-Powered-By: ASP.NET
 }
 ```
 
-### Preparing the restore request
-
 Once the point-in-time to restore to the same storage account is fixed, there are multiple options to restore.
 
-#### Restoring all the blobs to a point-in-time
+## Option 1: Restore all the blobs to a point-in-time
 
 Using this option restores all block blobs in the storage account by rolling them back to the selected point in time. Storage accounts containing large amounts of data or witnessing a high churn may take longer times to restore.
 
-##### Constructing the request body for point-in-time restore of all blobs
+### Constructing the request body for point-in-time restore of all blobs
 
 The key points to remember in this scenario are:
 
@@ -156,7 +143,7 @@ The key points to remember in this scenario are:
 }
 ```
 
-#### Restoring few containers to a point-in-time
+## Option 2: Restore few containers to a point-in-time
 
 Using this option allows you to select up to 10 containers to restore or restore a subset of blobs using a prefix match. You can specify up to 10 lexicographical ranges of blobs within a single container or across multiple containers to return those blobs to their previous state at a given point in time. In case of using prefixes, here are a few things to keep in mind:
 
@@ -165,7 +152,7 @@ Using this option allows you to select up to 10 containers to restore or restore
 
 [Learn more](blob-restore.md#use-prefix-match-for-restoring-blobs) about using prefixes to restore blob ranges.
 
-##### Constructing the request body for point-in-time restore of selected containers or few blobs
+### Construct the request body for point-in-time restore of selected containers or few blobs
 
 The key points to remember in this scenario are:
 
@@ -205,9 +192,9 @@ The key points to remember in this scenario are:
 }
 ```
 
-#### Validating restore requests
+## Validate restore requests
 
-Once request body is prepared, it can be validated using the [validate for restore API](/rest/api/dataprotection/backup-instances/validate-for-restore). Like the validate for backup API, this is a *POST* operation.
+Once request body is prepared, it can be validated using the [validate for restore API](/rest/api/dataprotection/backup-instances/validate-for-restore). Like the Validate-for-backup API, this is a *POST* operation.
 
 ```http
 POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateRestore?api-version=2021-01-01
@@ -219,20 +206,20 @@ For our example, this translates to:
 POST "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/TestBkpVaultRG/providers/Microsoft.DataProtection/backupVaults/testBkpVault/backupInstances/msblobbackup-f2df34eb-5628-4570-87b2-0331d797c67d/validateRestore?api-version=2021-01-01"
 ```
 
-The request body for this POST API is detailed [here](/rest/api/dataprotection/backup-instances/validate-for-restore#request-body). We have constructed the same in the  above section for [all blobs restore](#constructing-the-request-body-for-point-in-time-restore-of-all-blobs) and [few items restore](#constructing-the-request-body-for-point-in-time-restore-of-selected-containers-or-few-blobs) scenarios. We will use the same to trigger a validate operation.
+The request body for this POST API is detailed [here](/rest/api/dataprotection/backup-instances/validate-for-restore#request-body). We have constructed the same in the  above section for [all blobs restore](#constructing-the-request-body-for-point-in-time-restore-of-all-blobs) and [few items restore](#construct-the-request-body-for-point-in-time-restore-of-selected-containers-or-few-blobs) scenarios. We will use the same to trigger a validate operation.
 
-##### Response to validate restore requests
+### Response to validate restore requests
 
 The validate restore request is an [asynchronous operation](../azure-resource-manager/management/async-operations.md). It means this operation creates another operation that needs to be tracked separately.
 
-It returns two responses: 202 (Accepted) when another operation is created and then 200 (OK) when that operation completes.
+It returns two responses: 202 (Accepted) when another operation is created, and 200 (OK) when that operation completes.
 
 |Name  |Type  |Description  |
 |---------|---------|---------|
 |200 OK     |         |  Status of validate request       |
 |202 Accepted     |         |     Accepted    |
 
-###### Example response to restore validate request
+#### Example response to restore validate-request
 
 Once the *POST* operation is submitted, the initial response will be 202 Accepted along with an Azure-asyncOperation header.
 
@@ -269,7 +256,7 @@ Track the Azure-AsyncOperation header with a simple *GET* request. When the requ
 }
 ```
 
-#### Triggering restore requests
+## Trigger restore requests
 
 The triggering restore operation is a ***POST*** API. All details about the trigger restore operation are documented [here](/rest/api/dataprotection/backup-instances/trigger-restore).
 
@@ -283,13 +270,13 @@ For our example, this translates to:
 POST "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/TestBkpVaultRG/providers/Microsoft.DataProtection/backupVaults/testBkpVault/backupInstances/msblobbackup-f2df34eb-5628-4570-87b2-0331d797c67d/restore?api-version=2021-01-01"
 ```
 
-##### Creating a request body for restore operations
+### Create a request body for restore operations
 
 Once the requests are validated, the same request body can be used to trigger the restore request with minor changes.
 
-###### Example request body for all blobs restore
+#### Example request body for all blobs restore
 
-The only change from the validate restore request body is to remove the "restoreRequest" object at the start.
+The only change from the validate-restore-request body is to remove the "restoreRequest" object at the start.
 
 ```json
 {
@@ -313,9 +300,9 @@ The only change from the validate restore request body is to remove the "restore
 }
 ```
 
-###### Example request body for items or few blobs restore
+#### Example request body for items or few blobs restore
 
-The only change from the validate restore request body is to remove the "restoreRequest" object at the start.
+The only change from the validate-restore-request body is to remove the "restoreRequest" object at the start.
 
 ```json
 {
@@ -346,18 +333,18 @@ The only change from the validate restore request body is to remove the "restore
 }
 ```
 
-#### Response to trigger restore requests
+### Response to trigger restore requests
 
 The trigger restore request is an [asynchronous operation](../azure-resource-manager/management/async-operations.md). It means this operation creates another operation that needs to be tracked separately.
 
-It returns two responses: 202 (Accepted) when another operation is created and then 200 (OK) when that operation completes.
+It returns two responses: 202 (Accepted) when another operation is created, and 200 (OK) when that operation completes.
 
 |Name  |Type  |Description  |
 |---------|---------|---------|
 |200 OK     |         |  Status of restore request       |
 |202 Accepted     |         |     Accepted    |
 
-##### Example response to trigger restore request
+#### Example response to trigger restore request
 
 Once the *POST* operation is submitted, the initial response will be 202 Accepted along with an Azure-asyncOperation header.
 
@@ -398,7 +385,7 @@ GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
 }
 ```
 
-#### Tracking jobs
+## Track jobs
 
 The trigger restore requests triggered the restore job and the resultant Job ID should be tracking using the [GET Jobs API](/rest/api/dataprotection/jobs/get).
 
diff --git a/articles/backup/backup-support-automation.md b/articles/backup/backup-support-automation.md
@@ -85,7 +85,7 @@ You  can automate most backup related tasks using programmatic methods in Azure
 | --- | --- | --- | --- | --- | --- | --- | --- | --- |
 | Backup | Create backup policy and configure backup | Supported    <br><br> [See the examples](./backup-blobs-storage-account-ps.md). | Supported    <br><br> [See the examples](./backup-blobs-storage-account-cli.md). | Supported    <br><br> [See the examples](./backup-azure-dataprotection-use-rest-api-backup-blobs.md). | Currently not supported | Supported | Supported    <br><br> [See the examples](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.dataprotection/backup-create-storage-account-enable-protection). | Supported    <br><br> [See the examples](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/data_protection_backup_instance_blob_storage). |
 | Restore | Restore blobs | Supported    <br><br> [See the examples](./restore-blobs-storage-account-ps.md). | Supported    <br><br> [See the examples](./restore-blobs-storage-account-cli.md). | Supported    <br><br> [See the examples](./backup-azure-dataprotection-use-rest-api-restore-blobs.md). | N/A | N/A | N/A | N/A |
-| Manage | Monitor jobs | Supported    <br><br> [See the examples](./restore-blobs-storage-account-ps.md#tracking-job). | Supported    <br><br> [See the examples](./restore-blobs-storage-account-cli.md#tracking-job). | Supported    <br><br> [See the examples](./backup-azure-dataprotection-use-rest-api-restore-blobs.md#tracking-jobs). | N/A | N/A | N/A | N/A |
+| Manage | Monitor jobs | Supported    <br><br> [See the examples](./restore-blobs-storage-account-ps.md#tracking-job). | Supported    <br><br> [See the examples](./restore-blobs-storage-account-cli.md#tracking-job). | Supported    <br><br> [See the examples](./backup-azure-dataprotection-use-rest-api-restore-blobs.md#track-jobs). | N/A | N/A | N/A | N/A |
 | Manage | Modify backup policy | Currently not supported | Currently not supported | Currently not supported | N/A | N/A | N/A | N/A |
 | Manage | Stop protection and retain backup data | Currently not supported | Currently not supported | Currently not supported | N/A | N/A | N/A | N/A |
 | Manage | Stop protection and delete backup data | Supported | Supported | Supported | N/A | N/A | N/A | N/A |
