Long Term Retention Managed Instance Backups - List By Resource Group Location

Service:

SQL Database

API Version:

2021-11-01

Lists the long term retention backups for managed databases in a given location.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstanceBackups?api-version=2021-11-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstanceBackups?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.
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.
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		*** 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 location.

Sample request

HTTP

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

Java

/**
 * Samples for LongTermRetentionManagedInstanceBackups ListByResourceGroupLocation.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ResourceGroupBasedManagedInstanceLongTermRetentionBackupListByLocation.json
     */
    /**
     * Sample code: Get all long term retention backups under the location.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getAllLongTermRetentionBackupsUnderTheLocation(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getLongTermRetentionManagedInstanceBackups()
            .listByResourceGroupLocation("testResourceGroup", "japaneast", null, null,
                com.azure.core.util.Context.NONE);
    }
}

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

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japaneast/longTermRetentionManagedInstances/testInstance1/longTermRetentionDatabases/testDatabase1/longTermRetentionManagedInstanceBackups/55555555-6666-7777-8888-999999999999;131637960820000000",
      "name": "55555555-6666-7777-8888-999999999999;2017-08-23T08:00:00.000Z",
      "type": "Microsoft.Sql/locations/longTermRetentionManagedInstances/longTermRetentionDatabases/longTermRetentionManagedInstanceBackups",
      "properties": {
        "managedInstanceName": "testInstance1",
        "managedInstanceCreateTime": "2017-03-10T08:00:00Z",
        "databaseName": "testDatabase1",
        "databaseDeletionTime": null,
        "backupTime": "2017-08-23T08:00:00Z",
        "backupStorageRedundancy": "Geo"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japaneast/longTermRetentionManagedInstances/testInstance2/longTermRetentionDatabases/testDatabase2/longTermRetentionManagedInstanceBackups/12341234-1234-1234-1234-123123123123;131657960820000000",
      "name": "12341234-1234-1234-1234-123123123123;2017-08-30T08:00:00.000Z",
      "type": "Microsoft.Sql/locations/longTermRetentionManagedInstances/longTermRetentionDatabases/longTermRetentionManagedInstanceBackups",
      "properties": {
        "managedInstanceName": "testInstance2",
        "managedInstanceCreateTime": "2017-04-10T08:00:00Z",
        "databaseName": "testDatabase2",
        "databaseDeletionTime": null,
        "backupTime": "2017-08-30T08:00:00Z",
        "backupStorageRedundancy": "Geo"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japaneast/longTermRetentionManagedInstances/testInstance3/longTermRetentionDatabases/testDatabase3/longTermRetentionManagedInstanceBackups/43214321-4321-4321-4321-321321321321;131677960820000000",
      "name": "43214321-4321-4321-4321-321321321321;2017-09-06T08:00:00.000Z",
      "type": "Microsoft.Sql/locations/longTermRetentionManagedInstances/longTermRetentionDatabases/longTermRetentionManagedInstanceBackups",
      "properties": {
        "managedInstanceName": "testInstance3",
        "managedInstanceCreateTime": "2017-05-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 backup
databaseState	Whether to query against just live databases, just deleted databases, or all databases.
ManagedInstanceLongTermRetentionBackup	A long term retention backup for a managed database.
ManagedInstanceLongTermRetentionBackupListResult	A list of long term retention backups for managed database(s).

BackupStorageRedundancy

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

ManagedInstanceLongTermRetentionBackup

A long term retention backup for a managed database.

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.managedInstanceCreateTime	string	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.