Skip to content

Commit 4e062d4

Browse files
Merge pull request #294575 from AbhishekMallick01/Feb-13-2025-AFSV
AF Backup - Workload name update as per guideline
2 parents cdf31ee + 2e39539 commit 4e062d4

File tree

1 file changed

+19
-25
lines changed

1 file changed

+19
-25
lines changed

articles/backup/restore-azure-file-share-rest-api.md

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,19 @@
11
---
2-
title: Restore Azure file shares with REST API
3-
description: Learn how to use REST API to restore Azure file shares or specific files from a restore point created by Azure Backup
2+
title: Restore Azure Files with REST API
3+
description: Learn how to use REST API to restore Azure Files or specific files from a restore point created by Azure Backup
44
ms.topic: how-to
5-
ms.date: 02/09/2025
5+
ms.date: 03/05/2025
66
author: jyothisuri
77
ms.author: jsuri
88
---
99

10-
# Restore Azure File Shares using REST API
10+
# Restore Azure Files using REST API
1111

12-
This article explains how to restore an entire file share or specific files from a restore point created by [Azure Backup](./backup-overview.md) by using the REST API.
13-
14-
By the end of this article, you learn how to perform the following operations using REST API:
15-
16-
* View restore points for a backed-up Azure file share.
17-
* Restore a full Azure file share.
18-
* Restore individual files or folders.
12+
This article explains how to restore an entire File Share or specific files from a restore point created by [Azure Backup](./backup-overview.md) by using the REST API.
1913

2014
## Prerequisites
2115

22-
We assume that you already have a backed-up file share you want to restore. If you don’t, check [Backup Azure file share using REST API](backup-azure-file-share-rest-api.md) to learn how to create one.
16+
We assume that you already have a backed-up File Share you want to restore. If you don’t, check [Backup Azure Files using REST API](backup-azure-file-share-rest-api.md) to learn how to create one.
2317

2418
For this article, we use the following resources:
2519

@@ -30,7 +24,7 @@ For this article, we use the following resources:
3024

3125
## Fetch ContainerName and ProtectedItemName
3226

33-
For most of the restore related API calls, you need to pass values for the {containerName} and {protectedItemName} URI parameters. Use the ID attribute in the response body of the [GET backupprotectableitems](/rest/api/backup/protected-items/get) operation to retrieve values for these parameters. In our example, the ID of the file share we want to protect is:
27+
For most of the restore related API calls, you need to pass values for the {containerName} and {protectedItemName} URI parameters. Use the ID attribute in the response body of the [GET backupprotectableitems](/rest/api/backup/protected-items/get) operation to retrieve values for these parameters. In our example, the ID of the File Share we want to protect is:
3428

3529
`"/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/protectionContainers/storagecontainer;storage;azurefiles;afsaccount/protectableItems/azurefileshare;azurefiles`
3630

@@ -39,9 +33,9 @@ So the values translate as follows:
3933
* {containername} - *storagecontainer;storage;azurefiles;afsaccount*
4034
* {protectedItemName} - *azurefileshare;azurefiles*
4135

42-
## Fetch recovery points for backed up Azure file share
36+
## Fetch recovery points for backed up Azure Files
4337

44-
To restore any backed-up file share or files, first select a recovery point to perform the restore operation. The available recovery points of a backed-up item can be listed using the [Recovery Point-List](/rest/api/site-recovery/recoverypoints/listbyreplicationprotecteditems) REST API call. It's a GET operation with all the relevant values.
38+
To restore any backed-up File Share or files, first select a recovery point to perform the restore operation. The available recovery points of a backed-up item can be listed using the [Recovery Point-List](/rest/api/site-recovery/recoverypoints/listbyreplicationprotecteditems) REST API call. It's a GET operation with all the relevant values.
4539

4640
```http
4741
GET https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints?api-version=2019-05-13&$filter={$filter}
@@ -140,7 +134,7 @@ The recovery point is identified with the {name} field in the response above.
140134

141135
## Full share recovery using REST API
142136

143-
Use this restore option to restore the complete file share in the original or an alternate location.
137+
Use this restore option to restore the complete File Share in the original or an alternate location.
144138
Triggering restore is a POST request and you can perform this operation using the [trigger restore](/rest/api/backup/restores/trigger) REST API.
145139

146140
```http
@@ -155,7 +149,7 @@ POST https://management.azure.com/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48a
155149

156150
### Create request body
157151

158-
To trigger a restore for an Azure file share, the following are the components of the request body:
152+
To trigger a restore for an Azure Files, the following are the components of the request body:
159153

160154
Name | Type | Description
161155
--- | ---- | ----
@@ -167,7 +161,7 @@ For the complete list of definitions of the request body and other details, refe
167161

168162
#### Request body example for restore to original location
169163

170-
The following request body defines properties required to trigger an Azure file share restore:
164+
The following request body defines properties required to trigger an Azure Files restore:
171165

172166
```json
173167
{
@@ -186,12 +180,12 @@ The following request body defines properties required to trigger an Azure file
186180
Specify the following parameters for alternate location recovery:
187181

188182
* **targetResourceId**: The storage account to which the backed-up content is restored. The target storage account must be in the same location as the vault.
189-
* **name**: The file share within the target storage account to which the backed-up content is restored.
190-
* **targetFolderPath**: The folder under the file share to which data is restored.
183+
* **name**: The File Share within the target storage account to which the backed-up content is restored.
184+
* **targetFolderPath**: The folder under the File Share to which data is restored.
191185

192186
#### Request body example for restore to alternate location
193187

194-
The following request body restores the *azurefiles* file share in the *afsaccount* storage account to the *azurefiles1* file share in the *afaccount1* storage account.
188+
The following request body restores the *azurefiles* File Share in the *afsaccount* storage account to the *azurefiles1* File Share in the *afaccount1* storage account.
195189

196190
```json
197191
{
@@ -365,7 +359,7 @@ POST https://management.azure.com/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48a
365359

366360
### Create request body for item-level recovery using REST API
367361

368-
To trigger a restore for an Azure file share, the following are the components of the request body:
362+
To trigger a restore for an Azure Files, the following are the components of the request body:
369363

370364
Name | Type | Description
371365
--- | ---- | ----
@@ -375,7 +369,7 @@ For the complete list of definitions of the request body and other details, refe
375369

376370
### Restore to original location for item-level recovery using REST API
377371

378-
The following request body is to restore the *Restoretest.txt* file in the *azurefiles* file share in the *afsaccount* storage account.
372+
The following request body is to restore the *Restoretest.txt* file in the *azurefiles* File Share in the *afsaccount* storage account.
379373

380374
Create Request Body
381375

@@ -401,7 +395,7 @@ Create Request Body
401395

402396
### Restore to alternate location for item-level recovery using REST API
403397

404-
The following request body is to restore the *Restoretest.txt* file in the *azurefiles* file share in the *afsaccount* storage account to the *restoredata* folder of the *azurefiles1* file share in the *afaccount1* storage account.
398+
The following request body is to restore the *Restoretest.txt* file in the *azurefiles* File Share in the *afsaccount* storage account to the *restoredata* folder of the *azurefiles1* File Share in the *afaccount1* storage account.
405399

406400
Create request body
407401

@@ -432,4 +426,4 @@ The response should be handled in the same way as explained above for [full shar
432426

433427
## Next steps
434428

435-
* Learn how to [manage Azure file shares backup using REST API](manage-azure-file-share-rest-api.md).
429+
* Learn how to [manage Azure Files backup using REST API](manage-azure-file-share-rest-api.md).

0 commit comments

Comments
 (0)