Microsoft.DataProtection backupVaults/backupPolicies

Article
12/09/2024

Bicep resource definition

The backupVaults/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.DataProtection/backupVaults/backupPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataProtection/backupVaults/backupPolicies@2025-02-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    datasourceTypes: [
      'string'
    ]
    objectType: 'string'
    // For remaining properties, see BaseBackupPolicy objects
  }
}

DeleteOption objects

Set the objectType property to specify the type of object.

For AbsoluteDeleteOption, use:

{
  objectType: 'AbsoluteDeleteOption'
}

BackupParameters objects

Set the objectType property to specify the type of object.

For AzureBackupParams, use:

{
  backupType: 'string'
  objectType: 'AzureBackupParams'
}

CopyOption objects

Set the objectType property to specify the type of object.

For CopyOnExpiryOption, use:

{
  objectType: 'CopyOnExpiryOption'
}

For CustomCopyOption, use:

{
  duration: 'string'
  objectType: 'CustomCopyOption'
}

For ImmediateCopyOption, use:

{
  objectType: 'ImmediateCopyOption'
}

BasePolicyRule objects

Set the objectType property to specify the type of object.

For AzureBackupRule, use:

{
  backupParameters: {
    objectType: 'string'
    // For remaining properties, see BackupParameters objects
  }
  dataStore: {
    dataStoreType: 'string'
    objectType: 'string'
  }
  objectType: 'AzureBackupRule'
  trigger: {
    objectType: 'string'
    // For remaining properties, see TriggerContext objects
  }
}

For AzureRetentionRule, use:

{
  isDefault: bool
  lifecycles: [
    {
      deleteAfter: {
        duration: 'string'
        objectType: 'string'
        // For remaining properties, see DeleteOption objects
      }
      sourceDataStore: {
        dataStoreType: 'string'
        objectType: 'string'
      }
      targetDataStoreCopySettings: [
        {
          copyAfter: {
            objectType: 'string'
            // For remaining properties, see CopyOption objects
          }
          dataStore: {
            dataStoreType: 'string'
            objectType: 'string'
          }
        }
      ]
    }
  ]
  objectType: 'AzureRetentionRule'
}

TriggerContext objects

Set the objectType property to specify the type of object.

For AdhocBasedTriggerContext, use:

{
  objectType: 'AdhocBasedTriggerContext'
  taggingCriteria: {
    tagInfo: {
      tagName: 'string'
    }
  }
}

For ScheduleBasedTriggerContext, use:

{
  objectType: 'ScheduleBasedTriggerContext'
  schedule: {
    repeatingTimeIntervals: [
      'string'
    ]
    timeZone: 'string'
  }
  taggingCriteria: [
    {
      criteria: [
        {
          objectType: 'string'
          // For remaining properties, see BackupCriteria objects
        }
      ]
      isDefault: bool
      taggingPriority: int
      tagInfo: {
        tagName: 'string'
      }
    }
  ]
}

BaseBackupPolicy objects

Set the objectType property to specify the type of object.

For BackupPolicy, use:

{
  objectType: 'BackupPolicy'
  policyRules: [
    {
      name: 'string'
      objectType: 'string'
      // For remaining properties, see BasePolicyRule objects
    }
  ]
}

BackupCriteria objects

Set the objectType property to specify the type of object.

For ScheduleBasedBackupCriteria, use:

{
  absoluteCriteria: [
    'string'
  ]
  daysOfMonth: [
    {
      date: int
      isLast: bool
    }
  ]
  daysOfTheWeek: [
    'string'
  ]
  monthsOfYear: [
    'string'
  ]
  objectType: 'ScheduleBasedBackupCriteria'
  scheduleTimes: [
    'string'
  ]
  weeksOfTheMonth: [
    'string'
  ]
}

Property Values

AbsoluteDeleteOption

Name	Description	Value
objectType	Type of the specific object - used for deserializing	'AbsoluteDeleteOption' (required)

AdhocBasedTaggingCriteria

Name	Description	Value
tagInfo	Retention tag information	RetentionTag

AdhocBasedTriggerContext

Name	Description	Value
objectType	Type of the specific object - used for deserializing	'AdhocBasedTriggerContext' (required)
taggingCriteria	Tagging Criteria containing retention tag for adhoc backup.	AdhocBasedTaggingCriteria (required)

AzureBackupParams

Name	Description	Value
backupType	BackupType ; Full/Incremental etc	string (required)
objectType	Type of the specific object - used for deserializing	'AzureBackupParams' (required)

AzureBackupRule

Name	Description	Value
backupParameters	BackupParameters base	BackupParameters
dataStore	DataStoreInfo base	DataStoreInfoBase (required)
objectType		'AzureBackupRule' (required)
trigger	Trigger context	TriggerContext (required)

AzureRetentionRule

Name	Description	Value
isDefault		bool
lifecycles		SourceLifeCycle[] (required)
objectType		'AzureRetentionRule' (required)

BackupCriteria

Name	Description	Value
objectType	Set to 'ScheduleBasedBackupCriteria' for type ScheduleBasedBackupCriteria.	'ScheduleBasedBackupCriteria' (required)

BackupParameters

Name	Description	Value
objectType	Set to 'AzureBackupParams' for type AzureBackupParams.	'AzureBackupParams' (required)

BackupPolicy

Name	Description	Value
objectType		'BackupPolicy' (required)
policyRules	Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc	BasePolicyRule[] (required)

BackupSchedule

Name	Description	Value
repeatingTimeIntervals	ISO 8601 repeating time interval format	string[] (required)
timeZone	Time zone for a schedule. Example: Pacific Standard Time	string

BaseBackupPolicy

Name	Description	Value
datasourceTypes	Type of datasource for the backup management	string[] (required)
objectType	Set to 'BackupPolicy' for type BackupPolicy.	'BackupPolicy' (required)

BasePolicyRule

Name	Description	Value
name		string (required)
objectType	Set to 'AzureBackupRule' for type AzureBackupRule. Set to 'AzureRetentionRule' for type AzureRetentionRule.	'AzureBackupRule' 'AzureRetentionRule' (required)

CopyOnExpiryOption

Name	Description	Value
objectType	Type of the specific object - used for deserializing	'CopyOnExpiryOption' (required)

CopyOption

Name	Description	Value
objectType	Set to 'CopyOnExpiryOption' for type CopyOnExpiryOption. Set to 'CustomCopyOption' for type CustomCopyOption. Set to 'ImmediateCopyOption' for type ImmediateCopyOption.	'CopyOnExpiryOption' 'CustomCopyOption' 'ImmediateCopyOption' (required)

CustomCopyOption

Name	Description	Value
duration	Data copied after given timespan	string
objectType	Type of the specific object - used for deserializing	'CustomCopyOption' (required)

DataStoreInfoBase

Name	Description	Value
dataStoreType	type of datastore; Operational/Vault/Archive	'ArchiveStore' 'OperationalStore' 'VaultStore' (required)
objectType	Type of Datasource object, used to initialize the right inherited type	string (required)

Day

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

DeleteOption

Name	Description	Value
duration	Duration of deletion after given timespan	string (required)
objectType	Set to 'AbsoluteDeleteOption' for type AbsoluteDeleteOption.	'AbsoluteDeleteOption' (required)

ImmediateCopyOption

Name	Description	Value
objectType	Type of the specific object - used for deserializing	'ImmediateCopyOption' (required)