BackupSchedule interface
Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.
Properties
| frequency |
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) |
| frequency |
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) |
| keep |
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. |
| last |
Last time when this schedule was triggered. NOTE: This property will not be serialized. It can only be populated by the server. |
| retention |
After how many days backups should be deleted. |
| start |
When the schedule should start working. |
Property Details
frequencyInterval
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)
frequencyInterval: numberProperty Value
number
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)
frequencyUnit: FrequencyUnitProperty Value
keepAtLeastOneBackup
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
keepAtLeastOneBackup: booleanProperty Value
boolean
lastExecutionTime
Last time when this schedule was triggered. NOTE: This property will not be serialized. It can only be populated by the server.
lastExecutionTime?: DateProperty Value
Date
retentionPeriodInDays
After how many days backups should be deleted.
retentionPeriodInDays: numberProperty Value
number
startTime
When the schedule should start working.
startTime?: DateProperty Value
Date