Skip to content

Commit d9f6dd3

Browse files
Merge branch 'release-afs-backup' into Feb-12-2025-AFSv2
2 parents 2b8fe98 + c046c84 commit d9f6dd3

10 files changed

+95
-95
lines changed

articles/backup/backup-afs-cli.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
title: Back up Azure file shares with Azure CLI
3-
description: Learn how to use Azure CLI to back up Azure file shares in the Recovery Services vault
2+
title: Back up Azure Files with Azure CLI
3+
description: Learn how to use Azure CLI to back up Azure Files in the Recovery Services vault
44
ms.topic: how-to
55
ms.custom: devx-track-azurecli, engagement-fy24
6-
ms.date: 03/20/2024
6+
ms.date: 03/05/2025
77
author: jyothisuri
88
ms.author: jsuri
99
---
1010

11-
# Back up Azure file shares with Azure CLI
11+
# Back up Azure Files with Azure CLI
1212

13-
The Azure CLI provides a command-line experience for managing Azure resources. It's a great tool for building custom automation to use Azure resources. This article details how to back up Azure file shares with Azure CLI. You can also perform these steps via [Azure PowerShell](./backup-azure-afs-automation.md) or the [Azure portal](backup-afs.md).
13+
The Azure CLI provides a command-line experience for managing Azure resources. It's a great tool for building custom automation to use Azure resources. This article details how to back up Azure Files with Azure CLI. You can also perform these steps via [Azure PowerShell](./backup-azure-afs-automation.md) or the [Azure portal](backup-afs.md).
1414

1515
By the end of this tutorial, you'll learn how to perform the operations below with Azure CLI:
1616

1717
* Create a Recovery Services vault
18-
* Enable backup for Azure file shares
19-
* Trigger an on-demand backup for file shares
18+
* Enable backup for Azure Files
19+
* Trigger an on-demand backup for File Shares
2020

2121
[!INCLUDE [azure-cli-prepare-your-environment.md](~/reusable-content/azure-cli/azure-cli-prepare-your-environment.md)]
2222

@@ -54,13 +54,13 @@ Follow these steps to create a Recovery Services vault:
5454
eastus azurefilesvault azurefiles
5555
```
5656
57-
## Enable backup for Azure file shares
57+
## Enable backup for Azure Files
5858
59-
This section assumes that you already have an Azure file share for which you want to configure backup. If you don't have one, create an Azure file share using the [az storage share create](/cli/azure/storage/share#az-storage-share-create) command.
59+
This section assumes that you already have an Azure Files for which you want to configure backup. If you don't have one, create an Azure Files using the [az storage share create](/cli/azure/storage/share#az-storage-share-create) command.
6060
61-
To enable backup for file shares, you need to create a protection policy that defines when a backup job runs and how long recovery points are stored. You can create a backup policy using the [az backup policy create](/cli/azure/backup/policy#az-backup-policy-create) cmdlet.
61+
To enable backup for File Shares, you need to create a protection policy that defines when a backup job runs and how long recovery points are stored. You can create a backup policy using the [az backup policy create](/cli/azure/backup/policy#az-backup-policy-create) cmdlet.
6262
63-
The following example uses the [az backup protection enable-for-azurefileshare](/cli/azure/backup/protection#az-backup-protection-enable-for-azurefileshare) cmdlet to enable backup for the *azurefiles* file share in the *afsaccount* storage account using the *schedule 1* backup policy:
63+
The following example uses the [az backup protection enable-for-azurefileshare](/cli/azure/backup/protection#az-backup-protection-enable-for-azurefileshare) cmdlet to enable backup for the *azurefiles* File Share in the *afsaccount* storage account using the *schedule 1* backup policy:
6464
6565
```azurecli-interactive
6666
az backup protection enable-for-azurefileshare --vault-name azurefilesvault --resource-group azurefiles --policy-name schedule1 --storage-account afsaccount --azure-file-share azurefiles --output table
@@ -74,14 +74,14 @@ Name ResourceGroup
7474

7575
The **Name** attribute in the output corresponds to the name of the job that's created by the backup service for your **enable backup** operation. To track status of the job, use the [az backup job show](/cli/azure/backup/job#az-backup-job-show) cmdlet.
7676

77-
## Trigger an on-demand backup for file share
77+
## Trigger an on-demand backup for File Share
7878

