ArmStorageModelFactory.BlobContainerImmutabilityPolicy Method

Definition

Namespace:

Azure.ResourceManager.Storage.Models

Assembly:

Azure.ResourceManager.Storage.dll

Package:

Azure.ResourceManager.Storage v1.7.0

Source:

ArmStorageModelFactory.cs

public static Azure.ResourceManager.Storage.Models.BlobContainerImmutabilityPolicy BlobContainerImmutabilityPolicy(int? immutabilityPeriodSinceCreationInDays = default, Azure.ResourceManager.Storage.Models.ImmutabilityPolicyState? state = default, bool? allowProtectedAppendWrites = default, bool? allowProtectedAppendWritesAll = default, Azure.ETag? eTag = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Storage.Models.UpdateHistoryEntry> updateHistory = default);

static member BlobContainerImmutabilityPolicy : Nullable<int> * Nullable<Azure.ResourceManager.Storage.Models.ImmutabilityPolicyState> * Nullable<bool> * Nullable<bool> * Nullable<Azure.ETag> * seq<Azure.ResourceManager.Storage.Models.UpdateHistoryEntry> -> Azure.ResourceManager.Storage.Models.BlobContainerImmutabilityPolicy

Public Shared Function BlobContainerImmutabilityPolicy (Optional immutabilityPeriodSinceCreationInDays As Nullable(Of Integer) = Nothing, Optional state As Nullable(Of ImmutabilityPolicyState) = Nothing, Optional allowProtectedAppendWrites As Nullable(Of Boolean) = Nothing, Optional allowProtectedAppendWritesAll As Nullable(Of Boolean) = Nothing, Optional eTag As Nullable(Of ETag) = Nothing, Optional updateHistory As IEnumerable(Of UpdateHistoryEntry) = Nothing) As BlobContainerImmutabilityPolicy

Parameters

immutabilityPeriodSinceCreationInDays

Nullable<Int32>

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

state

Nullable<ImmutabilityPolicyState>

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

allowProtectedAppendWrites

Nullable<Boolean>

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

Nullable<Boolean>

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

Nullable<ETag>

ImmutabilityPolicy Etag.

updateHistory

IEnumerable<UpdateHistoryEntry>

The ImmutabilityPolicy update history of the blob container.

Returns

BlobContainerImmutabilityPolicy

A new BlobContainerImmutabilityPolicy instance for mocking.