LongTermRetentionPolicy Class

A long term retention policy.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

LongTermRetentionPolicy(*, time_based_immutability: str | _models.TimeBasedImmutability | None = None, time_based_immutability_mode: str | _models.TimeBasedImmutabilityMode | None = None, weekly_retention: str | None = None, monthly_retention: str | None = None, yearly_retention: str | None = None, week_of_year: int | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
time_based_immutability	str or TimeBasedImmutability The setting for whether to enable time-based immutability for future backups. When set, future backups will have TimeBasedImmutability enabled. Known values are: "Enabled" and "Disabled". Default value: None
time_based_immutability_mode	str or TimeBasedImmutabilityMode The setting for time-based immutability mode for future backup (Value can be either Locked or UnLocked. Only effective if TimeBasedImmutability is enabled). Caution: Immutability of LTR backup cannot be removed if TimeBasedImmutabilityMode is Locked. Known values are: "Locked" and "Unlocked". Default value: None
weekly_retention	str The weekly retention policy for an LTR backup in an ISO 8601 format. Default value: None
monthly_retention	str The monthly retention policy for an LTR backup in an ISO 8601 format. Default value: None
yearly_retention	str The yearly retention policy for an LTR backup in an ISO 8601 format. Default value: None
week_of_year	int The week of year to take the yearly backup in an ISO 8601 format. Default value: None

Variables

Name	Description
id	str Resource ID.
name	str Resource name.
type	str Resource type.
time_based_immutability	str or TimeBasedImmutability The setting for whether to enable time-based immutability for future backups. When set, future backups will have TimeBasedImmutability enabled. Known values are: "Enabled" and "Disabled".
time_based_immutability_mode	str or TimeBasedImmutabilityMode The setting for time-based immutability mode for future backup (Value can be either Locked or UnLocked. Only effective if TimeBasedImmutability is enabled). Caution: Immutability of LTR backup cannot be removed if TimeBasedImmutabilityMode is Locked. Known values are: "Locked" and "Unlocked".
weekly_retention	str The weekly retention policy for an LTR backup in an ISO 8601 format.
monthly_retention	str The monthly retention policy for an LTR backup in an ISO 8601 format.
yearly_retention	str The yearly retention policy for an LTR backup in an ISO 8601 format.
week_of_year	int The week of year to take the yearly backup in an ISO 8601 format.