Share via

Long Term Retention Backups - Get By Resource Group

  • Reference
Service:
SQL Database
API Version:
2021-11-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=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.

Responses

Name Type Description
200 OK

LongTermRetentionBackup

Successfully retrieved the backup.
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

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

Examples

Get the long term retention backup.

Sample request

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?api-version=2021-11-01

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase/longTermRetentionBackups/2017-03-10T08:00:00.000Z;55555555-6666-7777-8888-999999999999;2017-09-06T08:00:00.000Z",
  "name": "2017-03-10T08:00:00.000Z;55555555-6666-7777-8888-999999999999;131637960820000000",
  "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"
  }
}

Definitions

Name Description
BackupStorageRedundancy

The storage redundancy type of the copied backup
LongTermRetentionBackup

A long term retention backup.

BackupStorageRedundancy

The storage redundancy type of the copied backup

Name Type Description
Geo

string

GeoZone

string

Local

string

Zone

string

LongTermRetentionBackup

A long term retention backup.

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties.backupExpirationTime

string

The time the long term retention backup will expire.
properties.backupStorageRedundancy

BackupStorageRedundancy

The storage redundancy type of the backup
properties.backupTime

string

The time the backup was taken
properties.databaseDeletionTime

string

The delete time of the database
properties.databaseName

string

The name of the database the backup belong to
properties.requestedBackupStorageRedundancy

BackupStorageRedundancy

The storage redundancy type of the backup
properties.serverCreateTime

string

The create time of the server.
properties.serverName

string

The server name that the backup database belong to.
type

string

Resource type.