Restore Points - List By Database

  • Reference
Service:
SQL Database
API Version:
2021-11-01

Gets a list of database restore points.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints?api-version=2021-11-01

URI Parameters

Name In Required Type Description
databaseName
 path True

string

The name 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.
serverName
 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.

Responses

Name Type Description
200 OK

RestorePointListResult

Successfully returned restore points.
Other Status Codes

*** Error Responses: ***

  • 400 BackupNotAllowedOnDeactivatedDatabase - Cannot create restore point on a deactivated database.

  • 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.

  • 400 RestorePointLimitReached - A restore point cannot be created because database would exceed the allowed quota of restore points.

  • 400 RestorePointAttemptToDeleteSystemBackup - Cannot delete system restore point.

  • 404 DatabaseRestorePointNotFound - Can not find database restore point.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.

  • 408 DatabaseRestorePointTimedOut - Create database restore point failed.

Examples

List database restore points.
List datawarehouse database restore points.

List database restore points.

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6730/providers/Microsoft.Sql/servers/sqlcrudtest-9007/databases/3481/restorePoints?api-version=2021-11-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6730/providers/Microsoft.Sql/servers/sqlcrudtest-9007/databases/3481/restorepoints/ContinuousRestorePoint",
      "name": "ContinuousRestorePoint",
      "location": "West US",
      "type": "Microsoft.Sql/servers/databases/restorePoints",
      "properties": {
        "restorePointType": "CONTINUOUS",
        "earliestRestoreDate": "2017-06-12T00:00:00Z"
      }
    }
  ]
}

List datawarehouse database restore points.

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/restorePoints?api-version=2021-11-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/restorePoints/131546477590000000",
      "name": "131546477590000000",
      "type": "Microsoft.Sql/servers/databases/restorePoints",
      "location": "japaneast",
      "properties": {
        "restorePointType": "DISCRETE",
        "restorePointCreationDate": "2017-03-10T08:00:00Z",
        "restorePointLabel": "mylabel1"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/restorePoints/131553636140000000",
      "name": "131553636140000000",
      "type": "Microsoft.Sql/servers/databases/restorePoints",
      "location": "japaneast",
      "properties": {
        "restorePointType": "DISCRETE",
        "restorePointCreationDate": "2017-11-17T03:40:14Z",
        "restorePointLabel": "mylabel2"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/restorePoints/131553619750000000",
      "name": "131553619750000000",
      "type": "Microsoft.Sql/servers/databases/restorePoints",
      "location": "japaneast",
      "properties": {
        "restorePointType": "DISCRETE",
        "restorePointCreationDate": "2017-11-17T03:12:55Z"
      }
    }
  ]
}

Definitions

Name Description
RestorePoint

Database restore points.
RestorePointListResult

A list of long term retention backups.
RestorePointType

The type of restore point

RestorePoint

Database restore points.

Name Type Description
id

string

Resource ID.
location

string

Resource location.
name

string

Resource name.
properties.earliestRestoreDate

string

The earliest time to which this database can be restored
properties.restorePointCreationDate

string

The time the backup was taken
properties.restorePointLabel

string

The label of restore point for backup request by user
properties.restorePointType

RestorePointType

The type of restore point
type

string

Resource type.

RestorePointListResult

A list of long term retention backups.

Name Type Description
nextLink

string

Link to retrieve next page of results.
value

RestorePoint[]

Array of results.

RestorePointType

The type of restore point

Name Type Description
CONTINUOUS

string

DISCRETE

string