Long Term Retention Managed Instance Backups - Get By Resource Group

Service:: SQL Database

API Version:: 2023-08-01

Gets a long term retention backup for a managed database.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstances/{managedInstanceName}/longTermRetentionDatabases/{databaseName}/longTermRetentionManagedInstanceBackups/{backupName}?api-version=2023-08-01

URI Parameters

Name	In	Required	Type	Description
backupName	path	True	string	The backup name.
databaseName	path	True	string	The name of the managed database.
locationName	path	True	string	The location of the database.
managedInstanceName	path	True	string	The name of the managed instance.
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	ManagedInstanceLongTermRetentionBackup	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 InvalidLongTermRetentionManagedInstanceBackupId - Invalid long term retention backup identifier for Managed Instances. 400 LongTermRetentiontBackupOperationResultsInvalidODataQuery - The specified OData query is either not valid or not supported 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

ManagedInstanceLongTermRetentionBackup

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 InvalidLongTermRetentionManagedInstanceBackupId - Invalid long term retention backup identifier for Managed Instances.
400 LongTermRetentiontBackupOperationResultsInvalidODataQuery - The specified OData query is either not valid or not supported
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/longTermRetentionManagedInstances/testInstance/longTermRetentionDatabases/testDatabase/longTermRetentionManagedInstanceBackups/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;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ResourceGroupBasedManagedInstanceLongTermRetentionBackupGet.json
// this example is just showing the usage of "LongTermRetentionManagedInstanceBackups_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 ResourceGroupLongTermRetentionManagedInstanceBackupResource created on azure
// for more information of creating ResourceGroupLongTermRetentionManagedInstanceBackupResource, please refer to the document of ResourceGroupLongTermRetentionManagedInstanceBackupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testResourceGroup";
AzureLocation locationName = new AzureLocation("japaneast");
string managedInstanceName = "testInstance";
string databaseName = "testDatabase";
string backupName = "55555555-6666-7777-8888-999999999999;131637960820000000;Archive";
ResourceIdentifier resourceGroupLongTermRetentionManagedInstanceBackupResourceId = ResourceGroupLongTermRetentionManagedInstanceBackupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, locationName, managedInstanceName, databaseName, backupName);
ResourceGroupLongTermRetentionManagedInstanceBackupResource resourceGroupLongTermRetentionManagedInstanceBackup = client.GetResourceGroupLongTermRetentionManagedInstanceBackupResource(resourceGroupLongTermRetentionManagedInstanceBackupResourceId);

// invoke the operation
ResourceGroupLongTermRetentionManagedInstanceBackupResource result = await resourceGroupLongTermRetentionManagedInstanceBackup.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
ManagedInstanceLongTermRetentionBackupData 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/longTermRetentionManagedInstances/testInstance/longTermRetentionDatabases/testDatabase/longTermRetentionManagedInstanceBackups/55555555-6666-7777-8888-999999999999;131637960820000000;Archive",
  "name": "55555555-6666-7777-8888-999999999999;131637960820000000;Archive",
  "type": "Microsoft.Sql/locations/longTermRetentionManagedInstances/longTermRetentionDatabases/longTermRetentionManagedInstanceBackups",
  "properties": {
    "managedInstanceName": "testInstance",
    "managedInstanceCreateTime": "2017-03-10T08:00:00Z",
    "databaseName": "testDatabase",
    "databaseDeletionTime": null,
    "backupTime": "2017-09-06T08:00:00Z",
    "backupStorageRedundancy": "Geo",
    "backupStorageAccessTier": "Archive"
  }
}

Definitions

Name	Description
BackupStorageAccessTier	The BackupStorageAccessTier for the LTR backup
BackupStorageRedundancy	The storage redundancy type of the backup
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedInstanceLongTermRetentionBackup	A long term retention backup for a managed database.

BackupStorageAccessTier

Enumeration

The BackupStorageAccessTier for the LTR backup

Value	Description
Hot
Archive

BackupStorageRedundancy

Enumeration

The storage redundancy type of the backup

Value	Description
Geo
Local
Zone
GeoZone

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.

ManagedInstanceLongTermRetentionBackup

Object

A long term retention backup for a managed database.

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.managedInstanceCreateTime	string (date-time)	The create time of the instance.
properties.managedInstanceName	string	The managed instance that the backup database belongs to.
type	string	Resource type.

Share via

Long Term Retention Managed Instance 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

ManagedInstanceLongTermRetentionBackup