Share via

Backup Short Term Retention Policies - Update

  • Reference
Service:
SQL Database
API Version:
2023-08-01

Updates a database's short term retention policy.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies/default?api-version=2023-08-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 (int32)

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 (int32)

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

Headers

Location: string
Other Status Codes

ErrorResponse

*** Error Responses: ***

  • 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state

  • 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state

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

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

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

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

  • 400 FeatureIsNotAvailableForServiceTier - {0} is not available for {1} service tier.

  • 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 ResourceNotFound - The requested resource was not found.

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

  • 404 SourceDatabaseNotFound - The source database does not exist.

  • 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

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/servers/testsvr/databases/testdb/backupShortTermRetentionPolicies/default?api-version=2023-08-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 
Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/westus/shortTermRetentionPolicyOperationResults/00000000-1111-2222-3333-444444444444?api-version=2021-02-01-preview

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

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
ShortTermRetentionPolicyName

The policy name. Should always be "default".

BackupShortTermRetentionPolicy

Object

A short term retention policy.

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties.diffBackupIntervalInHours

DiffBackupIntervalInHours (int32)

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 (int32)

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

string

Resource type.

DiffBackupIntervalInHours

Enumeration

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.

Value Description
12
24

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

ShortTermRetentionPolicyName

Enumeration

The policy name. Should always be "default".

Value Description
default