Microsoft.RecoveryServices vaults/backupPolicies 2021-02-01

Bicep resource definition

The vaults/backupPolicies resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/backupPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.RecoveryServices/vaults/backupPolicies@2021-02-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  eTag: 'string'
  properties: {
    protectedItemsCount: int
    backupManagementType: 'string'
    // For remaining properties, see ProtectionPolicy objects
  }
}

ProtectionPolicy objects

Set the backupManagementType property to specify the type of object.

For AzureIaasVM, use:

  backupManagementType: 'AzureIaasVM'
  instantRPDetails: {
    azureBackupRGNamePrefix: 'string'
    azureBackupRGNameSuffix: 'string'
  }
  instantRpRetentionRangeInDays: int
  retentionPolicy: {
    retentionPolicyType: 'string'
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy: {
    schedulePolicyType: 'string'
    // For remaining properties, see SchedulePolicy objects
  }
  timeZone: 'string'

For AzureSql, use:

  backupManagementType: 'AzureSql'
  retentionPolicy: {
    retentionPolicyType: 'string'
    // For remaining properties, see RetentionPolicy objects
  }

For AzureStorage, use:

  backupManagementType: 'AzureStorage'
  retentionPolicy: {
    retentionPolicyType: 'string'
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy: {
    schedulePolicyType: 'string'
    // For remaining properties, see SchedulePolicy objects
  }
  timeZone: 'string'
  workLoadType: 'string'

For AzureWorkload, use:

  backupManagementType: 'AzureWorkload'
  makePolicyConsistent: bool
  settings: {
    isCompression: bool
    issqlcompression: bool
    timeZone: 'string'
  }
  subProtectionPolicy: [
    {
      policyType: 'string'
      retentionPolicy: {
        retentionPolicyType: 'string'
        // For remaining properties, see RetentionPolicy objects
      }
      schedulePolicy: {
        schedulePolicyType: 'string'
        // For remaining properties, see SchedulePolicy objects
      }
    }
  ]
  workLoadType: 'string'

For GenericProtectionPolicy, use:

  backupManagementType: 'GenericProtectionPolicy'
  fabricName: 'string'
  subProtectionPolicy: [
    {
      policyType: 'string'
      retentionPolicy: {
        retentionPolicyType: 'string'
        // For remaining properties, see RetentionPolicy objects
      }
      schedulePolicy: {
        schedulePolicyType: 'string'
        // For remaining properties, see SchedulePolicy objects
      }
    }
  ]
  timeZone: 'string'

For MAB, use:

  backupManagementType: 'MAB'
  retentionPolicy: {
    retentionPolicyType: 'string'
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy: {
    schedulePolicyType: 'string'
    // For remaining properties, see SchedulePolicy objects
  }

RetentionPolicy objects

Set the retentionPolicyType property to specify the type of object.

For LongTermRetentionPolicy, use:

  retentionPolicyType: 'LongTermRetentionPolicy'
  dailySchedule: {
    retentionDuration: {
      count: int
      durationType: 'string'
    }
    retentionTimes: [
      'string'
    ]
  }
  monthlySchedule: {
    retentionDuration: {
      count: int
      durationType: 'string'
    }
    retentionScheduleDaily: {
      daysOfTheMonth: [
        {
          date: int
          isLast: bool
        }
      ]
    }
    retentionScheduleFormatType: 'string'
    retentionScheduleWeekly: {
      daysOfTheWeek: [
        'string'
      ]
      weeksOfTheMonth: [
        'string'
      ]
    }
    retentionTimes: [
      'string'
    ]
  }
  weeklySchedule: {
    daysOfTheWeek: [
      'string'
    ]
    retentionDuration: {
      count: int
      durationType: 'string'
    }
    retentionTimes: [
      'string'
    ]
  }
  yearlySchedule: {
    monthsOfYear: [
      'string'
    ]
    retentionDuration: {
      count: int
      durationType: 'string'
    }
    retentionScheduleDaily: {
      daysOfTheMonth: [
        {
          date: int
          isLast: bool
        }
      ]
    }
    retentionScheduleFormatType: 'string'
    retentionScheduleWeekly: {
      daysOfTheWeek: [
        'string'
      ]
      weeksOfTheMonth: [
        'string'
      ]
    }
    retentionTimes: [
      'string'
    ]
  }

For SimpleRetentionPolicy, use:

  retentionPolicyType: 'SimpleRetentionPolicy'
  retentionDuration: {
    count: int
    durationType: 'string'
  }

SchedulePolicy objects

Set the schedulePolicyType property to specify the type of object.

For LogSchedulePolicy, use:

  schedulePolicyType: 'LogSchedulePolicy'
  scheduleFrequencyInMins: int

For LongTermSchedulePolicy, use:

  schedulePolicyType: 'LongTermSchedulePolicy'

For SimpleSchedulePolicy, use:

  schedulePolicyType: 'SimpleSchedulePolicy'
  scheduleRunDays: [
    'string'
  ]
  scheduleRunFrequency: 'string'
  scheduleRunTimes: [
    'string'
  ]
  scheduleWeeklyFrequency: int

Property values

vaults/backupPolicies

ProtectionPolicy

AzureIaaSVMProtectionPolicy

InstantRPAdditionalDetails

RetentionPolicy

LongTermRetentionPolicy

DailyRetentionSchedule

RetentionDuration

MonthlyRetentionSchedule

DailyRetentionFormat

Day

WeeklyRetentionFormat

WeeklyRetentionSchedule

YearlyRetentionSchedule

SimpleRetentionPolicy

SchedulePolicy

LogSchedulePolicy

LongTermSchedulePolicy

SimpleSchedulePolicy

AzureSqlProtectionPolicy

AzureFileShareProtectionPolicy

AzureVmWorkloadProtectionPolicy

Settings

SubProtectionPolicy

GenericProtectionPolicy

MabProtectionPolicy

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Backup existing File Share using Recovery Services (Daily)	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.
Backup existing File Share using Recovery Services (hourly)	This template configures protection with hourly frequency 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.
Backup Resource Manager VMs using Recovery Services vault	This template will use existing recovery services vault and existing backup policy, and configures backup of multiple Resource Manager VMs that belong to same resource group
Create Recovery Services Vault with backup policies	This template creates a Recovery Services Vault with backup policies and configure optional features such system identity, backup storage type, cross region restore and diagnostics logs and a delete lock.
Create Daily Backup Policy for RS Vault to protect IaaSVMs	This template creates Recovery service vault and a Daily Backup Policy that can be used to protect classic and ARM based IaaS VMs.
Azure Backup for Workload in Azure Virtual Machines	This template creates a Recovery Services Vault and a Workload specific Backup Policy. Registers VM with Backup service and Configures Protection
Create Weekly Backup Policy for RS Vault to protect IaaSVMs	This template creates Recovery service vault and a Daily Backup Policy that can be used to protect classic and ARM based IaaS VMs.

ARM template resource definition

The vaults/backupPolicies resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/backupPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
  "apiVersion": "2021-02-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "eTag": "string",
  "properties": {
    "protectedItemsCount": "int",
    "backupManagementType": "string"
    // For remaining properties, see ProtectionPolicy objects
  }
}

ProtectionPolicy objects

Set the backupManagementType property to specify the type of object.

For AzureIaasVM, use:

  "backupManagementType": "AzureIaasVM",
  "instantRPDetails": {
    "azureBackupRGNamePrefix": "string",
    "azureBackupRGNameSuffix": "string"
  },
  "instantRpRetentionRangeInDays": "int",
  "retentionPolicy": {
    "retentionPolicyType": "string"
    // For remaining properties, see RetentionPolicy objects
  },
  "schedulePolicy": {
    "schedulePolicyType": "string"
    // For remaining properties, see SchedulePolicy objects
  },
  "timeZone": "string"

For AzureSql, use:

  "backupManagementType": "AzureSql",
  "retentionPolicy": {
    "retentionPolicyType": "string"
    // For remaining properties, see RetentionPolicy objects
  }

For AzureStorage, use:

  "backupManagementType": "AzureStorage",
  "retentionPolicy": {
    "retentionPolicyType": "string"
    // For remaining properties, see RetentionPolicy objects
  },
  "schedulePolicy": {
    "schedulePolicyType": "string"
    // For remaining properties, see SchedulePolicy objects
  },
  "timeZone": "string",
  "workLoadType": "string"

For AzureWorkload, use:

  "backupManagementType": "AzureWorkload",
  "makePolicyConsistent": "bool",
  "settings": {
    "isCompression": "bool",
    "issqlcompression": "bool",
    "timeZone": "string"
  },
  "subProtectionPolicy": [
    {
      "policyType": "string",
      "retentionPolicy": {
        "retentionPolicyType": "string"
        // For remaining properties, see RetentionPolicy objects
      },
      "schedulePolicy": {
        "schedulePolicyType": "string"
        // For remaining properties, see SchedulePolicy objects
      }
    }
  ],
  "workLoadType": "string"

For GenericProtectionPolicy, use:

  "backupManagementType": "GenericProtectionPolicy",
  "fabricName": "string",
  "subProtectionPolicy": [
    {
      "policyType": "string",
      "retentionPolicy": {
        "retentionPolicyType": "string"
        // For remaining properties, see RetentionPolicy objects
      },
      "schedulePolicy": {
        "schedulePolicyType": "string"
        // For remaining properties, see SchedulePolicy objects
      }
    }
  ],
  "timeZone": "string"

For MAB, use:

  "backupManagementType": "MAB",
  "retentionPolicy": {
    "retentionPolicyType": "string"
    // For remaining properties, see RetentionPolicy objects
  },
  "schedulePolicy": {
    "schedulePolicyType": "string"
    // For remaining properties, see SchedulePolicy objects
  }

RetentionPolicy objects

Set the retentionPolicyType property to specify the type of object.

For LongTermRetentionPolicy, use:

  "retentionPolicyType": "LongTermRetentionPolicy",
  "dailySchedule": {
    "retentionDuration": {
      "count": "int",
      "durationType": "string"
    },
    "retentionTimes": [ "string" ]
  },
  "monthlySchedule": {
    "retentionDuration": {
      "count": "int",
      "durationType": "string"
    },
    "retentionScheduleDaily": {
      "daysOfTheMonth": [
        {
          "date": "int",
          "isLast": "bool"
        }
      ]
    },
    "retentionScheduleFormatType": "string",
    "retentionScheduleWeekly": {
      "daysOfTheWeek": [ "string" ],
      "weeksOfTheMonth": [ "string" ]
    },
    "retentionTimes": [ "string" ]
  },
  "weeklySchedule": {
    "daysOfTheWeek": [ "string" ],
    "retentionDuration": {
      "count": "int",
      "durationType": "string"
    },
    "retentionTimes": [ "string" ]
  },
  "yearlySchedule": {
    "monthsOfYear": [ "string" ],
    "retentionDuration": {
      "count": "int",
      "durationType": "string"
    },
    "retentionScheduleDaily": {
      "daysOfTheMonth": [
        {
          "date": "int",
          "isLast": "bool"
        }
      ]
    },
    "retentionScheduleFormatType": "string",
    "retentionScheduleWeekly": {
      "daysOfTheWeek": [ "string" ],
      "weeksOfTheMonth": [ "string" ]
    },
    "retentionTimes": [ "string" ]
  }

For SimpleRetentionPolicy, use:

  "retentionPolicyType": "SimpleRetentionPolicy",
  "retentionDuration": {
    "count": "int",
    "durationType": "string"
  }

SchedulePolicy objects

Set the schedulePolicyType property to specify the type of object.

For LogSchedulePolicy, use:

  "schedulePolicyType": "LogSchedulePolicy",
  "scheduleFrequencyInMins": "int"

For LongTermSchedulePolicy, use:

  "schedulePolicyType": "LongTermSchedulePolicy"

For SimpleSchedulePolicy, use:

  "schedulePolicyType": "SimpleSchedulePolicy",
  "scheduleRunDays": [ "string" ],
  "scheduleRunFrequency": "string",
  "scheduleRunTimes": [ "string" ],
  "scheduleWeeklyFrequency": "int"

Property values

vaults/backupPolicies

ProtectionPolicy

AzureIaaSVMProtectionPolicy

InstantRPAdditionalDetails

RetentionPolicy

LongTermRetentionPolicy

DailyRetentionSchedule

RetentionDuration

MonthlyRetentionSchedule

DailyRetentionFormat

Day

WeeklyRetentionFormat

WeeklyRetentionSchedule

YearlyRetentionSchedule

SimpleRetentionPolicy

SchedulePolicy

LogSchedulePolicy

LongTermSchedulePolicy

SimpleSchedulePolicy

AzureSqlProtectionPolicy

AzureFileShareProtectionPolicy

AzureVmWorkloadProtectionPolicy

Settings

SubProtectionPolicy

GenericProtectionPolicy

MabProtectionPolicy

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Backup existing File Share using Recovery Services (Daily)	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.
Backup existing File Share using Recovery Services (hourly)	This template configures protection with hourly frequency 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.
Backup Resource Manager VMs using Recovery Services vault	This template will use existing recovery services vault and existing backup policy, and configures backup of multiple Resource Manager VMs that belong to same resource group
Create Recovery Services Vault with backup policies	This template creates a Recovery Services Vault with backup policies and configure optional features such system identity, backup storage type, cross region restore and diagnostics logs and a delete lock.
Create Daily Backup Policy for RS Vault to protect IaaSVMs	This template creates Recovery service vault and a Daily Backup Policy that can be used to protect classic and ARM based IaaS VMs.
Azure Backup for Workload in Azure Virtual Machines	This template creates a Recovery Services Vault and a Workload specific Backup Policy. Registers VM with Backup service and Configures Protection
Create Weekly Backup Policy for RS Vault to protect IaaSVMs	This template creates Recovery service vault and a Daily Backup Policy that can be used to protect classic and ARM based IaaS VMs.

Terraform (AzAPI provider) resource definition

The vaults/backupPolicies resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/backupPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/backupPolicies@2021-02-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      protectedItemsCount = int
      backupManagementType = "string"
      // For remaining properties, see ProtectionPolicy objects
    }
    eTag = "string"
  })
}

