Long Term Retention Backups - Get By Resource Group

Service:: SQL Database

API Version:: 2023-08-01

Gets a long term retention backup.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}?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
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.

Responses

Name	Type	Description
200 OK	LongTermRetentionBackup	Successfully retrieved the backup.
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. 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.

Name

Type

Description

200 OK

LongTermRetentionBackup

Successfully retrieved the backup.

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

Examples

Get the long term retention backup.

GET 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;Archive?api-version=2023-08-01

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/ResourceGroupBasedLongTermRetentionBackupGet.json
// this example is just showing the usage of "LongTermRetentionBackups_GetByResourceGroup" 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 = "testResourceGroup";
AzureLocation locationName = new AzureLocation("japaneast");
string longTermRetentionServerName = "testserver";
string longTermRetentionDatabaseName = "testDatabase";
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
ResourceGroupLongTermRetentionBackupResource result = await resourceGroupLongTermRetentionBackup.GetAsync();

// 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/testResourceGroup/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase/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": "testserver",
    "serverCreateTime": "2017-03-10T08:00:00Z",
    "databaseName": "testDatabase",
    "databaseDeletionTime": null,
    "backupTime": "2017-09-06T08:00:00Z",
    "backupStorageRedundancy": "Geo",
    "isBackupImmutable": false,
    "backupStorageAccessTier": "Archive"
  }
}

Definitions

Name	Description
BackupStorageAccessTier	The BackupStorageAccessTier for the LTR backup
BackupStorageRedundancy	The storage redundancy type of the copied backup
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
Archive
Hot

BackupStorageRedundancy

Enumeration

The storage redundancy type of the copied backup

Value	Description
Geo
GeoZone
Local
Zone

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.

LongTermRetentionBackup

Object

A long term retention backup.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.backupExpirationTime	string (date-time)	The time the long term retention backup will expire.
properties.backupStorageAccessTier	BackupStorageAccessTier	The BackupStorageAccessTier for the LTR backup
properties.backupStorageRedundancy	BackupStorageRedundancy	The storage redundancy type of the backup
properties.backupTime	string (date-time)	The time the backup was taken
properties.databaseDeletionTime	string (date-time)	The delete time of the database
properties.databaseName	string	The name of the database the backup belong to
properties.isBackupImmutable	boolean	The setting whether the LTR backup is immutable
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	The storage redundancy type of the backup
properties.serverCreateTime	string (date-time)	The create time of the server.
properties.serverName	string	The server name that the backup database belong to.
type	string	Resource type.

Share via

Long Term Retention Backups - Get By Resource Group

URI Parameters

Responses

Examples

Get the long term retention backup.

Sample request

Sample response

Definitions

BackupStorageAccessTier

BackupStorageRedundancy

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongTermRetentionBackup