Skip to content

Commit 0eb53cf

Browse files
author
AbhishekMallick01
committed
AF Backup - Workload name update as per guideline
1 parent 2e39539 commit 0eb53cf

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
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.
44
ms.topic: how-to
5-
ms.date: 09/11/2024
5+
ms.date: 03/05/2025
66
author: jyothisuri
77
ms.author: jsuri
88
---
99

10-
# Manage Azure File share backup with REST API
10+
# Manage Azure Files backup with REST API
1111

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).
1313

1414
## Monitor jobs
1515

@@ -35,7 +35,7 @@ For example, the final response of a [trigger backup REST API](backup-azure-file
3535
}
3636
```
3737

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.
3939

4040
### Tracking the job
4141

@@ -108,7 +108,7 @@ HTTP/1.1" 200
108108

109109
## Modify policy
110110

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.
112112

113113
For example: To change the protection policy of *testshare* from *schedule1* to *schedule2*, provide the *schedule2* ID in the request body.
114114

@@ -124,7 +124,7 @@ For example: To change the protection policy of *testshare* from *schedule1* to
124124

125125
## Stop protection but retain existing data
126126

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.
128128

129129
```json
130130
{
@@ -139,7 +139,7 @@ You can remove protection on a protected file share but retain the data already
139139

140140
### Sample response
141141

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.
143143

144144
Response header when operation is successfully accepted:
145145

@@ -187,15 +187,15 @@ GET https://management.azure.com/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af
187187

188188
## Stop protection and delete data
189189

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).
191191

192192
```http
193193
DELETE https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}?api-version=2019-05-13
194194
```
195195

196196
The parameters {containerName} and {protectedItemName} are as set [here](restore-azure-file-share-rest-api.md#fetch-containername-and-protecteditemname).
197197

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*.
199199

200200
```http
201201
DELETE https://management.azure.com/Subscriptions/ef4ab5a7-c2c0-4304-af80-af49f48af3d1/resourceGroups/azurefiles/providers/Microsoft.RecoveryServices/vaults/azurefilesvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;AzureFiles;testvault2/protectedItems/azurefileshare;testshare?api-version=2016-12-01
@@ -208,4 +208,4 @@ It returns two responses: 202 (Accepted) when another operation is created and 2
208208

209209
## Next steps
210210

211-
* Learn how to [troubleshoot problems while configuring backup for Azure File shares](troubleshoot-azure-files.md).
211+
* Learn how to [troubleshoot problems while configuring backup for Azure Files](troubleshoot-azure-files.md).

0 commit comments

Comments
 (0)