Backup existing File Share using Recovery Services

Last updated: 2020-11-07

This template configures protection for an existing File Share present in an existing Storage Account. It creates a new or uses an existing Recovery Services Vault and Backup Policy based on the set parameter values.

This Azure Resource Manager (ARM) template was created by a member of the community and not by Microsoft. Each ARM template is licensed to you under a licence agreement by its owner, not Microsoft. Microsoft is not responsible for ARM templates provided and licensed by community members and does not screen for security, compatibility or performance. Community ARM templates are not supported under any Microsoft support programme or service, and are made available AS IS without warranty of any kind.

Parameters

Parameter Name Description
existingResourceGroupName Name of the existing Resource Group in which the existing Storage Account is present.
existingStorageAccountName Name of the existing Storage Account in which the existing File Share to be protected is present.
existingFileShareName Name of the existing File Share to be protected.
location Location of the existing Storage Account containing the existing File Share to be protected. New Recovery Services Vault will be created in this location. (Ignore if using existing Recovery Services Vault).
isNewVault Set to true if a new Recovery Services Vault is to be created; set to false otherwise.
isNewPolicy Set to true if a new Backup Policy is to be created for the Recovery Services Vault; set to false otherwise.
registerStorageAccount Set to true if the existing Storage Account has to be registered to the Recovery Services Vault; set to false otherwise.
vaultName Name of the Recovery Services Vault. (Should have the same location as the Storage Account containing the File Share to be protected in case of an existing Recovery Services Vault).
policyName Name of the Backup Policy.
scheduleRunTime Time of day when backup should be triggered in 24 hour HH:MM format, where MM must be 00 or 30. (Ignore if using existing Backup Policy).
timeZone Any valid timezone, for example: UTC, Pacific Standard Time. Refer: https://msdn.microsoft.com/en-us/library/gg154758.aspx (Ignore if using existing Backup Policy).
dailyRetentionDurationCount Number of days for which the daily backup is to be retained. (Ignore if using existing Backup Policy).
daysOfTheWeek Array of days on which backup is to be performed for Weekly Retention. (Ignore if using existing Backup Policy).
weeklyRetentionDurationCount Number of weeks for which the weekly backup is to be retained. (Ignore if using existing Backup Policy).
monthlyRetentionDurationCount Number of months for which the monthly backup is to be retained. Backup will be performed on the 1st day of every month. (Ignore if using existing Backup Policy).
monthsOfYear Array of months on which backup is to be performed for Yearly Retention. Backup will be performed on the 1st day of each month of year provided. (Ignore if using existing Backup Policy).
yearlyRetentionDurationCount Number of years for which the yearly backup is to be retained. (Ignore if using existing Backup Policy).

Use the template

PowerShell

New-AzResourceGroup -Name <resource-group-name> -Location <resource-group-location> #use this command when you need to create a new resource group for your deployment
New-AzResourceGroupDeployment -ResourceGroupName <resource-group-name> -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-recovery-services-backup-file-share/azuredeploy.json
Installing and configuring Azure PowerShell

Command line

az group create --name <resource-group-name> --location <resource-group-location> #use this command when you need to create a new resource group for your deployment
az group deployment create --resource-group <my-resource-group> --template-uri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-recovery-services-backup-file-share/azuredeploy.json
Installing and configuring the Azure cross-platform command-line interface