You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/backup/backup-azure-file-share-rest-api.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,17 @@
1
1
---
2
-
title: Back up Azure file shares with REST API
3
-
description: Learn how to use REST API to back up Azure file shares in the Recovery Services vault
2
+
title: Back up Azure Files with REST API
3
+
description: Learn how to use REST API to back up Azure Files in the Recovery Services vault
4
4
ms.topic: how-to
5
-
ms.date: 02/09/2025
5
+
ms.date: 03/05/2025
6
6
author: jyothisuri
7
7
ms.author: jsuri
8
8
---
9
9
10
-
# Backup Azure file share using Azure Backup via REST API
10
+
# Backup Azure Files using Azure Backup via REST API
11
11
12
-
This article describes how to back up an Azure File share using Azure Backup via REST API.
12
+
This article describes how to back up an Azure Files using Azure Backup via REST API.
13
13
14
-
This article assumes you've already created a Recovery Services vault and policy for configuring backup for your file share. If you haven’t, refer to the [create vault](./backup-azure-arm-userestapi-createorupdatevault.md) and [create policy](./backup-azure-arm-userestapi-createorupdatepolicy.md) REST API tutorials for creating new vaults and policies.
14
+
This article assumes you've already created a Recovery Services vault and policy for configuring backup for your File Share. If you haven’t, refer to the [create vault](./backup-azure-arm-userestapi-createorupdatevault.md) and [create policy](./backup-azure-arm-userestapi-createorupdatepolicy.md) REST API tutorials for creating new vaults and policies.
15
15
16
16
For this article, we'll use the following resources:
17
17
@@ -25,11 +25,11 @@ For this article, we'll use the following resources:
25
25
26
26
-**File Share**: `testshare`
27
27
28
-
## Configure backup for an unprotected Azure file share using REST API
28
+
## Configure backup for an unprotected Azure Files using REST API
29
29
30
-
### Discover storage accounts with unprotected Azure file shares
30
+
### Discover storage accounts with unprotected Azure Files
31
31
32
-
The vault needs to discover all Azure storage accounts in the subscription with file shares that can be backed up to the Recovery Services vault. This is triggered using the [refresh operation](/rest/api/backup/protection-containers/refresh). It's an asynchronous *POST* operation that ensures the vault gets the latest list of all unprotected Azure File shares in the current subscription and 'caches' them. Once the file share is 'cached', Recovery services can access the file share and protect it.
32
+
The vault needs to discover all Azure storage accounts in the subscription with File Shares that can be backed up to the Recovery Services vault. This is triggered using the [refresh operation](/rest/api/backup/protection-containers/refresh). It's an asynchronous *POST* operation that ensures the vault gets the latest list of all unprotected Azure File Shares in the current subscription and 'caches' them. Once the File Share is 'cached', Recovery services can access the File Share and protect it.
33
33
34
34
```http
35
35
POST https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{vaultresourceGroupname}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/refreshContainers?api-version=2016-12-01&$filter={$filter}
@@ -86,7 +86,7 @@ Track the resulting operation using the "Location" header with a simple *GET* co
86
86
GET https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/operationResults/cca47745-12d2-42f9-b3a4-75335f18fdf6?api-version=2016-12-01
87
87
```
88
88
89
-
Once all the Azure Storage accounts are discovered, the GET command returns a 204 (No Content) response. The vault is now able to discover any storage account with file shares that can be backed up within the subscription.
89
+
Once all the Azure Storage accounts are discovered, the GET command returns a 204 (No Content) response. The vault is now able to discover any storage account with File Shares that can be backed up within the subscription.
### Get List of storage accounts with file shares that can be backed up with Recovery Services vault
106
+
### Get List of storage accounts with File Shares that can be backed up with Recovery Services vault
107
107
108
-
To confirm that “caching” is done, list all the storage accounts in the subscription with file shares that can be backed up with the Recovery Services vault. Then locate the desired storage account in the response. This is done using the [GET ProtectableContainers](/rest/api/backup/protectable-containers/list) operation.
108
+
To confirm that “caching” is done, list all the storage accounts in the subscription with File Shares that can be backed up with the Recovery Services vault. Then locate the desired storage account in the response. This is done using the [GET ProtectableContainers](/rest/api/backup/protectable-containers/list) operation.
109
109
110
110
```http
111
111
GET https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/protectableContainers?api-version=2016-12-01&$filter=backupManagementType eq 'AzureStorage'
You can list all protectable items under the subscription and locate the desired file share to be backed up using the [GET backupprotectableItems](/rest/api/backup/backup-protectable-items/list) operation.
276
+
You can list all protectable items under the subscription and locate the desired File Share to be backed up using the [GET backupprotectableItems](/rest/api/backup/backup-protectable-items/list) operation.
277
277
278
278
```http
279
279
GET https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectableItems?api-version=2016-12-01&$filter={$filter}
@@ -344,11 +344,11 @@ Status Code:200
344
344
}
345
345
```
346
346
347
-
The response contains the list of all unprotected file shares and contains all the information required by the Azure Recovery Service to configure the backup.
347
+
The response contains the list of all unprotected File Shares and contains all the information required by the Azure Recovery Service to configure the backup.
348
348
349
-
### Enable backup for the file share
349
+
### Enable backup for the File Share
350
350
351
-
After the relevant file share is "identified" with the friendly name, select the policy to protect. To learn more about existing policies in the vault, refer to [list Policy API](/rest/api/backup/backup-policies/list). Then select the [relevant policy](/rest/api/backup/protection-policies/get) by referring to the policy name. To create policies, refer to [create policy tutorial](./backup-azure-arm-userestapi-createorupdatepolicy.md).
351
+
After the relevant File Share is "identified" with the friendly name, select the policy to protect. To learn more about existing policies in the vault, refer to [list Policy API](/rest/api/backup/backup-policies/list). Then select the [relevant policy](/rest/api/backup/protection-policies/get) by referring to the policy name. To create policies, refer to [create policy tutorial](./backup-azure-arm-userestapi-createorupdatepolicy.md).
352
352
353
353
Enabling protection is an asynchronous *PUT* operation that creates a "protected item".
354
354
@@ -358,7 +358,7 @@ PUT https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{
358
358
359
359
Set the **containername** and **protecteditemname** variables using the ID attribute in the response body of the GET backupprotectableitems operation.
360
360
361
-
In our example, the ID of file share we want to protect is:
361
+
In our example, the ID of File Share we want to protect is:
This confirms that protection is enabled for the file share and the first backup will be triggered according to the policy schedule.
445
+
This confirms that protection is enabled for the File Share and the first backup will be triggered according to the policy schedule.
446
446
447
-
## Trigger an on-demand backup for file share
447
+
## Trigger an on-demand backup for File Share
448
448
449
-
Once an Azure file share is configured for backup, backups run according to the policy schedule. You can wait for the first scheduled backup or trigger an on-demand backup anytime.
449
+
Once an Azure Files is configured for backup, backups run according to the policy schedule. You can wait for the first scheduled backup or trigger an on-demand backup anytime.
450
450
451
451
Triggering an on-demand backup is a POST operation.
452
452
@@ -541,4 +541,4 @@ Since the backup job is a long running operation, it needs to be tracked as expl
541
541
542
542
## Next steps
543
543
544
-
- Learn how to [restore Azure file shares using REST API](restore-azure-file-share-rest-api.md).
544
+
- Learn how to [restore Azure Files using REST API](restore-azure-file-share-rest-api.md).
![prmerger-automator[bot]](https://avatars.githubusercontent.com/u/22479449?v=4&size=40){kind=avatar}
0 commit comments