Share via

Long Term Retention Policies - Create Or Update

  • Reference
Service:
SQL Database
API Version:
2021-11-01

Sets a database's long term retention policy.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/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

LongTermRetentionPolicyName

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.

Request Body

Name Type Description
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.

Responses

Name Type Description
200 OK

LongTermRetentionPolicy

Successfully set the policy.
202 Accepted

Accepted
Other Status Codes

*** Error Responses: ***

  • 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.

  • 400 InvalidParameterValue - An invalid value was given to a parameter.

  • 400 LongTermRetentionMissingWeekOfYear - WeekOfYear is required to be set between 1 and 52 in order to set yearly retention.

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

  • 404 OperationIdNotFound - The operation with Id does not exist.

  • 409 OperationCancelled - The operation has been cancelled by user.

  • 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.

  • 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.

  • 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.

  • 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.

  • 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Create or update the long term retention policy for the database.

Sample request

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

{
  "properties": {
    "weeklyRetention": "P1M",
    "monthlyRetention": "P1Y",
    "yearlyRetention": "P5Y",
    "weekOfYear": 5
  }
}

Sample response

Status code:
200 
{
  "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
  }
}
Status code:
202

Definitions

Name Description
LongTermRetentionPolicy

A long term retention policy.
LongTermRetentionPolicyName

The policy name. Should always be Default.

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.

LongTermRetentionPolicyName

The policy name. Should always be Default.

Name Type Description
default

string