Set-AzStorageBlobImmutabilityPolicy

Reference

Module:: Az.Storage

Creates or updates ImmutabilityPolicy of a Storage blob.

Syntax

Set-AzStorageBlobImmutabilityPolicy
   [-Blob] <String>
   [-Container] <String>
   -ExpiresOn <DateTimeOffset>
   [-PolicyMode <String>]
   [-TagCondition <String>]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzStorageBlobImmutabilityPolicy
   -BlobBaseClient <BlobBaseClient>
   -ExpiresOn <DateTimeOffset>
   [-PolicyMode <String>]
   [-TagCondition <String>]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzStorageBlobImmutabilityPolicy cmdlet creates or updates ImmutabilityPolicy of a Storage blob. The cmdlet only works when the blob container has already enabled immutable Storage with versioning.

Examples

Example 1: Create or update immutability policy of a Storage blob.

$blob = Set-AzStorageBlobImmutabilityPolicy -Container $containerName -Blob $blobname  -ExpiresOn (Get-Date).AddDays(100) -PolicyMode Unlocked

$blob

   AccountName: mystorageaccount, ContainerName: mycontainer

Name                 BlobType  Length          ContentType                    LastModified         AccessTier SnapshotTime                 IsDeleted  VersionId                     
----                 --------  ------          -----------                    ------------         ---------- ------------                 ---------  ---------                     
testblob             BlockBlob 10485760        application/octet-stream       2021-07-19 08:56:00Z Hot                                     False      2021-07-19T08:56:01.8120788Z *   

$blob.BlobProperties.ImmutabilityPolicy

ExpiresOn                    PolicyMode
---------                    ----------
10/27/2021 8:56:32 AM +00:00   Unlocked

This command creates or updates ImmutabilityPolicy of a Storage blob, then show the blob and its ImmutabilityPolicy. The command only works when the blob container has already enabled immutable Storage with versioning.

Parameters

-Blob

Blob name

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

-BlobBaseClient

BlobBaseClient Object

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

-ClientTimeoutPerRequest

The client side maximum execution time for each request in seconds.

Type:	Nullable<T>[Int32]
Aliases:	ClientTimeoutPerRequestInSeconds
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ConcurrentTaskCount

The total amount of concurrent async tasks. The default value is 10.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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

Container name

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

-Context

Azure Storage Context Object

Type:	IStorageContext
Position:	Named
Default value:	None
Required:	False
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

-ExpiresOn

Blob ImmutabilityPolicy ExpiresOn

Type:	Nullable<T>[DateTimeOffset]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PolicyMode

Blob ImmutabilityPolicy PolicyMode

Type:	String
Accepted values:	Unlocked, Locked, Mutable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServerTimeoutPerRequest

The server time out for each request in seconds.

Type:	Nullable<T>[Int32]
Aliases:	ServerTimeoutPerRequestInSeconds
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TagCondition

Optional Tag expression statement to check match condition. The blob request will fail when the blob tags does not match the given expression.See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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

BlobBaseClient

IStorageContext

Outputs

AzureStorageBlob

Partager via