ImmutabilityPolicyProperties Class

The properties of an ImmutabilityPolicy of a blob container.

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

Inheritance

Model

ImmutabilityPolicyProperties

Constructor

ImmutabilityPolicyProperties(*, immutability_period_since_creation_in_days: Optional[int] = None, allow_protected_append_writes: Optional[bool] = None, allow_protected_append_writes_all: Optional[bool] = None, **kwargs)

Variables

etag

str

ImmutabilityPolicy Etag.

update_history

list[UpdateHistoryProperty]

The ImmutabilityPolicy update history of the blob container.

immutability_period_since_creation_in_days

int

The immutability period for the blobs in the container since the policy creation, in days.

state

str or ImmutabilityPolicyState

The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. Possible values include: "Locked", "Unlocked".

allow_protected_append_writes

bool

This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.

allow_protected_append_writes_all

bool

This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.