Enable-AzureStorageDeleteRetentionPolicy

Enable delete retention policy for the Azure Storage Blob service.

Syntax

Enable-AzureStorageDeleteRetentionPolicy
      [-RetentionDays] <Int32>
      [-PassThru]
      [-Context <IStorageContext>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

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

Examples

Example 1: Enable delete retention policy for the Blob service

C:\PS>Enable-AzureStorageDeleteRetentionPolicy -RetentionDays 3

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

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

Azure Storage Context Object

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-DefaultProfile

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

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Display DeleteRetentionPolicyProperties

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

Sets the number of retention days for the DeleteRetentionPolicy.

Type:Int32
Aliases:Days
Position:0
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext

Outputs

PSDeleteRetentionPolicy