Skip to content

Commit c046c84

Browse files
Merge pull request #294499 from AbhishekMallick01/Feb-12-2025-AFSv1
AF Backup - Workload name update as per guideline
2 parents e338aec + fd6c143 commit c046c84

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

articles/backup/restore-afs-powershell.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
title: Restore Azure Files with PowerShell
33
description: In this article, learn how to restore Azure Files using the Azure Backup service and PowerShell.
44
ms.topic: how-to
5-
ms.date: 07/30/2024
5+
ms.date: 03/05/2025
66
ms.custom: devx-track-azurepowershell
77
author: jyothisuri
88
ms.author: jsuri
99
---
1010

1111
# Restore Azure Files with PowerShell
1212

13-
This article explains how to restore an entire file share, or specific files, from a restore point created by the [Azure Backup](backup-overview.md) service using Azure PowerShell.
13+
This article explains how to restore an entire File Share, or specific files, from a restore point created by the [Azure Backup](backup-overview.md) service using Azure PowerShell.
1414

15-
You can restore an entire file share or specific files on the share. You can restore to the original location, or to an alternate location.
15+
You can restore an entire File Share or specific files on the share. You can restore to the original location, or to an alternate location.
1616

1717
> [!WARNING]
1818
> Make sure the PowerShell version is upgraded to the minimum version for 'Az.RecoveryServices 2.6.0' for AFS backups. For more information, see [the section](backup-azure-afs-automation.md#important-notice-backup-item-identification) outlining the requirement for this change.
@@ -57,15 +57,15 @@ ContainerType : AzureStorage
5757
BackupManagementType : AzureStorage
5858
```
5959

60-
After the relevant recovery point is selected, you restore the file share or file to the original location, or to an alternate location.
60+
After the relevant recovery point is selected, you restore the File Share or file to the original location, or to an alternate location.
6161

62-
## Restore an Azure file share to an alternate location
62+
## Restore a File Share to an alternate location
6363

6464
Use the [Restore-AzRecoveryServicesBackupItem](/powershell/module/az.recoveryservices/restore-azrecoveryservicesbackupitem) to restore to the selected recovery point. Specify these parameters to identify the alternate location:
6565

6666
* **TargetStorageAccountName**: The storage account to which the backed-up content is restored. The target storage account must be in the same location as the vault.
67-
* **TargetFileShareName**: The file shares within the target storage account to which the backed-up content is restored.
68-
* **TargetFolder**: The folder under the file share to which data is restored. If the backed-up content is to be restored to a root folder, give the target folder values as an empty string.
67+
* **TargetFileShareName**: The File Shares within the target storage account to which the backed-up content is restored.
68+
* **TargetFolder**: The folder under the File Share to which data is restored. If the backed-up content is to be restored to a root folder, give the target folder values as an empty string.
6969
* **ResolveConflict**: Instruction if there's a conflict with the restored data. Accepts **Overwrite** or **Skip**.
7070

7171
Run the cmdlet with the parameters as follows:
@@ -82,14 +82,14 @@ WorkloadName Operation Status StartTime
8282
testAzureFS Restore InProgress 12/10/2018 9:56:38 AM 9fd34525-6c46-496e-980a-3740ccb2ad75
8383
```
8484

85-
## Restore an Azure file to an alternate location
85+
## Restore Azure Files to an alternate location
8686

8787
Use the [Restore-AzRecoveryServicesBackupItem](/powershell/module/az.recoveryservices/restore-azrecoveryservicesbackupitem) to restore to the selected recovery point. Specify these parameters to identify the alternate location, and to uniquely identify the file you want to restore.
8888

8989
* **TargetStorageAccountName**: The storage account to which the backed-up content is restored. The target storage account must be in the same location as the vault.
90-
* **TargetFileShareName**: The file shares within the target storage account to which the backed-up content is restored.
91-
* **TargetFolder**: The folder under the file share to which data is restored. If the backed-up content is to be restored to a root folder, give the target folder values as an empty string.
92-
* **SourceFilePath**: The absolute path of the file, to be restored within the file share, as a string. This path is the same path used in the **Get-AzStorageFile** PowerShell cmdlet.
90+
* **TargetFileShareName**: The File Shares within the target storage account to which the backed-up content is restored.
91+
* **TargetFolder**: The folder under the File Share to which data is restored. If the backed-up content is to be restored to a root folder, give the target folder values as an empty string.
92+
* **SourceFilePath**: The absolute path of the file, to be restored within the File Share, as a string. This path is the same path used in the **Get-AzStorageFile** PowerShell cmdlet.
9393
* **SourceFileType**: Whether a directory or a file is selected. Accepts **Directory** or **File**.
9494
* **ResolveConflict**: Instruction if there's a conflict with the restored data. Accepts **Overwrite** or **Skip**.
9595

@@ -101,17 +101,17 @@ Restore-AzRecoveryServicesBackupItem -RecoveryPoint $rp[0] -TargetStorageAccount
101101

102102
This command returns a job with an ID to be tracked, as shown in the previous section.
103103

104-
## Restore Azure file shares and files to the original location
104+
## Restore Azure Files and files to the original location
105105

106106
When you restore to an original location, you don't need to specify destination- and target-related parameters. Only **ResolveConflict** must be provided.
107107

108-
### Overwrite an Azure file share
108+
### Overwrite the Azure Files
109109

110110
```powershell
111111
Restore-AzRecoveryServicesBackupItem -RecoveryPoint $rp[0] -ResolveConflict Overwrite
112112
```
113113

114-
### Overwrite an Azure file
114+
### Overwrite the Azure Files
115115

116116
```powershell
117117
Restore-AzRecoveryServicesBackupItem -RecoveryPoint $rp[0] -SourceFileType File -SourceFilePath "TestDir/TestDoc.docx" -ResolveConflict Overwrite
@@ -165,7 +165,7 @@ WorkloadName Operation Status StartTime
165165
azurefiles Restore InProgress 4/5/2020 8:01:24 AM cd36abc3-0242-44b1-9964-0a9102b74d57
166166
```
167167

168-
If you want to restore multiple files or folders to alternate location, use the scripts above by specifying the target location-related parameter values, as explained above in [Restore an Azure file to an alternate location](#restore-an-azure-file-to-an-alternate-location).
168+
If you want to restore multiple files or folders to alternate location, use the scripts above by specifying the target location-related parameter values, as explained above in [Restore Azure Files to an alternate location](#restore-azure-files-to-an-alternate-location).
169169

170170
## Next steps
171171

0 commit comments

Comments
 (0)