Share via

AutoBackupSettings interface

  • Reference
Package:
@azure/arm-sqlvirtualmachine

Configure backups for databases in your SQL virtual machine.

Properties

backupScheduleType

Backup schedule type.
backupSystemDbs

Include or exclude system databases from auto backup.
daysOfWeek

Days of the week for the backups when FullBackupFrequency is set to Weekly.
enable

Enable or disable autobackup on SQL virtual machine.
enableEncryption

Enable or disable encryption for backup on SQL virtual machine.
fullBackupFrequency

Frequency of full backups. In both cases, full backups begin during the next scheduled time window.
fullBackupStartTime

Start time of a given day during which full backups can take place. 0-23 hours.
fullBackupWindowHours

Duration of the time window of a given day during which full backups can take place. 1-23 hours.
logBackupFrequency

Frequency of log backups. 5-60 minutes.
password

Password for encryption on backup.
retentionPeriod

Retention period of backup: 1-90 days.
storageAccessKey

Storage account key where backup will be taken to.
storageAccountUrl

Storage account url where backup will be taken to.
storageContainerName

Storage container name where backup will be taken to.

Property Details

backupScheduleType

Backup schedule type.

backupScheduleType?: string

Property Value

string

backupSystemDbs

Include or exclude system databases from auto backup.

backupSystemDbs?: boolean

Property Value

boolean

daysOfWeek

Days of the week for the backups when FullBackupFrequency is set to Weekly.

daysOfWeek?: string[]

Property Value

string[]

enable

Enable or disable autobackup on SQL virtual machine.

enable?: boolean

Property Value

boolean

enableEncryption

Enable or disable encryption for backup on SQL virtual machine.

enableEncryption?: boolean

Property Value

boolean

fullBackupFrequency

Frequency of full backups. In both cases, full backups begin during the next scheduled time window.

fullBackupFrequency?: string

Property Value

string

fullBackupStartTime

Start time of a given day during which full backups can take place. 0-23 hours.

fullBackupStartTime?: number

Property Value

number

fullBackupWindowHours

Duration of the time window of a given day during which full backups can take place. 1-23 hours.

fullBackupWindowHours?: number

Property Value

number

logBackupFrequency

Frequency of log backups. 5-60 minutes.

logBackupFrequency?: number

Property Value

number

password

Password for encryption on backup.

password?: string

Property Value

string

retentionPeriod

Retention period of backup: 1-90 days.

retentionPeriod?: number

Property Value

number

storageAccessKey

Storage account key where backup will be taken to.

storageAccessKey?: string

Property Value

string

storageAccountUrl

Storage account url where backup will be taken to.

storageAccountUrl?: string

Property Value

string

storageContainerName

Storage container name where backup will be taken to.

storageContainerName?: string

Property Value

string