Managed Database Restore Details - Get

Service:: SQL Database

API Version:: 2025-01-01

Gets managed database restore details.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/restoreDetails/Default?api-version=2025-01-01

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
managedInstanceName	path	True	string	The name of the managed instance.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
restoreDetailsName	path	True	RestoreDetailsName	The name of the restore details to retrieve.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ManagedDatabaseRestoreDetailsResult	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Managed database restore details.

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/databases/testdb/restoreDetails/Default?api-version=2025-01-01

Sample response

Status code:: 200

{
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/databases/restoreDetails",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/databases/testdb/restoreDetails/current",
  "properties": {
    "type": "LRSRestore",
    "currentBackupType": "Log",
    "currentRestorePlanSizeMB": 47,
    "currentRestoredSizeMB": 25,
    "currentRestoringFileName": "RestoreDetailsFullBlownExampleLog10.bak",
    "diffBackupSets": [
      {
        "backupSizeMB": 0,
        "firstStripeName": "RestoreDetailsFullBlownExampleDiff2.bak",
        "numberOfStripes": 1,
        "status": "Skipped"
      },
      {
        "backupSizeMB": 1,
        "firstStripeName": "RestoreDetailsFullBlownExampleDiff3_1.bak",
        "numberOfStripes": 3,
        "restoreFinishedTimestampUtc": "2022-05-09T12:20:21.3667454Z",
        "restoreStartedTimestampUtc": "2022-05-09T12:19:40.5455092Z",
        "status": "Restored"
      }
    ],
    "fullBackupSets": [
      {
        "backupSizeMB": 2,
        "firstStripeName": "RestoreDetailsFullBlownExampleFull2.bak",
        "numberOfStripes": 1,
        "status": "Skipped"
      },
      {
        "backupSizeMB": 3,
        "firstStripeName": "RestoreDetailsFullBlownExampleFull3_1.bak",
        "numberOfStripes": 3,
        "restoreFinishedTimestampUtc": "2022-05-09T12:18:41.3785089Z",
        "restoreStartedTimestampUtc": "2022-05-09T12:15:40.3143263Z",
        "status": "Restored"
      }
    ],
    "lastRestoredFileName": "RestoreDetailsFullBlownExampleLog9_1.bak",
    "lastRestoredFileTime": "2022-05-09T12:27:20.4936305Z",
    "lastUploadedFileName": "RestoreDetailsFullBlownExampleLog11.bak",
    "lastUploadedFileTime": "2022-03-01T07:54:21Z",
    "logBackupSets": [
      {
        "backupSizeMB": 0,
        "firstStripeName": "RestoreDetailsFullBlownExampleLog2.bak",
        "numberOfStripes": 1,
        "status": "Skipped"
      },
      {
        "backupSizeMB": 8,
        "firstStripeName": "RestoreDetailsFullBlownExampleLog3.bak",
        "numberOfStripes": 1,
        "status": "Skipped"
      },
      {
        "backupSizeMB": 11,
        "firstStripeName": "RestoreDetailsFullBlownExampleLog4.bak",
        "numberOfStripes": 1,
        "status": "Skipped"
      },
      {
        "backupSizeMB": 7,
        "firstStripeName": "RestoreDetailsFullBlownExampleLog5.bak",
        "numberOfStripes": 1,
        "restoreFinishedTimestampUtc": "2022-05-09T12:21:54.7557851Z",
        "restoreStartedTimestampUtc": "2022-05-09T12:21:01.7717453Z",
        "status": "Restored"
      },
      {
        "backupSizeMB": 3,
        "firstStripeName": "RestoreDetailsFullBlownExampleLog6.bak",
        "numberOfStripes": 1,
        "restoreFinishedTimestampUtc": "2022-05-09T12:23:03.709407Z",
        "restoreStartedTimestampUtc": "2022-05-09T12:22:41.8784062Z",
        "status": "Restored"
      },
      {
        "backupSizeMB": 4,
        "firstStripeName": "RestoreDetailsFullBlownExampleLog7.bak",
        "numberOfStripes": 1,
        "restoreFinishedTimestampUtc": "2022-05-09T12:23:52.9274047Z",
        "restoreStartedTimestampUtc": "2022-05-09T12:23:36.6264066Z",
        "status": "Restored"
      },
      {
        "backupSizeMB": 3,
        "firstStripeName": "RestoreDetailsFullBlownExampleLog8.bak",
        "numberOfStripes": 1,
        "restoreFinishedTimestampUtc": "2022-05-09T12:24:37.9954063Z",
        "restoreStartedTimestampUtc": "2022-05-09T12:24:25.899407Z",
        "status": "Restored"
      },
      {
        "backupSizeMB": 4,
        "firstStripeName": "RestoreDetailsFullBlownExampleLog9_1.bak",
        "numberOfStripes": 4,
        "restoreFinishedTimestampUtc": "2022-05-09T12:25:27.808409Z",
        "restoreStartedTimestampUtc": "2022-05-09T12:25:10.8804065Z",
        "status": "Restored"
      },
      {
        "backupSizeMB": 15,
        "firstStripeName": "RestoreDetailsFullBlownExampleLog10.bak",
        "numberOfStripes": 1,
        "restoreStartedTimestampUtc": "2022-05-09T12:26:00.7813103Z",
        "status": "Restoring"
      },
      {
        "backupSizeMB": 7,
        "firstStripeName": "RestoreDetailsFullBlownExampleLog11.bak",
        "numberOfStripes": 1,
        "status": "Queued"
      }
    ],
    "numberOfFilesDetected": 25,
    "numberOfFilesQueued": 1,
    "numberOfFilesRestored": 14,
    "numberOfFilesRestoring": 1,
    "numberOfFilesSkipped": 8,
    "numberOfFilesUnrestorable": 1,
    "percentCompleted": 53,
    "status": "Restoring",
    "unrestorableFiles": [
      {
        "name": "ImageFile.JPG"
      }
    ]
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedDatabaseRestoreDetailsBackupSetProperties	The managed database's restore details backup set properties.
ManagedDatabaseRestoreDetailsResult	A managed database restore details.
ManagedDatabaseRestoreDetailsUnrestorableFileProperties	The managed database's restore details unrestorable file properties.
RestoreDetailsName
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ManagedDatabaseRestoreDetailsBackupSetProperties

Object

The managed database's restore details backup set properties.

Name	Type	Description
backupSizeMB	integer (int32)	Backup size.
firstStripeName	string	First stripe name.
numberOfStripes	integer (int32)	Number of stripes.
restoreFinishedTimestampUtc	string (date-time)	Last restored file time.
restoreStartedTimestampUtc	string (date-time)	Last restored file time.
status	string	Backup set status.

ManagedDatabaseRestoreDetailsResult

Object

A managed database restore details.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.blockReason	string	The reason why restore is in Blocked state.
properties.currentBackupType	string	Current backup type.
properties.currentRestorePlanSizeMB	integer (int32)	Current restore plan size MB.
properties.currentRestoredSizeMB	integer (int32)	Current restored size MB.
properties.currentRestoringFileName	string	Current restoring file name.
properties.diffBackupSets	ManagedDatabaseRestoreDetailsBackupSetProperties[]	Diff backup sets.
properties.fullBackupSets	ManagedDatabaseRestoreDetailsBackupSetProperties[]	Full backup sets.
properties.lastRestoredFileName	string	Last restored file name.
properties.lastRestoredFileTime	string (date-time)	Last restored file time.
properties.lastUploadedFileName	string	Last uploaded file name.
properties.lastUploadedFileTime	string (date-time)	Last uploaded file time.
properties.logBackupSets	ManagedDatabaseRestoreDetailsBackupSetProperties[]	Log backup sets.
properties.numberOfFilesDetected	integer (int32)	Number of files detected.
properties.numberOfFilesQueued	integer (int32)	Number of files queued.
properties.numberOfFilesRestored	integer (int32)	Number of files restored.
properties.numberOfFilesRestoring	integer (int32)	Number of files restoring.
properties.numberOfFilesSkipped	integer (int32)	Number of files skipped.
properties.numberOfFilesUnrestorable	integer (int32)	Number of files unrestorable.
properties.percentCompleted	integer (int32)	Percent completed.
properties.status	string	Restore status.
properties.type	string	Restore type.
properties.unrestorableFiles	ManagedDatabaseRestoreDetailsUnrestorableFileProperties[]	Unrestorable files.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ManagedDatabaseRestoreDetailsUnrestorableFileProperties

Object

The managed database's restore details unrestorable file properties.

Name	Type	Description
name	string	File name.

RestoreDetailsName

Enumeration

Value	Description
Default	Default

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Managed Database Restore Details - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Managed database restore details.

Sample request

Sample response

Definitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedDatabaseRestoreDetailsBackupSetProperties

ManagedDatabaseRestoreDetailsResult

ManagedDatabaseRestoreDetailsUnrestorableFileProperties

RestoreDetailsName

systemData