Set-AzRmStorageContainerImmutabilityPolicy
Creates or updates ImmutabilityPolicy of a Storage blob containers
Syntax
AccountName (Default)
Set-AzRmStorageContainerImmutabilityPolicy
[-ResourceGroupName] <String>
[-StorageAccountName] <String>
-ContainerName <String>
[-ImmutabilityPeriod <Int32>]
[-AllowProtectedAppendWriteAll <Boolean>]
[-AllowProtectedAppendWrite <Boolean>]
[-Etag <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ExtendAccountName
Set-AzRmStorageContainerImmutabilityPolicy
[-ResourceGroupName] <String>
[-StorageAccountName] <String>
-ContainerName <String>
-ImmutabilityPeriod <Int32>
-Etag <String>
[-ExtendPolicy]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AccountObject
Set-AzRmStorageContainerImmutabilityPolicy
-ContainerName <String>
-StorageAccount <PSStorageAccount>
[-ImmutabilityPeriod <Int32>]
[-AllowProtectedAppendWriteAll <Boolean>]
[-AllowProtectedAppendWrite <Boolean>]
[-Etag <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ExtendAccountObject
Set-AzRmStorageContainerImmutabilityPolicy
-ContainerName <String>
-StorageAccount <PSStorageAccount>
-ImmutabilityPeriod <Int32>
-Etag <String>
[-ExtendPolicy]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ContainerObject
Set-AzRmStorageContainerImmutabilityPolicy
-Container <PSContainer>
[-ImmutabilityPeriod <Int32>]
[-AllowProtectedAppendWriteAll <Boolean>]
[-AllowProtectedAppendWrite <Boolean>]
[-Etag <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ExtendContainerObject
Set-AzRmStorageContainerImmutabilityPolicy
-Container <PSContainer>
-ImmutabilityPeriod <Int32>
-Etag <String>
[-ExtendPolicy]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ImmutabilityPolicyObject
Set-AzRmStorageContainerImmutabilityPolicy
[-InputObject] <PSImmutabilityPolicy>
[-ImmutabilityPeriod <Int32>]
[-AllowProtectedAppendWriteAll <Boolean>]
[-AllowProtectedAppendWrite <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ExtendImmutabilityPolicyObject
Set-AzRmStorageContainerImmutabilityPolicy
[-InputObject] <PSImmutabilityPolicy>
-ImmutabilityPeriod <Int32>
[-ExtendPolicy]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzRmStorageContainerImmutabilityPolicy cmdlet creates or updates ImmutabilityPolicy of a Storage blob containers
Examples
Example 1: Create or update ImmutabilityPolicy of a Storage blob container with Storage account name and container name
Set-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -ImmutabilityPeriod 10
This command creates or updates ImmutabilityPolicy of a Storage blob container with Storage account name and container name.
Example 2: Extend ImmutabilityPolicy of a Storage blob container, with Storage account object
$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount"
$policy = Get-AzRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer"
Set-AzRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -ImmutabilityPeriod 20 -Etag $policy.Etag -ExtendPolicy
This command extend ImmutabilityPolicy of a Storage blob container, with Storage account object. Extend ImmutabilityPolicy can only run after ImmutabilityPolicy is locked.
Example 3: Update ImmutabilityPolicy of a Storage blob container
$containerObject = Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -Name "myContainer"
$policy = Set-AzRmStorageContainerImmutabilityPolicy -Container $containerObject -ImmutabilityPeriod 12
$policy = Set-AzRmStorageContainerImmutabilityPolicy -Container $containerObject -ImmutabilityPeriod 9 -Etag $policy.Etag
$policy = Set-AzRmStorageContainerImmutabilityPolicy -Container $containerObject -AllowProtectedAppendWrite $true
$policy = Set-AzRmStorageContainerImmutabilityPolicy -Container $containerObject -AllowProtectedAppendWrite $false -AllowProtectedAppendWriteAll $true
This command updates ImmutabilityPolicy of a Storage blob container with Storage container object 3 times:
First to ImmutabilityPeriod 12 days without etag, then to ImmutabilityPeriod 9 days with etag, then enabled AllowProtectedAppendWrite, finally enabled AllowProtectedAppendWriteAll.
Example 4: Extend ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object
Get-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" | Set-AzRmStorageContainerImmutabilityPolicy -ImmutabilityPeriod 15 -ExtendPolicy
This command extend ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object. Extend ImmutabilityPolicy can only run after ImmutabilityPolicy is locked.
Parameters
-AllowProtectedAppendWrite
This property can only be changed for unlocked time-based retention policies.
With this property 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.
'-AllowProtectedAppendWrites' and '-AllowProtectedAppendWritesAll' are mutually exclusive.
Parameter properties
Type: Boolean
Default value: None Supports wildcards: False DontShow: False
Parameter sets
AccountName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AccountObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ContainerObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ImmutabilityPolicyObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AllowProtectedAppendWriteAll
This property can only be changed for unlocked policies.
When enabled, new blocks can be written to both 'Append and Block 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. '-AllowProtectedAppendWrites' and '-AllowProtectedAppendWritesAll' are mutually exclusive.
Parameter properties
Type: Boolean
Default value: None Supports wildcards: False DontShow: False
Parameter sets
AccountName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AccountObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ContainerObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ImmutabilityPolicyObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Container
Storage container object
Parameter properties
Type: PSContainer
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ContainerObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
ExtendContainerObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
-ContainerName
Container Name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: N
Parameter sets
AccountName
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
ExtendAccountName
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
AccountObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
ExtendAccountObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Etag
Immutability policy etag. If -ExtendPolicy is not specified, Etag is optional; else Etag is required.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: IfMatch
Parameter sets
AccountName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AccountObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ContainerObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ExtendPolicy
Indicate ExtendPolicy to Extend an existing ImmutabilityPolicy. After ImmutabilityPolicy is locked, it can only be extend.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ExtendAccountName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ExtendAccountObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ExtendContainerObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ExtendImmutabilityPolicyObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ImmutabilityPeriod
Immutability period since creation in days.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False Aliases: ImmutabilityPeriodSinceCreationInDays
Parameter sets
AccountName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AccountObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ContainerObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ImmutabilityPolicyObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Container Name
Type: PSImmutabilityPolicy
Default value: None Supports wildcards: False DontShow: False Aliases: ImmutabilityPolicy
ImmutabilityPolicyObject
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
ExtendImmutabilityPolicyObject
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
-ResourceGroupName
Resource Group Name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
AccountName
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
ExtendAccountName
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-StorageAccount
Storage account object
Parameter properties
Type: PSStorageAccount
Default value: None Supports wildcards: False DontShow: False
Parameter sets
AccountObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
ExtendAccountObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
-StorageAccountName
Storage Account Name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: AccountName
Parameter sets
AccountName
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
ExtendAccountName
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
