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/manage-azure-file-share-rest-api.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
---
2
-
title: Manage Azure File share backup with REST API
3
-
description: Learn how to use REST API to manage and monitor Azure file shares that are backed up by Azure Backup.
2
+
title: Manage Azure Files backup with REST API
3
+
description: Learn how to use REST API to manage and monitor Azure Files that are backed up by Azure Backup.
4
4
ms.topic: how-to
5
-
ms.date: 09/11/2024
5
+
ms.date: 03/05/2025
6
6
author: jyothisuri
7
7
ms.author: jsuri
8
8
---
9
9
10
-
# Manage Azure File share backup with REST API
10
+
# Manage Azure Files backup with REST API
11
11
12
-
This article explains how to perform tasks for managing and monitoring the Azure file shares that are backed up by [Azure Backup](./backup-overview.md).
12
+
This article explains how to perform tasks for managing and monitoring the Azure Files that are backed up by [Azure Backup](./backup-overview.md).
13
13
14
14
## Monitor jobs
15
15
@@ -35,7 +35,7 @@ For example, the final response of a [trigger backup REST API](backup-azure-file
35
35
}
36
36
```
37
37
38
-
The Azure file share backup job is identified by the **jobId** field and can be tracked as mentioned [here](/rest/api/backup/job-details) using a GET request.
38
+
The Azure Files backup job is identified by the **jobId** field and can be tracked as mentioned [here](/rest/api/backup/job-details) using a GET request.
39
39
40
40
### Tracking the job
41
41
@@ -108,7 +108,7 @@ HTTP/1.1" 200
108
108
109
109
## Modify policy
110
110
111
-
To change the policy with which the file share is protected, you can use the same format as enabling protection. Just provide the new policy ID in the request policy and submit the request.
111
+
To change the policy with which the File Share is protected, you can use the same format as enabling protection. Just provide the new policy ID in the request policy and submit the request.
112
112
113
113
For example: To change the protection policy of *testshare* from *schedule1* to *schedule2*, provide the *schedule2* ID in the request body.
114
114
@@ -124,7 +124,7 @@ For example: To change the protection policy of *testshare* from *schedule1* to
124
124
125
125
## Stop protection but retain existing data
126
126
127
-
You can remove protection on a protected file share but retain the data already backed up. To do so, remove the policy in the request body you used to [enable backup](backup-azure-file-share-rest-api.md#enable-backup-for-the-file-share) and submit the request. Once the association with the policy is removed, backups are no longer triggered, and no new recovery points are created.
127
+
You can remove protection on a protected File Share but retain the data already backed up. To do so, remove the policy in the request body you used to [enable backup](backup-azure-file-share-rest-api.md#enable-backup-for-the-file-share) and submit the request. Once the association with the policy is removed, backups are no longer triggered, and no new recovery points are created.
128
128
129
129
```json
130
130
{
@@ -139,7 +139,7 @@ You can remove protection on a protected file share but retain the data already
139
139
140
140
### Sample response
141
141
142
-
Stopping protection for a file share is an asynchronous operation. The operation creates another operation that needs to be tracked. It returns two responses: 202 (Accepted) when another operation is created, and 200 when that operation completes.
142
+
Stopping protection for a File Share is an asynchronous operation. The operation creates another operation that needs to be tracked. It returns two responses: 202 (Accepted) when another operation is created, and 200 when that operation completes.
143
143
144
144
Response header when operation is successfully accepted:
145
145
@@ -187,15 +187,15 @@ GET https://management.azure.com/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af
187
187
188
188
## Stop protection and delete data
189
189
190
-
To remove the protection on a protected file share and delete the backup data as well, perform a delete operation as detailed [here](/rest/api/backup/protected-items/delete).
190
+
To remove the protection on a protected File Share and delete the backup data as well, perform a delete operation as detailed [here](/rest/api/backup/protected-items/delete).
The parameters {containerName} and {protectedItemName} are as set [here](restore-azure-file-share-rest-api.md#fetch-containername-and-protecteditemname).
197
197
198
-
The following example triggers an operation to stop protection for the *testshare*file share protected with *azurefilesvault*.
198
+
The following example triggers an operation to stop protection for the *testshare*File Share protected with *azurefilesvault*.
0 commit comments