Share via

ImmutabilityPolicyProperties interface

  • Reference
Package:
@azure/arm-storage

The properties of an ImmutabilityPolicy of a blob container.

Properties

allowProtectedAppendWrites

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.
allowProtectedAppendWritesAll

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.
etag

ImmutabilityPolicy Etag. NOTE: This property will not be serialized. It can only be populated by the server.
immutabilityPeriodSinceCreationInDays

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

The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. NOTE: This property will not be serialized. It can only be populated by the server.
updateHistory

The ImmutabilityPolicy update history of the blob container. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

allowProtectedAppendWrites

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.

allowProtectedAppendWrites?: boolean

Property Value

boolean

allowProtectedAppendWritesAll

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.

allowProtectedAppendWritesAll?: boolean

Property Value

boolean

etag

ImmutabilityPolicy Etag. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

immutabilityPeriodSinceCreationInDays

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

immutabilityPeriodSinceCreationInDays?: number

Property Value

number

state

The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

string

updateHistory

The ImmutabilityPolicy update history of the blob container. NOTE: This property will not be serialized. It can only be populated by the server.

updateHistory?: UpdateHistoryProperty[]

Property Value

UpdateHistoryProperty[]