Share via


Long Term Retention Managed Instance Backups - List By Instance

Lists the long term retention backups for a given managed instance.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstances/{managedInstanceName}/longTermRetentionManagedInstanceBackups?api-version=2023-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstances/{managedInstanceName}/longTermRetentionManagedInstanceBackups?onlyLatestPerDatabase={onlyLatestPerDatabase}&databaseState={databaseState}&api-version=2023-08-01

URI Parameters

Name In Required Type Description
locationName
path True

string

The location of the database

managedInstanceName
path True

string

The name of the managed instance.

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

ManagedInstanceLongTermRetentionBackupListResult

Successfully retrieved the list of backups.

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

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

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

Examples

Get all long term retention backups under the managed instance.

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionManagedInstances/testInstance/longTermRetentionManagedInstanceBackups?api-version=2023-08-01

Sample response

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionManagedInstances/testInstance/longTermRetentionDatabases/testDatabase1/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": "testDatabase1",
        "databaseDeletionTime": null,
        "backupTime": "2017-08-23T08:00:00Z",
        "backupStorageRedundancy": "Geo",
        "backupStorageAccessTier": "Archive"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionManagedInstances/testInstance/longTermRetentionDatabases/testDatabase2/longTermRetentionManagedInstanceBackups/12341234-1234-1234-1234-123123123123;131657960820000000;Hot",
      "name": "12341234-1234-1234-1234-123123123123;131657960820000000;Hot",
      "type": "Microsoft.Sql/locations/longTermRetentionManagedInstances/longTermRetentionDatabases/longTermRetentionManagedInstanceBackups",
      "properties": {
        "managedInstanceName": "testInstance",
        "managedInstanceCreateTime": "2017-03-10T08:00:00Z",
        "databaseName": "testDatabase2",
        "databaseDeletionTime": null,
        "backupTime": "2017-08-30T08:00:00Z",
        "backupStorageRedundancy": "Geo",
        "backupStorageAccessTier": "Hot"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionManagedInstances/testInstance/longTermRetentionDatabases/testDatabase3/longTermRetentionManagedInstanceBackups/43214321-4321-4321-4321-321321321321;131677960820000000;Archive",
      "name": "43214321-4321-4321-4321-321321321321;131667960820000000",
      "type": "Microsoft.Sql/locations/longTermRetentionManagedInstances/longTermRetentionDatabases/longTermRetentionManagedInstanceBackups",
      "properties": {
        "managedInstanceName": "testInstance",
        "managedInstanceCreateTime": "2017-03-10T08:00:00Z",
        "databaseName": "testDatabase3",
        "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

databaseState

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

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

ManagedInstanceLongTermRetentionBackup

A long term retention backup for a managed database.

ManagedInstanceLongTermRetentionBackupListResult

A list of long term retention backups for managed database(s).

BackupStorageAccessTier

The BackupStorageAccessTier for the LTR backup

Value Description
Hot
Archive

BackupStorageRedundancy

The storage redundancy type of the 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

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

Error response

Name Type Description
error

ErrorDetail

The error object.

ManagedInstanceLongTermRetentionBackup

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.

ManagedInstanceLongTermRetentionBackupListResult

A list of long term retention backups for managed database(s).

Name Type Description
nextLink

string

Link to retrieve next page of results.

value

ManagedInstanceLongTermRetentionBackup[]

Array of results.