Microsoft.RecoveryServices vaults/backupPolicies 2023-02-01

Article
12/09/2024

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@2023-02-01' = {
  parent: resourceSymbolicName
  eTag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    protectedItemsCount: int
    resourceGuardOperationRequests: [
      'string'
    ]
    backupManagementType: 'string'
    // For remaining properties, see ProtectionPolicy objects
  }
  tags: {
    {customized property}: 'string'
  }
}

RetentionPolicy objects

Set the retentionPolicyType property to specify the type of object.

For LongTermRetentionPolicy, use:

{
  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'
    ]
  }
  retentionPolicyType: 'LongTermRetentionPolicy'
  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:

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

ProtectionPolicy objects

Set the backupManagementType property to specify the type of object.

For AzureIaasVM, use:

{
  backupManagementType: 'AzureIaasVM'
  instantRPDetails: {
    azureBackupRGNamePrefix: 'string'
    azureBackupRGNameSuffix: 'string'
  }
  instantRpRetentionRangeInDays: int
  policyType: 'string'
  retentionPolicy: {
    retentionPolicyType: 'string'
    // For remaining properties, see RetentionPolicy objects
  }
  schedulePolicy: {
    schedulePolicyType: 'string'
    // For remaining properties, see SchedulePolicy objects
  }
  tieringPolicy: {
    {customized property}: {
      duration: int
      durationType: 'string'
      tieringMode: 'string'
    }
  }
  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
      }
      tieringPolicy: {
        {customized property}: {
          duration: int
          durationType: 'string'
          tieringMode: 'string'
        }
      }
    }
  ]
  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
      }
      tieringPolicy: {
        {customized property}: {
          duration: int
          durationType: 'string'
          tieringMode: 'string'
        }
      }
    }
  ]
  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
  }
}

SchedulePolicy objects

Set the schedulePolicyType property to specify the type of object.

For LogSchedulePolicy, use:

{
  scheduleFrequencyInMins: int
  schedulePolicyType: 'LogSchedulePolicy'
}

For LongTermSchedulePolicy, use:

{
  schedulePolicyType: 'LongTermSchedulePolicy'
}

For SimpleSchedulePolicy, use:

{
  hourlySchedule: {
    interval: int
    scheduleWindowDuration: int
    scheduleWindowStartTime: 'string'
  }
  schedulePolicyType: 'SimpleSchedulePolicy'
  scheduleRunDays: [
    'string'
  ]
  scheduleRunFrequency: 'string'
  scheduleRunTimes: [
    'string'
  ]
  scheduleWeeklyFrequency: int
}

For SimpleSchedulePolicyV2, use:

{
  dailySchedule: {
    scheduleRunTimes: [
      'string'
    ]
  }
  hourlySchedule: {
    interval: int
    scheduleWindowDuration: int
    scheduleWindowStartTime: 'string'
  }
  schedulePolicyType: 'SimpleSchedulePolicyV2'
  scheduleRunFrequency: 'string'
  weeklySchedule: {
    scheduleRunDays: [
      'string'
    ]
    scheduleRunTimes: [
      'string'
    ]
  }
}

Property values

AzureFileShareProtectionPolicy

Name	Description	Value
backupManagementType	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.	'AzureStorage' (required)
retentionPolicy	Retention policy with the details on backup copy retention ranges.	RetentionPolicy
schedulePolicy	Backup schedule specified as part of backup policy.	SchedulePolicy
timeZone	TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".	string
workLoadType	Type of workload for the backup management	'AzureFileShare' 'AzureSqlDb' 'Client' 'Exchange' 'FileFolder' 'GenericDataSource' 'Invalid' 'SAPAseDatabase' 'SAPHanaDatabase' 'SAPHanaDBInstance' 'Sharepoint' 'SQLDataBase' 'SQLDB' 'SystemState' 'VM' 'VMwareVM'

AzureIaaSVMProtectionPolicy

