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=2023-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionBackups?onlyLatestPerDatabase={onlyLatestPerDatabase}&databaseState={databaseState}&api-version=2023-08-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
location
|
path | True |
string |
The location of the database |
|
long
|
path | True |
string |
The name of the server |
|
subscription
|
path | True |
string |
The subscription ID that identifies an Azure subscription. |
|
api-version
|
query | True |
string |
The API version to use for the request. |
|
database
|
query |
Whether to query against just live databases, just deleted databases, or all databases. |
||
|
only
|
query |
boolean |
Whether or not to only get the latest backup for each database. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Successfully retrieved the list of backups. |
|
| Other Status Codes |
*** Error Responses: ***
|
Examples
Get all long term retention backups under the server.
Sample request
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;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": "testDatabase1",
"databaseDeletionTime": null,
"backupTime": "2017-08-23T08:00:00Z",
"backupStorageRedundancy": "Geo",
"isBackupImmutable": false,
"backupStorageAccessTier": "Archive"
}
},
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase1/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000;Hot",
"name": "55555555-6666-7777-8888-999999999999;131637960820000000;Hot",
"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",
"isBackupImmutable": false,
"backupStorageAccessTier": "Hot"
}
},
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase2/longTermRetentionBackups/12341234-1234-1234-1234-123123123123;131657960820000000;Archive",
"name": "12341234-1234-1234-1234-123123123123;131657960820000000;Archive",
"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",
"isBackupImmutable": false,
"backupStorageAccessTier": "Archive"
}
}
]
}
Definitions
| Name | Description |
|---|---|
|
Backup |
The BackupStorageAccessTier for the LTR backup |
|
Backup |
The storage redundancy type of the copied backup |
|
database |
Whether to query against just live databases, just deleted databases, or all databases. |
|
Error |
The resource management error additional info. |
|
Error |
The error detail. |
|
Error |
Error response |
|
Long |
A long term retention backup. |
|
Long |
A list of long term retention backups. |
BackupStorageAccessTier
The BackupStorageAccessTier for the LTR backup
| Value | Description |
|---|---|
| Hot | |
| Archive |
BackupStorageRedundancy
The storage redundancy type of the copied backup
| Value | Description |
|---|---|
| Geo | |
| Local | |
| Zone | |
| GeoZone |
databaseState
Whether to query against just live databases, just deleted databases, or all databases.
| Value | Description |
|---|---|
| All | |
| Live | |
| Deleted |
ErrorAdditionalInfo
The resource management error additional info.
| Name | Type | Description |
|---|---|---|
| info |
object |
The additional info. |
| type |
string |
The additional info type. |
ErrorDetail
The error detail.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
The error additional info. |
|
| code |
string |
The error code. |
| details |
The error details. |
|
| message |
string |
The error message. |
| target |
string |
The error target. |
ErrorResponse
Error response
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
LongTermRetentionBackup
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 |
The BackupStorageAccessTier for the LTR backup |
|
| properties.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 |
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. |
LongTermRetentionBackupListResult
A list of long term retention backups.
| Name | Type | Description |
|---|---|---|
| nextLink |
string |
Link to retrieve next page of results. |
| value |
Array of results. |