Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Enable-AzStorageBlobDeleteRetentionPolicy

Enable delete retention policy for the Azure Storage Blob service.

Syntax

AccountName (Default) 

Enable-AzStorageBlobDeleteRetentionPolicy
 [-ResourceGroupName] <String>
 [-StorageAccountName] <String>
 -RetentionDays <Int32>
 [-PassThru]
 [-AllowPermanentDelete]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

AccountObject 

Enable-AzStorageBlobDeleteRetentionPolicy
 -StorageAccount <PSStorageAccount>
 -RetentionDays <Int32>
 [-PassThru]
 [-AllowPermanentDelete]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

BlobServicePropertiesResourceId 

Enable-AzStorageBlobDeleteRetentionPolicy
 [-ResourceId] <String>
 -RetentionDays <Int32>
 [-PassThru]
 [-AllowPermanentDelete]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

The Enable-AzStorageBlobDeleteRetentionPolicy cmdlet enables delete retention policy for the Azure Storage Blob service.

Examples

Example 1: Enable delete retention policy for the Blob service

Enable-AzStorageBlobDeleteRetentionPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -AllowPermanentDelete -PassThru -RetentionDays 4

Enabled Days AllowPermanentDelete
------- ---- --------------------
 True 4 True

This command enables delete retention policy for the Blob service, and set deleted blob retention days to 4.

Parameters

-AllowPermanentDelete

Allow deletion of the soft deleted blob versions and snapshots.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-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

-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

-PassThru

Display ServiceProperties

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceGroupName

Resource Group Name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceId

Input a Storage account Resource Id, or a Blob service properties Resource Id.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-RetentionDays

Sets the number of retention days for the DeleteRetentionPolicy.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Days

Parameter sets

-StorageAccount

Storage account object

Parameter properties

Type:PSStorageAccount
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-StorageAccountName

Storage Account Name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AccountName, Name

Parameter sets

-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

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.

Inputs

PSStorageAccount

String

Outputs

PSBlobServiceProperties

Feedback

Was this page helpful?