Name	Description	Value
backupManagementType	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.	'AzureIaasVM' (required)
instantRPDetails		InstantRPAdditionalDetails
instantRpRetentionRangeInDays	Instant RP retention policy range in days	int
policyType		'Invalid' 'V1' 'V2'
retentionPolicy	Retention policy with the details on backup copy retention ranges.	RetentionPolicy
schedulePolicy	Backup schedule specified as part of backup policy.	SchedulePolicy
tieringPolicy	Tiering policy to automatically move RPs to another tier Key is Target Tier, defined in RecoveryPointTierType enum. Tiering policy specifies the criteria to move RP to the target tier.	AzureIaaSVMProtectionPolicyTieringPolicy
timeZone	TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".	string

AzureIaaSVMProtectionPolicyTieringPolicy

Name	Description	Value

AzureSqlProtectionPolicy

Name	Description	Value
backupManagementType	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.	'AzureSql' (required)
retentionPolicy	Retention policy details.	RetentionPolicy

AzureVmWorkloadProtectionPolicy

Name	Description	Value
backupManagementType	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.	'AzureWorkload' (required)
makePolicyConsistent	Fix the policy inconsistency	bool
settings	Common settings for the backup management	Settings
subProtectionPolicy	List of sub-protection policies which includes schedule and retention	SubProtectionPolicy[]
workLoadType	Type of workload for the backup management	'AzureFileShare' 'AzureSqlDb' 'Client' 'Exchange' 'FileFolder' 'GenericDataSource' 'Invalid' 'SAPAseDatabase' 'SAPHanaDatabase' 'SAPHanaDBInstance' 'Sharepoint' 'SQLDataBase' 'SQLDB' 'SystemState' 'VM' 'VMwareVM'

DailyRetentionFormat

Name	Description	Value
daysOfTheMonth	List of days of the month.	Day[]

DailyRetentionSchedule

Name	Description	Value
retentionDuration	Retention duration of retention Policy.	RetentionDuration
retentionTimes	Retention times of retention policy.	string[]

DailySchedule

Name	Description	Value
scheduleRunTimes	List of times of day this schedule has to be run.	string[]

Day

Name	Description	Value
date	Date of the month	int
isLast	Whether Date is last date of month	bool

GenericProtectionPolicy

Name	Description	Value
backupManagementType	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.	'GenericProtectionPolicy' (required)
fabricName	Name of this policy's fabric.	string
subProtectionPolicy	List of sub-protection policies which includes schedule and retention	SubProtectionPolicy[]
timeZone	TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".	string

HourlySchedule

Name	Description	Value
interval	Interval at which backup needs to be triggered. For hourly the value can be 4/6/8/12	int
scheduleWindowDuration	To specify duration of the backup window	int
scheduleWindowStartTime	To specify start time of the backup window	string

InstantRPAdditionalDetails

Name	Description	Value
azureBackupRGNamePrefix		string
azureBackupRGNameSuffix		string

LogSchedulePolicy

Name	Description	Value
scheduleFrequencyInMins	Frequency of the log schedule operation of this policy in minutes.	int
schedulePolicyType	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.	'LogSchedulePolicy' (required)

LongTermRetentionPolicy

Name	Description	Value
dailySchedule	Daily retention schedule of the protection policy.	DailyRetentionSchedule
monthlySchedule	Monthly retention schedule of the protection policy.	MonthlyRetentionSchedule
retentionPolicyType	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.	'LongTermRetentionPolicy' (required)
weeklySchedule	Weekly retention schedule of the protection policy.	WeeklyRetentionSchedule
yearlySchedule	Yearly retention schedule of the protection policy.	YearlyRetentionSchedule

LongTermSchedulePolicy

Name	Description	Value
schedulePolicyType	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.	'LongTermSchedulePolicy' (required)

MabProtectionPolicy

Name	Description	Value
backupManagementType	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.	'MAB' (required)
retentionPolicy	Retention policy details.	RetentionPolicy
schedulePolicy	Backup schedule of backup policy.	SchedulePolicy