Share via

Backup Short Term Retention Policies - Create Or Update

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

Updates a database's short term retention policy.

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

Request Body

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

Responses

Name Type Description
200 OK

BackupShortTermRetentionPolicy

Successfully updated the policy.
202 Accepted

Accepted
Other Status Codes

*** Error Responses: ***

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

  • 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}

  • 400 InvalidDiffBackupIntervalHours - The differential backup interval hours of {0} is not a valid configuration. Valid differential backup interval must be {1} hours.

  • 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.

  • 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 SourceDatabaseNotFound - The source database does not exist.

  • 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions

  • 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.

  • 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.

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

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

  • 504 RequestTimeout - Service request exceeded the allowed timeout.

Examples

Update the short 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/testsvr/databases/testdb/backupShortTermRetentionPolicies/default?api-version=2021-11-01

{
  "properties": {
    "retentionDays": 7,
    "diffBackupIntervalInHours": 24
  }
}

Sample response

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

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