Microsoft.Sql servers/databases/backupLongTermRetentionPolicies

Bicep 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 Bicep to your template.

resource symbolicname 'Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2023-05-01-preview' = {
  name: 'default'
  parent: resourceSymbolicName
  properties: {
    backupStorageAccessTier: 'string'
    makeBackupsImmutable: bool
    monthlyRetention: 'string'
    weeklyRetention: 'string'
    weekOfYear: int
    yearlyRetention: 'string'
  }
}

Property values

servers/databases/backupLongTermRetentionPolicies

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
'default'
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: databases
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

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

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2023-05-01-preview"
  name = "default"
  parent_id = "string"
  body = jsonencode({
    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@2023-05-01-preview"
name The resource name "default"
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databases
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