Backup.RetainDays Property

 

Gets or sets the number of days that must elapse before a backup set can be overwritten.

Namespace:   Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.SmoExtended (in Microsoft.SqlServer.SmoExtended.dll)

public int RetainDays { get; set; }

Property Value

Type: System.Int32

An Int32 value that specifies the retention period in days. By default, the value is set to zero.

Backup set retention period is set when media is initialized. When using SQL Server Management Objects (SMO) to automate Microsoft SQL Server backup, the RetainDays property is only evaluated when the Initialize property is True.

VB

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2012 database.
Dim db As Database
db = srv.Databases("AdventureWorks2012")
Dim bk As New Backup
bk.Action = BackupActionType.Database
bk.Database = "AdventureWorks2012"
bk.RetainDays = 21

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2012")
$bk = new-object Microsoft.SqlServer.Management.Smo.Backup
$bk.Action = [Microsoft.SqlServer.Management.Smo.BackupActionType]::Database
$bk.Database = "AdventureWorks2012"
$bk.RetainDays = 21
Return to top
Show: