BackupPolicyDescription Class

Describes a backup policy for configuring periodic backup.

All required parameters must be populated in order to send to Azure.

Inheritance

Model

BackupPolicyDescription

Constructor

BackupPolicyDescription(*, name: str, auto_restore_on_data_loss: bool, max_incremental_backups: int, schedule, storage, retention_policy=None, **kwargs)

Parameters

name

str

Required

Required. The unique name identifying this backup policy.

auto_restore_on_data_loss

bool

Required

Required. Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event.

max_incremental_backups

int

Required

Required. Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions

• The replica has never taken a full backup since it has become primary,
• Some of the log records since the last backup has been truncated, or
• Replica passed the MaxAccumulatedBackupLogSizeInMB limit.

schedule

BackupScheduleDescription

Required

Required. Describes the backup schedule parameters.

storage

BackupStorageDescription

Required

Required. Describes the details of backup storage where to store the periodic backups.

retention_policy

RetentionPolicyDescription

Required

Describes the policy to retain backups in storage.