Enable-AzStorageDeleteRetentionPolicy

Module:

Az.Storage

Enable delete retention policy for the Azure Storage Blob service.

Syntax

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

Description

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

Examples

Example 1: Enable delete retention policy for the Blob service

Enable-AzStorageDeleteRetentionPolicy -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
Required:	False
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

-PassThru

Display DeleteRetentionPolicyProperties

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

IStorageContext

Outputs

PSDeleteRetentionPolicy