79-
If you want to trigger an on-demand backup for your file share instead of waiting for the backup policy to run the job at the scheduled time, use the [az backup protection backup-now](/cli/azure/backup/protection#az-backup-protection-backup-now) cmdlet.
79+
If you want to trigger an on-demand backup for your File Share instead of waiting for the backup policy to run the job at the scheduled time, use the [az backup protection backup-now](/cli/azure/backup/protection#az-backup-protection-backup-now) cmdlet.
8080

8181
You need to define the following parameters to trigger an on-demand backup:
8282

83-
* **--container-name** is the name of the storage account hosting the file share. To retrieve the **name** or **friendly name** of your container, use the [az backup container list](/cli/azure/backup/container#az-backup-container-list) command.
84-
* **--item-name** is the name of the file share for which you want to trigger an on-demand backup. To retrieve the **name** or **friendly name** of your backed-up item, use the [az backup item list](/cli/azure/backup/item#az-backup-item-list) command.
83+
* **--container-name** is the name of the storage account hosting the File Share. To retrieve the **name** or **friendly name** of your container, use the [az backup container list](/cli/azure/backup/container#az-backup-container-list) command.
84+
* **--item-name** is the name of the File Share for which you want to trigger an on-demand backup. To retrieve the **name** or **friendly name** of your backed-up item, use the [az backup item list](/cli/azure/backup/item#az-backup-item-list) command.
8585
* **--retain-until** specifies the date until when you want to retain the recovery point. The value should be set in UTC time format (dd-mm-yyyy).
8686

8787
The following example triggers an on-demand backup for the *azurefiles* fileshare in the *afsaccount* storage account with retention until *20-01-2020*.
@@ -100,5 +100,5 @@ The **Name** attribute in the output corresponds to the name of the job that's c
100100

101101
## Next steps
102102

103-
* Learn how to [Restore Azure file shares with CLI](restore-afs-cli.md)
104-
* Learn how to [Manage Azure file share backups with CLI](manage-afs-backup-cli.md)
103+
* Learn how to [Restore Azure Files with CLI](restore-afs-cli.md)
104+
* Learn how to [Manage Azure Files backups with CLI](manage-afs-backup-cli.md)

articles/backup/backup-support-automation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ You can automate most backup related tasks using programmatic methods in Azure
7272

7373
| **Category** | **Operation** | **PowerShell** | **CLI** | **REST API** | **Azure Policy** | **ARM Template** | **Bicep** | **Terraform** |
7474
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
75-
| Backup | Create backup policy and configure backup | Supported <br><br> [See the examples](./backup-azure-afs-automation.md#configure-a-backup-policy). | Supported <br><br> [See the examples](./backup-afs-cli.md#enable-backup-for-azure-file-shares). | Supported <br><br> [See the examples](./backup-azure-file-share-rest-api.md#configure-backup-for-an-unprotected-azure-files-using-rest-api). | Currently not supported | Supported <br><br> [See the examples](./backup-rm-template-samples.md). | Supported | Supported <br><br> [See the examples](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/backup_protected_file_share). |
75+
| Backup | Create backup policy and configure backup | Supported <br><br> [See the examples](./backup-azure-afs-automation.md#configure-a-backup-policy). | Supported <br><br> [See the examples](./backup-afs-cli.md#enable-backup-for-azure-files). | Supported <br><br> [See the examples](./backup-azure-file-share-rest-api.md#configure-backup-for-an-unprotected-azure-file-share-using-rest-api). | Currently not supported | Supported <br><br> [See the examples](./backup-rm-template-samples.md). | Supported | Supported <br><br> [See the examples](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/backup_protected_file_share). |
7676
| Backup | Run on-demand backup | Supported <br><br> [See the examples](./backup-azure-afs-automation.md#trigger-an-on-demand-backup). | Supported <br><br> [See the examples](./backup-afs-cli.md#trigger-an-on-demand-backup-for-file-share). | Supported <br><br> [See the examples](./backup-azure-file-share-rest-api.md#trigger-an-on-demand-backup-for-file-share). | N/A | N/A | N/A | N/A |
7777
| Restore | Restore to original or alternate location | Supported <br><br> [See the examples](./restore-afs-powershell.md). | Supported <br><br> [See the examples](./restore-afs-cli.md). | Supported <br><br> [See the examples](./restore-azure-file-share-rest-api.md). | N/A | N/A |N/A | N/A |
7878
| Manage | Monitor jobs | Supported <br><br> [See the examples](./manage-afs-powershell.md#track-backup-and-restore-jobs). | Supported <br><br> [See the examples](./manage-afs-backup-cli.md#monitor-jobs). | Supported <br><br> [See the examples](./manage-azure-file-share-rest-api.md#monitor-jobs). | N/A | N/A |N/A | N/A |

articles/backup/quick-backup-azure-files-vault-tier-arm.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ author: jyothisuri
1111
ms.author: jsuri
1212
---
1313

14-
# Quickstart: Configure vaulted backup for Azure File share using Azure Resource Manager
14+
# Quickstart: Configure vaulted backup for Azure Files using Azure Resource Manager
1515

16-
This quickstart describes how to configure vaulted backup for Azure File share using Azure Resource Manager (ARM) template.
16+
This quickstart describes how to configure vaulted backup for Azure Files using Azure Resource Manager (ARM) template.
1717

18-
Azure Backup supports configuring snapshot and vaulted backups for Azure File shares in your storage accounts. Vaulted backup offers an offsite solution, storing data in a general v2 storage account to protect against ransomware and malicious admin actions.
18+
Azure Backup supports configuring [snapshot](azure-file-share-backup-overview.md?tabs=snapshot) and [vaulted](azure-file-share-backup-overview.md?tabs=vault-standard) backups for Azure Files in your storage accounts. Vaulted backup offers an offsite solution, storing data in a general v2 storage account to protect against ransomware and malicious admin actions.
1919

2020
An Azure Resource Manager template is a JavaScript Object Notation (JSON) that defines your project's infrastructure and configuration using declarative syntax. It allows you to specify your intended deployment without writing programming commands.
2121

2222
## Prerequisites
2323

24-
Before you configure vaulted backup for Azure Files, ensure that you have a storage account with an existing file share. To create a new storage account and file share, see [create an Azure storage account with file share template](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.storage/storage-file-share).
24+
Before you configure vaulted backup for Azure Files, ensure that you have a storage account with an existing File Share. To create a new storage account and File Share, see [create an Azure storage account with File Share template](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.storage/storage-file-share).
2525

2626
## Review the template
2727

28-
The [Azure Quickstart Template](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.recoveryservices/recovery-services-backup-file-share) configures protection for an existing File share in a Storage Account. It creates or uses a Recovery Services Vault and Backup Policy based on parameter values.
28+
The [Azure Quickstart Template](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.recoveryservices/recovery-services-backup-file-share) configures protection for an existing File Share in a Storage Account. It creates or uses a Recovery Services Vault and Backup Policy based on parameter values.
2929

3030
```json
3131
{

articles/backup/quick-backup-azure-files-vault-tier-bicep.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ author: jyothisuri
1111
ms.author: jsuri
1212
---
1313

14-
# Quickstart: Configure vaulted backup for Azure File share using Azure Bicep
14+
# Quickstart: Configure vaulted backup for Azure Files using Azure Bicep
1515

16-
This quickstart describes how to configure vaulted backup for Azure File share using Azure Bicep template.
16+
This quickstart describes how to configure vaulted backup for Azure Files using Azure Bicep template.
1717

18-
[Azure Backup](backup-overview.md) supports configuring [snapshot](azure-file-share-backup-overview.md?tabs=snapshot) and [vaulted](azure-file-share-backup-overview.md?tabs=vault-standard) backups for Azure File shares in your storage accounts. Vaulted backup offers an offsite solution, storing data in a general v2 storage account to protect against ransomware and malicious admin actions.
18+
[Azure Backup](backup-overview.md) supports configuring [snapshot](azure-file-share-backup-overview.md?tabs=snapshot) and [vaulted](azure-file-share-backup-overview.md?tabs=vault-standard) backups for Azure Files in your storage accounts. Vaulted backup offers an offsite solution, storing data in a general v2 storage account to protect against ransomware and malicious admin actions.
1919

2020
Bicep is a language for declaratively deploying Azure resources, offering a simpler syntax and better development experience compared to JSON. It abstracts ARM template JSON, providing all its capabilities. During deployment, the Bicep CLI converts a Bicep file into Azure Resource Manager (ARM) template JSON. A Bicep file specifies Azure resources and properties without needing programming commands. Resource types, API versions, and properties valid in ARM templates are also valid in Bicep files.
2121

@@ -29,7 +29,7 @@ Before you configure vaulted backup for Azure Files, ensure that you set up your
2929

3030
## Review the template
3131

32-
The [Azure Quickstart Template](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.recoveryservices/recovery-services-backup-file-share) configures protection for an existing File share in a Storage Account. It creates or uses a Recovery Services Vault and Backup Policy based on parameter values.
32+
The [Azure Quickstart Template](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.recoveryservices/recovery-services-backup-file-share) configures protection for an existing File Share in a Storage Account. It creates or uses a Recovery Services Vault and Backup Policy based on parameter values.
3333

3434
```json
3535
@description('Name of the existing Resource Group in which the existing Storage Account is present.')

articles/backup/quick-backup-azure-files-vault-tier-portal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: jsuri
1313

1414
# Quickstart: Configure vaulted backup for Azure Files using Azure portal
1515

16-
This quickstart describes how to configure vaulted backup for Azure Files using the Azure portal. You can also configure backup with Azure CLI or Azure PowerShell.
16+
This quickstart describes how to configure vaulted backup for Azure Files using the Azure portal. You can also configure backup with [Azure CLI](quick-backup-azure-files-vault-tier-cli.md) or [Azure PowerShell](quick-backup-azure-files-vault-tier-powershell.md).
1717

1818
[Azure Backup](backup-overview.md) supports configuring [snapshot](azure-file-share-backup-overview.md?tabs=snapshot) and [vaulted](azure-file-share-backup-overview.md?tabs=vault-standard) backups for Azure Files in your storage accounts. Vaulted backups offer an offsite solution, storing data in a general v2 storage account to protect against ransomware and malicious admin actions. You can:
1919

articles/backup/quick-backup-azure-files-vault-tier-powershell.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: jsuri
1313

1414
# Quickstart: Configure vaulted backup for Azure Files using Azure PowerShell
1515

16-
This quickstart describes how to configure vaulted backup for Azure Files using Azure PowerShell. You can also configure backup with Azure CLI or in the Azure portal.
16+
This quickstart describes how to configure vaulted backup for Azure Files using Azure PowerShell. You can also configure backup with [Azure CLI](quick-backup-azure-files-vault-tier-cli.md) or in the [Azure portal](quick-backup-azure-files-vault-tier-portal.md).
1717

1818
[Azure Backup](backup-overview.md) supports configuring [snapshot](azure-file-share-backup-overview.md?tabs=snapshot) and [vaulted](azure-file-share-backup-overview.md?tabs=vault-standard) backups for Azure Files in your storage accounts. Vaulted backups offer an offsite solution, storing data in a general v2 storage account to protect against ransomware and malicious admin actions. You can:
1919

@@ -28,16 +28,16 @@ Before you configure vaulted backup for Azure Files, ensure that the following p
2828
- Ensure that File Share is in a supported storage account type. See the [Azure Files backup support matrix](azure-file-share-support-matrix.md).
2929

3030
- Allow **Azure services on the trusted services list** in the **Firewall settings** to access the storage account, if access is restricted. Learn [how to grant an exception](/azure/storage/common/storage-network-security?tabs=azure-portal#manage-exceptions).
31-
- Use an existing Recovery Services vault. If you don't have the vault, [create one](backup-azure-afs-automation.md#create-a-recovery-services-vault).
32-
- [Configure a Backup policy](backup-azure-afs-automation.md#configure-a-backup-policy) for the backup operation.
31+
- Use an existing Recovery Services vault. If you don't have the vault, [create one](backup-azure-afs-automation.md?tabs=vault-standard#create-a-recovery-services-vault).
32+
- [Configure a Backup policy](backup-azure-afs-automation.md?tabs=vault-standard#configure-a-backup-policy) for the backup operation.
3333

3434
## Configure backup
3535

3636
To configure vaulted backup for Azure Files, use the [`Enable-AzRecoveryServicesBackupProtection`](/powershell/module/az.recoveryservices/enable-azrecoveryservicesbackupprotection) cmdlet.
3737

3838
>[!Note]
3939
>After the policy is associated with the vault, backups are triggered in accordance with the policy schedule.
40-
The following example cmdlet configures protection for the Azure file share `testAzureFS` in storage account `testStorageAcct`, with the policy `dailyafs`:
40+
The following example cmdlet configures protection for the Azure Files `testAzureFS` in storage account `testStorageAcct`, with the policy `dailyafs`:
4141

4242
```azurepowershell-interactive
4343
Enable-AzRecoveryServicesBackupProtection -StorageAccountName "testStorageAcct" -Name "testAzureFS" -Policy $afsPol
@@ -53,8 +53,8 @@ testAzureFS ConfigureBackup Completed 11/12/2018 2:15:26 P
5353

5454
## Next step
5555

56-
- [Restore Azure file shares using Azure PowerShell](restore-afs-powershell.md)
57-
- [Manage Azure file share backups using Azure PowerShell](manage-afs-powershell.md)
56+
- [Restore Azure Files using Azure PowerShell](restore-afs-powershell.md)
57+
- [Manage Azure Files backups using Azure PowerShell](manage-afs-powershell.md?tabs=vault-standard)
5858

5959

6060

0 commit comments

Comments
 (0)