BackupShortTermRetentionPolicyArgs

data class BackupShortTermRetentionPolicyArgs(val databaseName: Output<String>? = null, val diffBackupIntervalInHours: Output<Int>? = null, val policyName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val retentionDays: Output<Int>? = null, val serverName: Output<String>? = null) : ConvertibleToJava<BackupShortTermRetentionPolicyArgs>

A short term retention policy. Uses Azure REST API version 2023-08-01. In version 2.x of the Azure Native provider, it used API version 2021-11-01. Other available API versions: 2017-10-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Update the short term retention policy for the database.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var backupShortTermRetentionPolicy = new AzureNative.Sql.BackupShortTermRetentionPolicy("backupShortTermRetentionPolicy", new()
{
DatabaseName = "testdb",
DiffBackupIntervalInHours = 24,
PolicyName = "default",
ResourceGroupName = "resourceGroup",
RetentionDays = 7,
ServerName = "testsvr",
});
});
package main
import (
sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sql.NewBackupShortTermRetentionPolicy(ctx, "backupShortTermRetentionPolicy", &sql.BackupShortTermRetentionPolicyArgs{
DatabaseName: pulumi.String("testdb"),
DiffBackupIntervalInHours: pulumi.Int(24),
PolicyName: pulumi.String("default"),
ResourceGroupName: pulumi.String("resourceGroup"),
RetentionDays: pulumi.Int(7),
ServerName: pulumi.String("testsvr"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.sql.BackupShortTermRetentionPolicy;
import com.pulumi.azurenative.sql.BackupShortTermRetentionPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var backupShortTermRetentionPolicy = new BackupShortTermRetentionPolicy("backupShortTermRetentionPolicy", BackupShortTermRetentionPolicyArgs.builder()
.databaseName("testdb")
.diffBackupIntervalInHours(24)
.policyName("default")
.resourceGroupName("resourceGroup")
.retentionDays(7)
.serverName("testsvr")
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:sql:BackupShortTermRetentionPolicy default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}

Constructors

Link copied to clipboard
constructor(databaseName: Output<String>? = null, diffBackupIntervalInHours: Output<Int>? = null, policyName: Output<String>? = null, resourceGroupName: Output<String>? = null, retentionDays: Output<Int>? = null, serverName: Output<String>? = null)

Properties

Link copied to clipboard
val databaseName: Output<String>? = null

The name of the database.

Link copied to clipboard
val diffBackupIntervalInHours: Output<Int>? = null

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.

Link copied to clipboard
val policyName: Output<String>? = null

The policy name. Should always be "default".

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

Link copied to clipboard
val retentionDays: Output<Int>? = null

The backup retention period in days. This is how many days Point-in-Time Restore will be supported.

Link copied to clipboard
val serverName: Output<String>? = null

The name of the server.

Functions

Link copied to clipboard
open override fun toJava(): BackupShortTermRetentionPolicyArgs