Long Term Retention Backups - Update By Resource Group

Service:

SQL Database

API Version:

2021-11-01

Updates an existing long term retention backup.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}/update?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
backupName	path	True	string	The backup name.
locationName	path	True	string	The location of the database.
longTermRetentionDatabaseName	path	True	string	The name of the database
longTermRetentionServerName	path	True	string	The name of the server
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.requestedBackupStorageRedundancy	BackupStorageRedundancy	The storage redundancy type of the copied backup

Responses

Name	Type	Description
200 OK	LongTermRetentionBackupOperationResult	Successfully updated the backup.
202 Accepted		Updating the backup is in progress.
Other Status Codes		*** Error Responses: *** 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs. 400 InvalidParameterValue - An invalid value was given to a parameter. 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature. 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature. 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation. 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server. 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation. 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server. 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region. 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer. 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups. 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations. 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found. 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 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists. 404 OperationIdNotFound - The operation with Id does not exist. 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress. 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists. 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 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region. 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs. 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached. 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed. 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

Update the long term retention backup.

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000/update?api-version=2021-11-01

{
  "properties": {
    "requestedBackupStorageRedundancy": "Geo"
  }
}

Java

import com.azure.resourcemanager.sql.models.BackupStorageRedundancy;
import com.azure.resourcemanager.sql.models.UpdateLongTermRetentionBackupParameters;

/**
 * Samples for LongTermRetentionBackups UpdateByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ResourceGroupBasedLongTermRetentionBackupUpdate.json
     */
    /**
     * Sample code: Update the long term retention backup.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateTheLongTermRetentionBackup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getLongTermRetentionBackups()
            .updateByResourceGroup("testResourceGroup", "japaneast", "testserver", "testDatabase",
                "55555555-6666-7777-8888-999999999999;131637960820000000", new UpdateLongTermRetentionBackupParameters()
                    .withRequestedBackupStorageRedundancy(BackupStorageRedundancy.GEO),
                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

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japanEast/longTermRetentionBackupOperationResults/a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706",
  "name": "a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706",
  "type": "Microsoft.Sql/locations/longTermRetentionBackupOperationResults",
  "properties": {
    "requestId": "a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706",
    "fromBackupResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japanEast/longTermRetentionServers/testserver/longterRetentionDatabases/testDatabase/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000",
    "operationType": "UpdateBackup",
    "status": "Succeeded",
    "targetBackupStorageRedundancy": "Geo"
  }
}

Status code:

202

Definitions

Name	Description
BackupStorageRedundancy	The storage redundancy type of the copied backup
LongTermRetentionBackupOperationResult	A LongTermRetentionBackup operation result resource.
UpdateLongTermRetentionBackupParameters	Contains the information necessary to perform long term retention backup update operation.

BackupStorageRedundancy

The storage redundancy type of the copied backup

Name	Type	Description
Geo	string
GeoZone	string
Local	string
Zone	string

LongTermRetentionBackupOperationResult

A LongTermRetentionBackup operation result resource.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.fromBackupResourceId	string	Source backup resource id
properties.message	string	Progress message
properties.operationType	string	Operation type.
properties.requestId	string	Request Id.
properties.status	string	Operation status
properties.targetBackupStorageRedundancy	BackupStorageRedundancy	The storage redundancy type of the copied backup
properties.toBackupResourceId	string	Target backup resource id
type	string	Resource type.

UpdateLongTermRetentionBackupParameters

Contains the information necessary to perform long term retention backup update operation.

Name	Type	Description
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	The storage redundancy type of the copied backup