Share via

Microsoft.Sql servers/databases/backupLongTermRetentionPolicies

  • Article

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@2024-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    monthlyRetention: 'string'
    weeklyRetention: 'string'
    weekOfYear: int
    yearlyRetention: 'string'
  }
}

Property values

BaseLongTermRetentionPolicyProperties

Name Description Value
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

Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies

Name Description Value
name The resource name 'default' (required)
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: servers/databases
properties Resource properties. BaseLongTermRetentionPolicyProperties

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": "2024-05-01-preview",
  "name": "string",
  "properties": {
    "monthlyRetention": "string",
    "weeklyRetention": "string",
    "weekOfYear": "int",
    "yearlyRetention": "string"
  }
}

Property values

BaseLongTermRetentionPolicyProperties

Name Description Value
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

Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies

Name Description Value
apiVersion The api version '2024-05-01-preview'
name The resource name 'default' (required)
properties Resource properties. BaseLongTermRetentionPolicyProperties
type The resource type 'Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies'

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@2024-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      monthlyRetention = "string"
      weeklyRetention = "string"
      weekOfYear = int
      yearlyRetention = "string"
    }
  })
}

Property values

BaseLongTermRetentionPolicyProperties

Name Description Value
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

Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies

Name Description Value
name The resource name 'default' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: servers/databases
properties Resource properties. BaseLongTermRetentionPolicyProperties
type The resource type "Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2024-05-01-preview"