ProtectionPolicy objects

Set the backupManagementType property to specify the type of object.

For AzureIaasVM, use:

  backupManagementType = "AzureIaasVM"
  instantRPDetails = {
    azureBackupRGNamePrefix = "string"
    azureBackupRGNameSuffix = "string"
  }
  instantRpRetentionRangeInDays = int
  retentionPolicy = {
    retentionPolicyType = "string"
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy = {
    schedulePolicyType = "string"
    // For remaining properties, see SchedulePolicy objects
  }
  timeZone = "string"

For AzureSql, use:

  backupManagementType = "AzureSql"
  retentionPolicy = {
    retentionPolicyType = "string"
    // For remaining properties, see RetentionPolicy objects
  }

For AzureStorage, use:

  backupManagementType = "AzureStorage"
  retentionPolicy = {
    retentionPolicyType = "string"
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy = {
    schedulePolicyType = "string"
    // For remaining properties, see SchedulePolicy objects
  }
  timeZone = "string"
  workLoadType = "string"

For AzureWorkload, use:

  backupManagementType = "AzureWorkload"
  makePolicyConsistent = bool
  settings = {
    isCompression = bool
    issqlcompression = bool
    timeZone = "string"
  }
  subProtectionPolicy = [
    {
      policyType = "string"
      retentionPolicy = {
        retentionPolicyType = "string"
        // For remaining properties, see RetentionPolicy objects
      }
      schedulePolicy = {
        schedulePolicyType = "string"
        // For remaining properties, see SchedulePolicy objects
      }
    }
  ]
  workLoadType = "string"

For GenericProtectionPolicy, use:

  backupManagementType = "GenericProtectionPolicy"
  fabricName = "string"
  subProtectionPolicy = [
    {
      policyType = "string"
      retentionPolicy = {
        retentionPolicyType = "string"
        // For remaining properties, see RetentionPolicy objects
      }
      schedulePolicy = {
        schedulePolicyType = "string"
        // For remaining properties, see SchedulePolicy objects
      }
    }
  ]
  timeZone = "string"

For MAB, use:

  backupManagementType = "MAB"
  retentionPolicy = {
    retentionPolicyType = "string"
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy = {
    schedulePolicyType = "string"
    // For remaining properties, see SchedulePolicy objects
  }

RetentionPolicy objects

Set the retentionPolicyType property to specify the type of object.

For LongTermRetentionPolicy, use:

  retentionPolicyType = "LongTermRetentionPolicy"
  dailySchedule = {
    retentionDuration = {
      count = int
      durationType = "string"
    }
    retentionTimes = [
      "string"
    ]
  }
  monthlySchedule = {
    retentionDuration = {
      count = int
      durationType = "string"
    }
    retentionScheduleDaily = {
      daysOfTheMonth = [
        {
          date = int
          isLast = bool
        }
      ]
    }
    retentionScheduleFormatType = "string"
    retentionScheduleWeekly = {
      daysOfTheWeek = [
        "string"
      ]
      weeksOfTheMonth = [
        "string"
      ]
    }
    retentionTimes = [
      "string"
    ]
  }
  weeklySchedule = {
    daysOfTheWeek = [
      "string"
    ]
    retentionDuration = {
      count = int
      durationType = "string"
    }
    retentionTimes = [
      "string"
    ]
  }
  yearlySchedule = {
    monthsOfYear = [
      "string"
    ]
    retentionDuration = {
      count = int
      durationType = "string"
    }
    retentionScheduleDaily = {
      daysOfTheMonth = [
        {
          date = int
          isLast = bool
        }
      ]
    }
    retentionScheduleFormatType = "string"
    retentionScheduleWeekly = {
      daysOfTheWeek = [
        "string"
      ]
      weeksOfTheMonth = [
        "string"
      ]
    }
    retentionTimes = [
      "string"
    ]
  }

For SimpleRetentionPolicy, use:

  retentionPolicyType = "SimpleRetentionPolicy"
  retentionDuration = {
    count = int
    durationType = "string"
  }

SchedulePolicy objects

Set the schedulePolicyType property to specify the type of object.

For LogSchedulePolicy, use:

  schedulePolicyType = "LogSchedulePolicy"
  scheduleFrequencyInMins = int

For LongTermSchedulePolicy, use:

  schedulePolicyType = "LongTermSchedulePolicy"

For SimpleSchedulePolicy, use:

  schedulePolicyType = "SimpleSchedulePolicy"
  scheduleRunDays = [
    "string"
  ]
  scheduleRunFrequency = "string"
  scheduleRunTimes = [
    "string"
  ]
  scheduleWeeklyFrequency = int

Property values

vaults/backupPolicies

ProtectionPolicy

AzureIaaSVMProtectionPolicy

InstantRPAdditionalDetails

RetentionPolicy

LongTermRetentionPolicy

DailyRetentionSchedule

RetentionDuration

MonthlyRetentionSchedule

DailyRetentionFormat

Day

WeeklyRetentionFormat

WeeklyRetentionSchedule

YearlyRetentionSchedule

SimpleRetentionPolicy

SchedulePolicy

LogSchedulePolicy

LongTermSchedulePolicy

SimpleSchedulePolicy

AzureSqlProtectionPolicy

AzureFileShareProtectionPolicy

AzureVmWorkloadProtectionPolicy

Settings

SubProtectionPolicy

GenericProtectionPolicy

MabProtectionPolicy