Long Term Retention Backups - Copy

Service:: SQL Database

API Version:: 2023-08-01

Copy an existing long term retention backup.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}/copy?api-version=2023-08-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
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.targetBackupStorageRedundancy	BackupStorageRedundancy	The storage redundancy type of the copied backup
properties.targetDatabaseName	string	The name of the database owns the copied backup.
properties.targetResourceGroup	string	The resource group that owns the target server
properties.targetServerFullyQualifiedDomainName	string	The fully qualified domain name of the target server
properties.targetServerResourceId	string	The resource Id of the target server that owns the database
properties.targetSubscriptionId	string	The subscription that owns the target server

Responses

Name	Type	Description
200 OK	LongTermRetentionBackupOperationResult	Successfully copied the backup.
202 Accepted		Copying the backup is in progress. 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 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 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup. 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup. 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup. 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect. 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage - Archiving long-term retention backups on zone redundant backup storage is not supported. Use locally redundant or geo-redundant storage types instead. 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing - The subscription ID is required to update the long-term retention backup. 400 UpdateBackupStorageAccessTierLtrServerMissing - The server name is required to update the long-term retention backup. 400 UpdateBackupStorageAccessTierLtrDatabaseMissing - The database name is required to update the long-term retention backup. 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect. 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 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable. 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 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups. 400 LtrArchiveStorageTierNotEnabled - Archiving long-term retention backups is not enabled. 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed. 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found. 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 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 CannotCancelOperation - The management operation is in a state that cannot be cancelled. 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.

Name

Type

Description

200 OK

LongTermRetentionBackupOperationResult

Successfully copied the backup.

202 Accepted

Copying the backup is in progress.

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 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 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.
400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.
400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.
400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.
400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage - Archiving long-term retention backups on zone redundant backup storage is not supported. Use locally redundant or geo-redundant storage types instead.
400 UpdateBackupStorageAccessTierLtrSubscriptionMissing - The subscription ID is required to update the long-term retention backup.
400 UpdateBackupStorageAccessTierLtrServerMissing - The server name is required to update the long-term retention backup.
400 UpdateBackupStorageAccessTierLtrDatabaseMissing - The database name is required to update the long-term retention backup.
400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.
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 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.
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 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.
400 LtrArchiveStorageTierNotEnabled - Archiving long-term retention backups is not enabled.
400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.
400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set
400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.
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 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 CannotCancelOperation - The management operation is in a state that cannot be cancelled.
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

Copy the long term retention backup.

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

{
  "properties": {
    "targetServerResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testserver2",
    "targetDatabaseName": "testDatabase2",
    "targetBackupStorageRedundancy": "Geo"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/LongTermRetentionBackupCopy.json
// this example is just showing the usage of "LongTermRetentionBackups_Copy" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionLongTermRetentionBackupResource created on azure
// for more information of creating SubscriptionLongTermRetentionBackupResource, please refer to the document of SubscriptionLongTermRetentionBackupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
AzureLocation locationName = new AzureLocation("japaneast");
string longTermRetentionServerName = "testserver";
string longTermRetentionDatabaseName = "testDatabase";
string backupName = "55555555-6666-7777-8888-999999999999;131637960820000000";
ResourceIdentifier subscriptionLongTermRetentionBackupResourceId = SubscriptionLongTermRetentionBackupResource.CreateResourceIdentifier(subscriptionId, locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName);
SubscriptionLongTermRetentionBackupResource subscriptionLongTermRetentionBackup = client.GetSubscriptionLongTermRetentionBackupResource(subscriptionLongTermRetentionBackupResourceId);

// invoke the operation
CopyLongTermRetentionBackupContent content = new CopyLongTermRetentionBackupContent
{
    TargetServerResourceId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testserver2"),
    TargetDatabaseName = "testDatabase2",
    TargetBackupStorageRedundancy = SqlBackupStorageRedundancy.Geo,
};
ArmOperation<LongTermRetentionBackupOperationResult> lro = await subscriptionLongTermRetentionBackup.CopyAsync(WaitUntil.Completed, content);
LongTermRetentionBackupOperationResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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/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/providers/Microsoft.Sql/locations/japanEast/longTermRetentionServers/testserver/longterRetentionDatabases/testDatabase/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000",
    "operationType": "CopyBackup",
    "status": "Succeeded",
    "toBackupResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/locations/japanEast/longTermRetentionServers/testserver2/longterRetentionDatabases/testDatabase2/longTermRetentionBackups/55555555-6666-7777-8888-111111111111;131637960820000000",
    "targetBackupStorageRedundancy": "Geo"
  }
}

Status code:: 202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japanEast/longTermRetentionBackupOperationResults/a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706?api-version=2021-05-01

Definitions

Name	Description
BackupStorageRedundancy	The storage redundancy type of the copied backup
CopyLongTermRetentionBackupParameters	Contains the information necessary to perform long term retention backup copy operation.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
LongTermRetentionBackupOperationResult	A LongTermRetentionBackup operation result resource.

BackupStorageRedundancy

Enumeration

The storage redundancy type of the copied backup

Value	Description
Geo
GeoZone
Local
Zone

CopyLongTermRetentionBackupParameters

Object

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

Name	Type	Description
properties.targetBackupStorageRedundancy	BackupStorageRedundancy	The storage redundancy type of the copied backup
properties.targetDatabaseName	string	The name of the database owns the copied backup.
properties.targetResourceGroup	string	The resource group that owns the target server
properties.targetServerFullyQualifiedDomainName	string	The fully qualified domain name of the target server
properties.targetServerResourceId	string	The resource Id of the target server that owns the database
properties.targetSubscriptionId	string	The subscription that owns the target server

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.

LongTermRetentionBackupOperationResult

Object

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 (uuid)	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.

Share via

Long Term Retention Backups - Copy

URI Parameters

Request Body

Responses

Examples

Copy the long term retention backup.

Sample request

Sample response

Definitions

BackupStorageRedundancy

CopyLongTermRetentionBackupParameters

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongTermRetentionBackupOperationResult