Microsoft.Sql servers/databases/backupLongTermRetentionPolicies

ARM template resource definition

The servers/databases/backupLongTermRetentionPolicies resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies",
  "apiVersion": "2023-05-01-preview",
  "name": "default",
  "properties": {
    "backupStorageAccessTier": "string",
    "makeBackupsImmutable": "bool",
    "monthlyRetention": "string",
    "weeklyRetention": "string",
    "weekOfYear": "int",
    "yearlyRetention": "string"
  }
}

Property values

servers/databases/backupLongTermRetentionPolicies

Name Description Value
type The resource type 'Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies'
apiVersion The resource api version '2023-05-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
'default'
properties Resource properties. LongTermRetentionPolicyProperties

LongTermRetentionPolicyProperties

Name Description Value
backupStorageAccessTier The BackupStorageAccessTier for the LTR backups 'Archive'
'Hot'
makeBackupsImmutable The setting whether to make LTR backups immutable bool
monthlyRetention The monthly retention policy for an LTR backup in an ISO 8601 format. string
weeklyRetention The weekly retention policy for an LTR backup in an ISO 8601 format. string
weekOfYear The week of year to take the yearly backup in an ISO 8601 format. int
yearlyRetention The yearly retention policy for an LTR backup in an ISO 8601 format. string