Updates a managed database's short term retention policy.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/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.
|
|
managedInstanceName
|
path |
True
|
string
|
The name of the managed instance.
|
|
policyName
|
path |
True
|
ManagedShortTermRetentionPolicyName
|
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.
|
|
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.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
|
ManagedBackupShortTermRetentionPolicy
|
Successfully updated the policy.
|
|
202 Accepted
|
|
Accepted
|
|
Other Status Codes
|
|
*** Error Responses: ***
400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)
400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid
400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier
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}
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
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.
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.
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/managedInstances/testsvr/databases/testdb/backupShortTermRetentionPolicies/default?api-version=2021-11-01
{
"properties": {
"retentionDays": 14
}
}
import com.azure.resourcemanager.sql.fluent.models.ManagedBackupShortTermRetentionPolicyInner;
import com.azure.resourcemanager.sql.models.ManagedShortTermRetentionPolicyName;
/**
* Samples for ManagedBackupShortTermRetentionPolicies Update.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/UpdateManagedShortTermRetentionPolicy
* .json
*/
/**
* Sample code: Update the short term retention policy for the database.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void
updateTheShortTermRetentionPolicyForTheDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
azure.sqlServers().manager().serviceClient().getManagedBackupShortTermRetentionPolicies().update(
"resourceGroup", "testsvr", "testdb", ManagedShortTermRetentionPolicyName.DEFAULT,
new ManagedBackupShortTermRetentionPolicyInner().withRetentionDays(14), 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
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb/backupShortTermRetentionPolicies/default",
"name": "default",
"type": "Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies",
"properties": {
"retentionDays": 14
}
}
Definitions
ManagedBackupShortTermRetentionPolicy
A short term retention policy.
| Name |
Type |
Description |
|
id
|
string
|
Resource ID.
|
|
name
|
string
|
Resource name.
|
|
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.
|
ManagedShortTermRetentionPolicyName
The policy name. Should always be "default".
| Name |
Type |
Description |
|
default
|
string
|
|