Modifier

Partager via


Enable-AzStorageBlobDeleteRetentionPolicy

Enable delete retention policy for the Azure Storage Blob service.

Syntax

Enable-AzStorageBlobDeleteRetentionPolicy
      [-ResourceGroupName] <String>
      [-StorageAccountName] <String>
      -RetentionDays <Int32>
      [-PassThru]
      [-AllowPermanentDelete]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Enable-AzStorageBlobDeleteRetentionPolicy
      -StorageAccount <PSStorageAccount>
      -RetentionDays <Int32>
      [-PassThru]
      [-AllowPermanentDelete]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
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.

Type:SwitchParameter
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

-DefaultProfile

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

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

-PassThru

Display ServiceProperties

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

-ResourceGroupName

Resource Group Name.

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

-ResourceId

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

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

-RetentionDays

Sets the number of retention days for the DeleteRetentionPolicy.

Type:Int32
Aliases:Days
Position:Named
Default value:None
Required:True
Accept pipeline input:False
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, Name
Position:1
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

PSStorageAccount

String

Outputs

PSBlobServiceProperties