Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy

Module:

Az.Sql Module

Sets a backup short term retention policy.

Syntax

PolicyByResourceInstanceDatabaseSet (Default)

Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy
    [-ResourceGroupName] <String>
    [-InstanceName] <String>
    [-DatabaseName] <String>
    [-RetentionDays] <Int32>
    [-DeletionDate <DateTime>]
    [-LockImmutability <Boolean>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

PolicyByInputObjectSet

Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy
    [-InputObject] <AzureSqlManagedDatabaseBaseModel>
    [-RetentionDays] <Int32>
    [-LockImmutability <Boolean>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

PolicyByResourceIdSet

Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy
    [-ResourceId] <String>
    [-RetentionDays] <Int32>
    [-LockImmutability <Boolean>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

Description

The Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy cmdlet sets the short term retention policy for this database. The policy is the retention period, in days, for point-in-time restore backups. Backup immutability can be locked only for live managed databases. The cmdlet returns an error if LockImmutability is specified for a restorable dropped managed database.

Examples

Example 1

Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -ResourceGroupName resourcegroup01 -InstanceName server01 -DatabaseName database01 -RetentionDays 35

ResourceGroupName  : resourcegroup01
InstanceName       : instance01
DatabaseName       : database01
DeletionDate       :
RetentionDays      : 35
ImmutabilityStatus : Enabled

This command sets the short term retention policy for database01 to 35 days.

Example 2

Get-AzSqlInstanceDatabase -ResourceGroupName resourcegroup01 -InstanceName server01 -Name database01 | Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -RetentionDays 35

ResourceGroupName  : resourcegroup01
InstanceName       : instance01
DatabaseName       : database01
DeletionDate       :
RetentionDays      : 35
ImmutabilityStatus : Enabled

This command sets the short term retention policy for database01 to 35 days via piping in a database object.

Example 3

Get-AzSqlDeletedInstanceDatabaseBackup -ResourceGroupName "ContosoResourceGroup" -InstanceName "ContosoServer" -DatabaseName "DB1" | Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -RetentionDays 8

ResourceGroupName  : resourcegroup01
InstanceName       : instance01
DatabaseName       : database01
DeletionDate       : 2019-03-03 12:00:17 AM
RetentionDays      : 8
ImmutabilityStatus : Enabled

ResourceGroupName  : resourcegroup01
InstanceName       : instance01
DatabaseName       : database01
DeletionDate       : 2019-03-02 11:00:16 PM
RetentionDays      : 8
ImmutabilityStatus : Enabled

This command sets the short term retention policy for all deleted databases named DB1 via piping in a deleted database object. Note you can reduce the retention period only for deleted databases whose backup immutability was not locked before deletion. You cannot specify LockImmutability for a deleted database.

Example 4

Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -ResourceGroupName resourcegroup01 -InstanceName server01 -DatabaseName database01 -RetentionDays 7 -LockImmutability $true -Force

ResourceGroupName  : resourcegroup01
InstanceName       : server01
DatabaseName       : database01
DeletionDate       :
RetentionDays      : 7
ImmutabilityStatus : Locked

This command sets the short term retention policy for the live database database01 to 7 days and locks backup immutability. The -Force parameter skips the confirmation prompt for this irreversible action.

Parameters

-AcquirePolicyToken

Acquire an Azure Policy token automatically for this resource operation.

Parameter properties

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

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ChangeReference

The change reference resource ID for this resource operation.

Parameter properties

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

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-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

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DatabaseName

The name of the Azure SQL Instance Database to retrieve backups for.

Parameter properties

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

Parameter sets

PolicyByResourceInstanceDatabaseSet

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-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

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DeletionDate

The deletion date of the Azure SQL Instance Database to retrieve backups for, with millisecond precision (e.g. 2016-02-23T00:21:22.847Z)

Parameter properties

Type:	Nullable<T>[DateTime]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

PolicyByResourceInstanceDatabaseSet

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Force

Skip confirmation when locking backup immutability.

Parameter properties

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

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

The live or deleted database object to get/set the policy for.

Parameter properties

Type:	AzureSqlManagedDatabaseBaseModel
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzureSqlInstanceDatabase, AzureInstanceDatabaseObject

Parameter sets

PolicyByInputObjectSet

Position:	0
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InstanceName

The name of the Azure SQL Managed Instance the database is in.

Parameter properties

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

Parameter sets

PolicyByResourceInstanceDatabaseSet

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-LockImmutability

Whether to lock the immutability of backups governed by this policy. This parameter is supported only for live managed databases and cannot be used with restorable dropped managed databases.

Parameter properties

Type:	Nullable<T>[Boolean]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

The name of the resource group.

Parameter properties

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

Parameter sets

PolicyByResourceInstanceDatabaseSet

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceId

The short term retention policy resource Id.

Parameter properties

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

Parameter sets

PolicyByResourceIdSet

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-RetentionDays

Days of backup retention.

Parameter properties

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

Parameter sets

(All)

Position:	3
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-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

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

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

AzureSqlManagedDatabaseBaseModel

String

Outputs

AzureSqlManagedDatabaseBackupShortTermRetentionPolicyModel