Long Term Retention Policies - List By Database

Service:

SQL Database

API Version:

2021-11-01

Gets a database's long term retention policy.

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

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
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	LongTermRetentionPolicyListResult	Successfully get the policy.
Other Status Codes		*** Error Responses: *** 400 LTRNotSupportedForPerDBCMK - Long-term Backup Retention is not supported when Database-level CMK is configured in preview. 400 LongTermRetentionPolicyNotSupported - Long Term Retention is not supported on this database. 400 LongTermRetentionPolicyInvalid - Long Term Retention policy is invalid. 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 long term retention policy for the database.

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies?api-version=2021-11-01

Java

/**
 * Samples for LongTermRetentionPolicies ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/LongTermRetentionPolicyListByDatabase
     * .json
     */
    /**
     * Sample code: Get the long term retention policy for the database.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getTheLongTermRetentionPolicyForTheDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getLongTermRetentionPolicies().listByDatabase("resourceGroup",
            "testserver", "testDatabase", com.azure.core.util.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

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default",
      "name": "default",
      "type": "Microsoft.Sql/resourceGroups/servers/databases/backupLongTermRetentionPolicies",
      "properties": {
        "weeklyRetention": "P1M",
        "monthlyRetention": "P1Y",
        "yearlyRetention": "P5Y",
        "weekOfYear": 5
      }
    }
  ]
}

Definitions

Name	Description
LongTermRetentionPolicy	A long term retention policy.
LongTermRetentionPolicyListResult	A list of long term retention policies.

LongTermRetentionPolicy

A long term retention policy.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.monthlyRetention	string	The monthly retention policy for an LTR backup in an ISO 8601 format.
properties.weekOfYear	integer	The week of year to take the yearly backup in an ISO 8601 format.
properties.weeklyRetention	string	The weekly retention policy for an LTR backup in an ISO 8601 format.
properties.yearlyRetention	string	The yearly retention policy for an LTR backup in an ISO 8601 format.
type	string	Resource type.

LongTermRetentionPolicyListResult

A list of long term retention policies.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	LongTermRetentionPolicy[]	Array of results.