Backup Short Term Retention Policies - Get

Service:

SQL Database

API Version:

2021-11-01

Gets a database's short term retention policy.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies/default?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
policyName	path	True	ShortTermRetentionPolicyName	The policy name. Should always be "default".
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	BackupShortTermRetentionPolicy	Successfully retrieved the policy.
Other Status Codes		*** Error Responses: *** 400 InvalidParameterValue - An invalid value was given to a parameter. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ResourceNotFound - The requested resource was not found.

Examples

Get the short term retention policy for the database.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/backupShortTermRetentionPolicies/default?api-version=2021-11-01

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.ShortTermRetentionPolicyName;

/** Samples for BackupShortTermRetentionPolicies Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/GetShortTermRetentionPolicy.json
     */
    /**
     * Sample code: Get the short term retention policy for the database.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getTheShortTermRetentionPolicyForTheDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getBackupShortTermRetentionPolicies().getWithResponse(
            "Default-SQL-SouthEastAsia", "testsvr", "testdb", ShortTermRetentionPolicyName.DEFAULT, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/backupShortTermRetentionPolicies/default",
  "name": "default",
  "type": "Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies",
  "properties": {
    "retentionDays": 7,
    "diffBackupIntervalInHours": 24
  }
}

Definitions

Name	Description
BackupShortTermRetentionPolicy	A short term retention policy.
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.
ShortTermRetentionPolicyName	The policy name. Should always be "default".

BackupShortTermRetentionPolicy

A short term retention policy.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.diffBackupIntervalInHours	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.
properties.retentionDays	integer	The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
type	string	Resource type.

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.

Name	Type	Description
12	string
24	string

ShortTermRetentionPolicyName

The policy name. Should always be "default".

Name	Type	Description
default	string