Long Term Retention Backups - Change Access Tier By Resource Group

Service:: SQL Database

API Version:: 2023-08-01

Change a long term retention backup access tier.

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

URI Parameters

Name	In	Required	Type	Description
backupName	path	True	string
locationName	path	True	string
longTermRetentionDatabaseName	path	True	string
longTermRetentionServerName	path	True	string
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	Required	Type	Description
backupStorageAccessTier	True	string	The long term retention backup storage access tier
operationMode	True	string	The operation mode when updating ltr backup storage access tier

Responses

Name	Type	Description
200 OK	LongTermRetentionBackup	Successfully changed the long term retention backup access tier.
202 Accepted		Accepted Headers Location: string
Other Status Codes	ErrorResponse	* 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 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 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

LongTermRetentionBackup

Successfully changed the long term retention backup access tier.

202 Accepted

Accepted

Headers

Location: string

Other Status Codes

ErrorResponse

*** 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 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 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

Change the long term retention backup storage access tier for a resource group.

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

{
  "backupStorageAccessTier": "Hot",
  "operationMode": "Copy"
}

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/ResourceGroupBasedChangeLongTermRetentionBackupAccessTier.json
// this example is just showing the usage of "LongTermRetentionBackups_ChangeAccessTierByResourceGroup" 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 ResourceGroupLongTermRetentionBackupResource created on azure
// for more information of creating ResourceGroupLongTermRetentionBackupResource, please refer to the document of ResourceGroupLongTermRetentionBackupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "resourceGroupName";
AzureLocation locationName = new AzureLocation("japaneast");
string longTermRetentionServerName = "serverName";
string longTermRetentionDatabaseName = "databaseName";
string backupName = "55555555-6666-7777-8888-999999999999;131637960820000000;Archive";
ResourceIdentifier resourceGroupLongTermRetentionBackupResourceId = ResourceGroupLongTermRetentionBackupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName);
ResourceGroupLongTermRetentionBackupResource resourceGroupLongTermRetentionBackup = client.GetResourceGroupLongTermRetentionBackupResource(resourceGroupLongTermRetentionBackupResourceId);

// invoke the operation
ChangeLongTermRetentionBackupAccessTierParameters changeLongTermRetentionBackupAccessTierParameters = new ChangeLongTermRetentionBackupAccessTierParameters("Hot", "Copy");
ArmOperation<ResourceGroupLongTermRetentionBackupResource> lro = await resourceGroupLongTermRetentionBackup.ChangeAccessTierByResourceGroupAsync(WaitUntil.Completed, changeLongTermRetentionBackupAccessTierParameters);
ResourceGroupLongTermRetentionBackupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
LongTermRetentionBackupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/resourceGroupName/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/serverName/longTermRetentionDatabases/databaseName/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000;Archive",
  "name": "55555555-6666-7777-8888-999999999999;131637960820000000;Archive",
  "type": "Microsoft.Sql/locations/longTermRetentionServers/longTermRetentionDatabases/longTermRetentionBackups",
  "properties": {
    "serverName": "serverName",
    "serverCreateTime": "2017-09-06T08:00:00Z",
    "databaseName": "databaseName",
    "databaseDeletionTime": null,
    "backupTime": "2017-09-06T08:00:00Z",
    "backupExpirationTime": null,
    "backupStorageRedundancy": "Geo"
  }
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/serverName/longTermRetentionDatabases/databaseName/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000;Archive/operations/55555555-6666-7777-8888-999999999999?api-version=2023-05-01-preview

Definitions

Name	Description
BackupStorageAccessTier	The BackupStorageAccessTier for the LTR backup
BackupStorageRedundancy	The storage redundancy type of the copied backup
ChangeLongTermRetentionBackupAccessTierParameters	Contains the information necessary to change long term retention backup access tier and related operation mode.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
LongTermRetentionBackup	A long term retention backup.

BackupStorageAccessTier

Enumeration

The BackupStorageAccessTier for the LTR backup

Value	Description
Hot
Archive

BackupStorageRedundancy

Enumeration

The storage redundancy type of the copied backup

Value	Description
Geo
Local
Zone
GeoZone

ChangeLongTermRetentionBackupAccessTierParameters

Object

Contains the information necessary to change long term retention backup access tier and related operation mode.

Name	Type	Description
backupStorageAccessTier	string	The long term retention backup storage access tier
operationMode	string	The operation mode when updating ltr backup storage access tier

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.