Long Term Retention Backups - List By Server

Lists the long term retention backups for a given server.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionBackups?api-version=2021-11-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionBackups?onlyLatestPerDatabase={onlyLatestPerDatabase}&databaseState={databaseState}&api-version=2021-11-01

URI Parameters

Name In Required Type Description
locationName
path True

string

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

databaseState
query

databaseState

Whether to query against just live databases, just deleted databases, or all databases.

onlyLatestPerDatabase
query

boolean

Whether or not to only get the latest backup for each database.

Responses

Name Type Description
200 OK

LongTermRetentionBackupListResult

Successfully retrieved the list of backups.

Other Status Codes

*** Error Responses: ***

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

Examples

Get all long term retention backups under the server.

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionBackups?api-version=2021-11-01

Sample response

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase1/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000",
      "name": "55555555-6666-7777-8888-999999999999;131637960820000000",
      "type": "Microsoft.Sql/locations/longTermRetentionServers/longTermRetentionDatabases/longTermRetentionBackups",
      "properties": {
        "serverName": "testserver",
        "serverCreateTime": "2017-03-10T08:00:00Z",
        "databaseName": "testDatabase1",
        "databaseDeletionTime": null,
        "backupTime": "2017-08-23T08:00:00Z",
        "backupStorageRedundancy": "Geo"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase2/longTermRetentionBackups/12341234-1234-1234-1234-123123123123;131657960820000000",
      "name": "12341234-1234-1234-1234-123123123123;131657960820000000",
      "type": "Microsoft.Sql/locations/longTermRetentionServers/longTermRetentionDatabases/longTermRetentionBackups",
      "properties": {
        "serverName": "testserver",
        "serverCreateTime": "2017-03-10T08:00:00Z",
        "databaseName": "testDatabase2",
        "databaseDeletionTime": null,
        "backupTime": "2017-08-30T08:00:00Z",
        "backupStorageRedundancy": "Geo"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase3/longTermRetentionBackups/43214321-4321-4321-4321-321321321321;131677960820000000",
      "name": "43214321-4321-4321-4321-321321321321;131667960820000000",
      "type": "Microsoft.Sql/locations/longTermRetentionServers/longTermRetentionDatabases/longTermRetentionBackups",
      "properties": {
        "serverName": "testserver",
        "serverCreateTime": "2017-03-10T08:00:00Z",
        "databaseName": "testDatabase3",
        "databaseDeletionTime": null,
        "backupTime": "2017-09-06T08:00:00Z",
        "backupStorageRedundancy": "Geo"
      }
    }
  ]
}

Definitions

Name Description
BackupStorageRedundancy

The storage redundancy type of the copied backup

databaseState

Whether to query against just live databases, just deleted databases, or all databases.

LongTermRetentionBackup

A long term retention backup.

LongTermRetentionBackupListResult

A list of long term retention backups.

BackupStorageRedundancy

The storage redundancy type of the copied backup

Name Type Description
Geo

string

GeoZone

string

Local

string

Zone

string

databaseState

Whether to query against just live databases, just deleted databases, or all databases.

Name Type Description
All

string

Deleted

string

Live

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.

LongTermRetentionBackupListResult

A list of long term retention backups.

Name Type Description
nextLink

string

Link to retrieve next page of results.

value

LongTermRetentionBackup[]

Array of results.