Restorable Dropped Databases - Azure SQL Database REST API Reference

This section provides details on how to manage restorable dropped databases using the Azure SQL Database REST API. You can list and retrieve information about databases that have been dropped but are still within their retention period and can be restored.

List Restorable Dropped Databases

This operation retrieves a list of restorable dropped databases for a specific SQL server.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/restorableDroppedDatabases

Parameters

Name Type Description Required
subscriptionId String The ID of the target subscription. Yes
resourceGroupName String The name of the resource group. The name is case insensitive. Yes
serverName String The name of the SQL server. Yes

Responses

Status Code Description Response Body
200 OK Successfully retrieved the list of restorable dropped databases. RestorableDroppedDatabaseListResult
404 Not Found The specified server or resource group was not found. {}
401 Unauthorized The request requires authentication. {}

Example Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/myServer/restorableDroppedDatabases?api-version=2020-02-01

Example Response (200 OK)


{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/myServer/restorableDroppedDatabases/myDroppedDatabase1",
      "name": "myDroppedDatabase1",
      "type": "Microsoft.Sql/servers/restorableDroppedDatabases",
      "location": "East US",
      "properties": {
        "creationDate": "2023-01-15T10:30:00Z",
        "deletionDate": "2023-02-15T09:00:00Z",
        "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/myServer/databases/myDatabase",
        "edition": "Standard",
        "maxSizeBytes": 268435456000,
        "requestedServiceObjectiveName": "S0",
        "environmentType": "Azure"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/myServer/restorableDroppedDatabases/myDroppedDatabase2",
      "name": "myDroppedDatabase2",
      "type": "Microsoft.Sql/servers/restorableDroppedDatabases",
      "location": "East US",
      "properties": {
        "creationDate": "2023-01-20T11:00:00Z",
        "deletionDate": "2023-02-20T10:00:00Z",
        "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/myServer/databases/anotherDatabase",
        "edition": "Premium",
        "maxSizeBytes": 536870912000,
        "requestedServiceObjectiveName": "P1",
        "environmentType": "Azure"
      }
    }
  ],
  "nextLink": null
}

Get Restorable Dropped Database

This operation retrieves a specific restorable dropped database for a given SQL server.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}

Parameters

Name Type Description Required
subscriptionId String The ID of the target subscription. Yes
resourceGroupName String The name of the resource group. The name is case insensitive. Yes
serverName String The name of the SQL server. Yes
restorableDroppedDatabaseId String The name of the restorable dropped database to retrieve. Yes

Responses

Status Code Description Response Body
200 OK Successfully retrieved the restorable dropped database details. RestorableDroppedDatabase
404 Not Found The specified resource group, server, or restorable dropped database was not found. {}
401 Unauthorized The request requires authentication. {}

Example Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/myServer/restorableDroppedDatabases/myDroppedDatabase1?api-version=2020-02-01

Example Response (200 OK)


{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/myServer/restorableDroppedDatabases/myDroppedDatabase1",
  "name": "myDroppedDatabase1",
  "type": "Microsoft.Sql/servers/restorableDroppedDatabases",
  "location": "East US",
  "properties": {
    "creationDate": "2023-01-15T10:30:00Z",
    "deletionDate": "2023-02-15T09:00:00Z",
    "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/myServer/databases/myDatabase",
    "edition": "Standard",
    "maxSizeBytes": 268435456000,
    "requestedServiceObjectiveName": "S0",
    "environmentType": "Azure"
  }
}

Restore Dropped Database

This operation restores a dropped database to its state at a specific point in time. This operation is asynchronous and returns a 202 Accepted response.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}/restore

Parameters

Name Type Description Required
subscriptionId String The ID of the target subscription. Yes
resourceGroupName String The name of the resource group. The name is case insensitive. Yes
serverName String The name of the SQL server. Yes
restorableDroppedDatabaseId String The name of the restorable dropped database to restore. Yes
api-version String The API version to use for the request. Yes

Request Body

The request body specifies the target database name and optional settings for the restore operation.


{
  "location": "East US",
  "properties": {
    "targetDatabaseName": "restoredDatabaseName",
    "edition": "Standard",
    "requestedServiceObjectiveName": "S0",
    "maxSizeBytes": 268435456000
  }
}

Responses

Status Code Description Response Body
202 Accepted The restore operation has been accepted and is being processed. Check the operation status for details. {}
404 Not Found The specified resource group, server, or restorable dropped database was not found. {}
400 Bad Request The request body is invalid or missing required parameters. {}
401 Unauthorized The request requires authentication. {}

Example Request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/myServer/restorableDroppedDatabases/myDroppedDatabase1/restore?api-version=2020-02-01


{
  "location": "East US",
  "properties": {
    "targetDatabaseName": "myRestoredDatabase",
    "edition": "Standard",
    "requestedServiceObjectiveName": "S0",
    "maxSizeBytes": 268435456000
  }
}

Related Topics