Specifies guest scripting options for linux-based Azure VMs.
UserScriptsSettingsV2
Property
Type
Description
scriptsEnabled
boolean
Defines whether to run custom scripts on Azure VMs.
preScriptPath
string
Path to the directory on an Azure VM where the pre-snapshot script reside.
preScriptArguments
string
Specifies arguments to be passed to the pre-snapshot script when the script is executed.
postScriptPath
string
Path to the directory on an Azure VM where the post-snapshot script reside.
postScriptArguments
string
Specifies arguments to be passed to the post-snapshot script when the script is executed.
repositorySnapshotsOnly
boolean
Defines whether to run scripts only when performing a snapshot for the image-level backup operation.
ignoreExitCodes
boolean
Defines whether to continue performing backup if script execution failed with errors.
ignoreMissingScripts
boolean
Defines whether to continue performing backup if scripts are missing on the Azure VM.
DailyScheduleV2
Property
Type
Description
dailyType
string
Days when the backup policy must run: Everyday, WeekDays, SelectedDays.
selectedDays
string
[Applies if the Selected days value is specified for thedailyType parameter] Days of the week when the backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.
runsPerHour
integer($int32)
[Applies only for cloud-native snapshots] Number of cloud-native snapshots that the backup policy must create within an hour (minimum: 1).
Period of time to keep restore points in a backup chain.
targetRepositoryId
string
System ID assigned to the target backup repository.
MonthlyScheduleV2
Property
Type
Description
startTime
integer($int32)
Date of the backup policy creation or modification and time when the backup policy must run.
type
array(string)
Day of the month when the backup policy must run: First, Second, Third, Fourth, Last, SelectedDay.
dayOfWeek
array [string]
[Applies if one of the First, Second, Third, Fourth or Last values isspecified for thetype parameter] Days of the week when the backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.
dayOfMonth
integer($int32)
[Applies if the SelectedDay value isspecified for thetype parameter] Ordinal number of the day of the month when the backup policy must run.
monthlyLastDay
boolean
Defines whether the backup policy must run always on last day of the month.
Monthly schedule settings for image-level backups.
MonthlySnapshotScheduleV2
Property
Type
Description
selectedMonths
string
Months when the backup policy must start creating cloud-native snapshots: January, February, March, April, May, June, July, August, September, October, November, December.
snapshotsToKeep
integer($int32)
Number of restore points to keep in a backup chain.
MonthlyBackupScheduleV2
Property
Type
Description
selectedMonths
string
Months when the backup policy must start creating cloud-native snapshots: January, February, March, April, May, June, July, August, September, October, November, December.
Period of time to keep restore points in a backup chain.
targetRepositoryId
string
System ID assigned to the target backup repository.
YearlyScheduleV2
Property
Type
Description
startTime
integer($int32)
Date of the backup policy creation or modification and time when the backup policy must run.
month
string
Months when the backup policy must start creating cloud-native snapshots: January, February, March, April, May, June, July, August, September, October, November, December.
type
array(string)
Day of the month when the backup policy must run: First, Second, Third, Fourth, Last, SelectedDay.
dayOfWeek
array [string]
[Applies if one of the First, Second, Third, Fourth or Last values isspecified for thetype parameter] Days of the week when the backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.
dayOfMonth
integer($int32)
[Applies if the SelectedDay value isspecified for thetype parameter] Ordinal number of the day of the month when the backup policy must run.
yearlyLastDay
boolean
Defines whether the backup policy must run always on last day of the year.
retentionYearsCount
integer($int32)
Number of years to keep restore points in a backup chain.
targetRepositoryId
string
System ID assigned to the target backup repository.
RepositoryRetentionSettingsV2
Property
Type
Description
timeRetentionDuration
integer($int32)
Number of days, weeks, months or years to keep restore points in a backup chain.