Sql Pool Restore Points - Create

Creates a restore point for a data warehouse.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/restorePoints?api-version=2021-06-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

sqlPoolName
path True

string

SQL pool name

subscriptionId
path True

string

The ID of the target subscription.

workspaceName
path True

string

The name of the workspace.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Required Type Description
restorePointLabel True

string

The restore point label to apply

Responses

Name Type Description
200 OK

RestorePoint

Successfully created the restore point request.

201 Created

RestorePoint

Successfully created the restore point request.

202 Accepted

Accepted

Other Status Codes

*** Error Responses: ***

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

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

  • 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

Creates Sql pool restore point.

Sample request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints?api-version=2021-06-01

{
  "restorePointLabel": "mylabel"
}

Sample response

azure-asyncoperation: https://ms.web.azuresynapse.net
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131546477590000000",
  "name": "131546477590000000",
  "type": "Microsoft.Synapse/workspaces/sqlPools/restorePoints",
  "location": "japaneast",
  "properties": {
    "restorePointType": "DISCRETE",
    "restorePointCreationDate": "2017-03-10T08:00:00.000Z",
    "restorePointLabel": "mylabel"
  }
}
azure-asyncoperation: https://ms.web.azuresynapse.net
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131546477590000000",
  "name": "131546477590000000",
  "type": "Microsoft.Synapse/workspaces/sqlPools/restorePoints",
  "location": "japaneast",
  "properties": {
    "restorePointType": "DISCRETE",
    "restorePointCreationDate": "2017-03-10T08:00:00.000Z",
    "restorePointLabel": "mylabel"
  }
}
azure-asyncoperation: https://ms.web.azuresynapse.net

Definitions

Name Description
CreateSqlPoolRestorePointDefinition

Contains the information necessary to perform a create Sql pool restore point operation.

RestorePoint

Database restore points.

RestorePointType

The type of restore point

CreateSqlPoolRestorePointDefinition

Contains the information necessary to perform a create Sql pool restore point operation.

Name Type Description
restorePointLabel

string

The restore point label to apply

RestorePoint

Database restore points.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Resource location.

name

string

The name of the resource

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

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

RestorePointType

The type of restore point

Name Type Description
CONTINUOUS

string

DISCRETE

string