Edit

Share via

Lock-AzureRmStorageContainerImmutabilityPolicy

  • Reference
Module:
AzureRM.Storage

Locks ImmutabilityPolicy of a Storage blob containers

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Lock-AzureRmStorageContainerImmutabilityPolicy
    [-ResourceGroupName] <String>
    [-StorageAccountName] <String>
    [-ContainerName] <String>
    [-Etag] <String>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Lock-AzureRmStorageContainerImmutabilityPolicy
    [-ContainerName] <String>
    -StorageAccount <PSStorageAccount>
    [-Etag] <String>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Lock-AzureRmStorageContainerImmutabilityPolicy
    -Container <PSContainer>
    [-Etag] <String>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Lock-AzureRmStorageContainerImmutabilityPolicy
    -InputObject <PSImmutabilityPolicy>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Lock-AzureRmStorageContainerImmutabilityPolicy cmdlet locks ImmutabilityPolicy of a Storage blob containers.

Examples

Example 1: Lock ImmutabilityPolicy of a Storage blob container with Storage account name and container name

PS C:\>$policy = Get-AzureRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer"
PS C:\>Lock-AzureRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Etag $policy.Etag

This command Locks ImmutabilityPolicy of a Storage blob container with Storage account name and container name.

Example 2: Lock ImmutabilityPolicy of a Storage blob container, with Storage account object

PS C:\>$accountObject = Get-AzureRmStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount"
PS C:\>$policy = Get-AzureRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer"
PS C:\>Lock-AzureRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -Etag $policy.Etag -Force

This command locks ImmutabilityPolicy of a Storage blob container, with Storage account object.

Example 3: Lock ImmutabilityPolicyof a Storage blob container, with container object

PS C:\>$containerObject = Get-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -Name "myContainer"
PS C:\>$policy = Get-AzureRmStorageContainerImmutabilityPolicy -Container $containerObject
PS C:\>Lock-AzureRmStorageContainerImmutabilityPolicy -Container $containerObject -Etag $policy.Etag -Force

This command locks ImmutabilityPolicy of a Storage blob container with Storage container object.

Example 4: Lock ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object

PS C:\>Get-AzureRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" | Lock-AzureRmStorageContainerImmutabilityPolicy -Force

This command locks ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Container

Storage container object

Type:PSContainer
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ContainerName

Container Name

Type:String
Aliases:N
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Etag

Immutability policy etag.

Type:String
Aliases:IfMatch
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Force

Force to remove the ImmutabilityPolicy.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

ImmutabilityPolicy Object to Remove

Type:PSImmutabilityPolicy
Aliases:ImmutabilityPolicy
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Resource Group Name.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-StorageAccount

Storage account object

Type:PSStorageAccount
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-StorageAccountName

Storage Account Name.

Type:String
Aliases:AccountName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy

Outputs

PSImmutabilityPolicy