Share via

Microsoft.Sql servers/databases/backupShortTermRetentionPolicies 2022-08-01-preview

  • Article

Bicep resource definition

The servers/databases/backupShortTermRetentionPolicies 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/backupShortTermRetentionPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2022-08-01-preview' = {
  name: 'default'
  parent: resourceSymbolicName
  properties: {
    diffBackupIntervalInHours: int
    retentionDays: int
  }
}

Property values

servers/databases/backupShortTermRetentionPolicies

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. BackupShortTermRetentionPolicyProperties

BackupShortTermRetentionPolicyProperties

Name Description Value
diffBackupIntervalInHours The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. int
retentionDays The backup retention period in days. This is how many days Point-in-Time Restore will be supported. int

ARM template resource definition

The servers/databases/backupShortTermRetentionPolicies 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/backupShortTermRetentionPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies",
  "apiVersion": "2022-08-01-preview",
  "name": "default",
  "properties": {
    "diffBackupIntervalInHours": "int",
    "retentionDays": "int"
  }
}

Property values

servers/databases/backupShortTermRetentionPolicies

Name Description Value
type The resource type 'Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies'
apiVersion The resource api version '2022-08-01-preview'
name The resource name

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

BackupShortTermRetentionPolicyProperties

Name Description Value
diffBackupIntervalInHours The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. int
retentionDays The backup retention period in days. This is how many days Point-in-Time Restore will be supported. int

Terraform (AzAPI provider) resource definition

The servers/databases/backupShortTermRetentionPolicies 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/backupShortTermRetentionPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2022-08-01-preview"
  name = "default"
  parent_id = "string"
  body = jsonencode({
    properties = {
      diffBackupIntervalInHours = int
      retentionDays = int
    }
  })
}

Property values

servers/databases/backupShortTermRetentionPolicies

Name Description Value
type The resource type "Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2022-08-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. BackupShortTermRetentionPolicyProperties

BackupShortTermRetentionPolicyProperties

Name Description Value
diffBackupIntervalInHours The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. int
retentionDays The backup retention period in days. This is how many days Point-in-Time Restore will be supported. int