ImmutabilityPolicy interface

Package:

@azure/arm-storage

The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag.

Extends

AzureEntityResource

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

Inherited Properties

etag	Resource Etag. NOTE: This property will not be serialized. It can only be populated by the server.
id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" 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

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

Inherited Property Details

etag

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

etag?: string

Property Value

string

Inherited From AzureEntityResource.etag

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From AzureEntityResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From AzureEntityResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From AzureEntityResource.type