Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BackupSchedule

Package version

Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.

Hierarchy

  • BackupSchedule

Index

Properties

frequencyInterval

frequencyInterval: number

How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day). Default value: 7.

frequencyUnit

frequencyUnit: FrequencyUnit

The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7). Possible values include: 'Day', 'Hour'. Default value: 'Day'.

keepAtLeastOneBackup

keepAtLeastOneBackup: boolean

True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. Default value: true.

Optional lastExecutionTime

lastExecutionTime: Date

Last time when this schedule was triggered. NOTE: This property will not be serialized. It can only be populated by the server.

retentionPeriodInDays

retentionPeriodInDays: number

After how many days backups should be deleted. Default value: 30.

Optional startTime

startTime: Date

When the schedule should start working.

Generated using TypeDoc