Swagger example/spec for Managed Database Restore Details V2022-02-01 API

specification/sql/resource-manager/Microsoft.Sql/preview/2022-02-01-preview/ManagedDatabaseRestoreDetails.json

@@ -62,7 +62,7 @@
             }
           },
           "default": {
-            "description": "*** Error Responses: ***\n\n * 400 AutoCompleteMissingLastBackupName - Auto complete restore request must have lastBackupName parameter provided.\n\n * 400 MissingThumbprint - Can not find server certificate.\n\n * 400 BlobStorageServerFailure - Blob storage server failure has occurred.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 FullBackupNotFound - Full backup can not be found.\n\n * 400 RestoreFromStripedBackupsNotEnabled - Restoring from striped backups is not supported.\n\n * 400 BrokenRestorePlanNoFullBackup - The restore plan is broken because there is no full backup.\n\n * 400 BrokenRestorePlanWrongLogBackupLSN - The restore plan is broken because firstLsn of current log backup is not <= lastLsn of next log backup.\n\n * 400 BrokenRestorePlanWrongDiffBackupLSN - The restore plan is broken because firstLsn of diff backup is not >= firstLsn of full backup.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 XtpInitializedDuringRestore - Memory-optimized filegroup must be empty in order to be restored on General Purpose tier of SQL Database Managed Instance.\n\n * 400 RetriableMissingThumbprint - Can not find server certificate.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 FullBackupDamaged - Provided full backup is damaged.\n\n * 400 MissingStripeInBackupSet - Provided backup set has one or more missing stripes.\n\n * 400 BackupsFromMultipleDatabasesDetectedInTheContainerWhileRestoreInProgress - There are backups from multiple databases in the container. Please make sure the container has backups from a single database.{0}\n\n * 400 BrokenRestorePlanWrongDiffBaseGUID - The restore plan is broken because DifferentialBaseGuid of diff backup does not match BackupSetGuid of full backup.\n\n * 400 PartiallyContainedDatabaseUnsupported - \"Backup for a partially contained database is not supported.\"\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 ManagedInstanceStorageLimitHit - The managed instance has reached its storage limit.\n\n * 400 IncompatiblePhysicalLayoutTooFewDataFiles - Database backup contains incompatible physical layout. No data files are found in the backup.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineLogFilesExist - Database backup contains incompatible physical layout. Non-online log files exist.\n\n * 400 IncompatiblePhysicalLayoutTooManyNonDataLogFiles - Database backup contains incompatible physical layout. Too many non-data/log files.\n\n * 400 ExternalBackupAlreadySignaledToComplete - The restore request has already been signaled to complete.\n\n * 400 ExternalBackupRestoreHasNotBeenStarted - The restore request can only be completed once the restore has started.\n\n * 400 ExternalBackupUpgradeInProgress - The restore request cannot be completed, since upgrade is in progress.\n\n * 400 IncompatiblePhysicalLayoutTooManyXTPFiles - Database backup contains incompatible physical layout. Multiple files found in the filegroup that contains MEMORY_OPTIMIZED_DATA.\n\n * 400 BlobStorageFailure - Blob storage failure has occurred.\n\n * 400 BackupsFromMultipleDatabasesDetectedInTheContainerFromTheStart - There are backups from multiple databases in the container. Please make sure the container has backups from a single database.{0}\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 ManagedDatabaseNotInRestoringState - Managed database is not in Restoring state."
+            "description": "*** Error Responses: ***\n\n * 400 AutoCompleteMissingLastBackupName - Auto complete restore request must have lastBackupName parameter provided.\n\n * 400 MissingThumbprint - Can not find server certificate.\n\n * 400 BlobStorageServerFailure - Blob storage server failure has occurred.\n\n * 400 BackupSetNotFound - No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 FullBackupNotFound - Full backup can not be found.\n\n * 400 RestoreFromStripedBackupsNotEnabled - Restoring from striped backups is not supported.\n\n * 400 BrokenRestorePlanNoFullBackup - The restore plan is broken because there is no full backup.\n\n * 400 BrokenRestorePlanWrongLogBackupLSN - The restore plan is broken because firstLsn of current log backup is not <= lastLsn of next log backup.\n\n * 400 BrokenRestorePlanWrongDiffBackupLSN - The restore plan is broken because firstLsn of diff backup is not >= firstLsn of full backup.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 TargetServerDoesNotExist - The target server {0} does not exist or is not ready yet. Please check that it exists and retry the restore request.\n\n * 400 TargetServerRestoreNotAllowed - The target server {0} is currently not in a state that allows a restore to be started.\n\n * 400 XtpInitializedDuringRestore - Memory-optimized filegroup must be empty in order to be restored on General Purpose tier of SQL Database Managed Instance.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 FullBackupDamaged - Provided full backup is damaged.\n\n * 400 MissingStripeInBackupSet - Provided backup set has one or more missing stripes.\n\n * 400 BackupsFromMultipleDatabasesDetectedInTheContainerWhileRestoreInProgress - There are backups from multiple databases in the container. Please make sure the container has backups from a single database.{0}\n\n * 400 BrokenRestorePlanWrongDiffBaseGUID - The restore plan is broken because DifferentialBaseGuid of diff backup does not match BackupSetGuid of full backup.\n\n * 400 ManagedIdentityIssueDetectedWhileRestoreInProgress - Managed identity is not set up properly. Please verify and try again.\n\n * 400 PartiallyContainedDatabaseUnsupported - \"Backup for a partially contained database is not supported.\"\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 ManagedInstanceStorageLimitHit - The managed instance has reached its storage limit.\n\n * 400 IncompatiblePhysicalLayoutTooFewDataFiles - Database backup contains incompatible physical layout. No data files are found in the backup.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineLogFilesExist - Database backup contains incompatible physical layout. Non-online log files exist.\n\n * 400 IncompatiblePhysicalLayoutTooManyNonDataLogFiles - Database backup contains incompatible physical layout. Too many non-data/log files.\n\n * 400 ExternalBackupAlreadySignaledToComplete - The restore request has already been signaled to complete.\n\n * 400 ExternalBackupRestoreHasNotBeenStarted - The restore request can only be completed once the restore has started.\n\n * 400 ExternalBackupUpgradeInProgress - The restore request cannot be completed, since upgrade is in progress.\n\n * 400 IncompatiblePhysicalLayoutTooManyXTPFiles - Database backup contains incompatible physical layout. Multiple files found in the filegroup that contains MEMORY_OPTIMIZED_DATA.\n\n * 400 BlobStorageFailure - Blob storage failure has occurred.\n\n * 400 BackupsFromMultipleDatabasesDetectedInTheContainerFromTheStart - There are backups from multiple databases in the container. Please make sure the container has backups from a single database.{0}\n\n * 400 ManagedIdentityIssueDetectedFromTheStart - Managed identity is not set up properly. Please verify and try again.\n\n * 400 BackupSetBroken - Backup set is broken.\n\n * 400 SqlRestoreError - Non retriable error occurred while restoring backup with index {0} - {1} {2}\n\n * 400 ManagedDatabaseNotInRestoringState - Managed database is not in Restoring state."
           }
         },
         "x-ms-examples": {
@@ -74,17 +74,73 @@
     }
   },
   "definitions": {
+    "ManagedDatabaseRestoreDetailsBackupSetProperties": {
+      "description": "The managed database's restore details backup set properties.",
+      "type": "object",
+      "properties": {
+        "status": {
+          "description": "Backup set status.",
+          "type": "string",
+          "readOnly": true
+        },
+        "firstStripeName": {
+          "description": "First stripe name.",
+          "type": "string",
+          "readOnly": true
+        },
+        "numberOfStripes": {
+          "format": "int32",
+          "description": "Number of stripes.",
+          "type": "integer",
+          "readOnly": true
+        },
+        "backupSizeMB": {
+          "format": "int32",
+          "description": "Backup size.",
+          "type": "integer",
+          "readOnly": true
+        },
+        "restoreStartedTimestampUtc": {
+          "format": "date-time",
+          "description": "Last restored file time.",
+          "type": "string",
+          "readOnly": true
+        },
+        "restoreFinishedTimestampUtc": {
+          "format": "date-time",
+          "description": "Last restored file time.",
+          "type": "string",
+          "readOnly": true
+        }
+      }
+    },
     "ManagedDatabaseRestoreDetailsProperties": {
       "description": "The managed database's restore details properties.",
       "type": "object",
       "properties": {
+        "type": {
+          "description": "Restore type.",
+          "type": "string",
+          "readOnly": true
+        },
         "status": {
           "description": "Restore status.",
           "type": "string",
           "readOnly": true
         },
-        "currentRestoringFileName": {
-          "description": "Current restoring file name.",
+        "blockReason": {
+          "description": "The reason why restore is in Blocked state.",
+          "type": "string",
+          "readOnly": true
+        },
+        "lastUploadedFileName": {
+          "description": "Last uploaded file name.",
+          "type": "string",
+          "readOnly": true
+        },
+        "lastUploadedFileTime": {
+          "format": "date-time",
+          "description": "Last uploaded file time.",
           "type": "string",
           "readOnly": true
         },
@@ -100,40 +156,104 @@
           "readOnly": true
         },
         "percentCompleted": {
-          "format": "double",
+          "format": "int32",
           "description": "Percent completed.",
-          "type": "number",
+          "type": "integer",
           "readOnly": true
         },
-        "unrestorableFiles": {
-          "description": "List of unrestorable files.",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
+        "currentRestoredSizeMB": {
+          "format": "int32",
+          "description": "Current restored size MB.",
+          "type": "integer",
           "readOnly": true
         },
-        "numberOfFilesDetected": {
-          "format": "int64",
-          "description": "Number of files detected.",
+        "currentRestorePlanSizeMB": {
+          "format": "int32",
+          "description": "Current restore plan size MB.",
           "type": "integer",
           "readOnly": true
         },
-        "lastUploadedFileName": {
-          "description": "Last uploaded file name.",
+        "currentBackupType": {
+          "description": "Current backup type.",
           "type": "string",
           "readOnly": true
         },
-        "lastUploadedFileTime": {
-          "format": "date-time",
-          "description": "Last uploaded file time.",
+        "currentRestoringFileName": {
+          "description": "Current restoring file name.",
           "type": "string",
           "readOnly": true
         },
-        "blockReason": {
-          "description": "The reason why restore is in Blocked state.",
-          "type": "string",
+        "numberOfFilesDetected": {
+          "format": "int32",
+          "description": "Number of files detected.",
+          "type": "integer",
+          "readOnly": true
+        },
+        "numberOfFilesQueued": {
+          "format": "int32",
+          "description": "Number of files queued.",
+          "type": "integer",
+          "readOnly": true
+        },
+        "numberOfFilesSkipped": {
+          "format": "int32",
+          "description": "Number of files skipped.",
+          "type": "integer",
+          "readOnly": true
+        },
+        "numberOfFilesRestoring": {
+          "format": "int32",
+          "description": "Number of files restoring.",
+          "type": "integer",
+          "readOnly": true
+        },
+        "numberOfFilesRestored": {
+          "format": "int32",
+          "description": "Number of files restored.",
+          "type": "integer",
+          "readOnly": true
+        },
+        "numberOfFilesUnrestorable": {
+          "format": "int32",
+          "description": "Number of files unrestorable.",
+          "type": "integer",
           "readOnly": true
+        },
+        "fullBackupSets": {
+          "description": "Full backup sets.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ManagedDatabaseRestoreDetailsBackupSetProperties"
+          },
+          "readOnly": true,
+          "x-ms-identifiers": []
+        },
+        "diffBackupSets": {
+          "description": "Diff backup sets.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ManagedDatabaseRestoreDetailsBackupSetProperties"
+          },
+          "readOnly": true,
+          "x-ms-identifiers": []
+        },
+        "logBackupSets": {
+          "description": "Log backup sets.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ManagedDatabaseRestoreDetailsBackupSetProperties"
+          },
+          "readOnly": true,
+          "x-ms-identifiers": []
+        },
+        "unrestorableFiles": {
+          "description": "Unrestorable files.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ManagedDatabaseRestoreDetailsUnrestorableFileProperties"
+          },
+          "readOnly": true,
+          "x-ms-identifiers": []
         }
       }
     },
@@ -152,6 +272,17 @@
           "x-ms-client-flatten": true
         }
       }
+    },
+    "ManagedDatabaseRestoreDetailsUnrestorableFileProperties": {
+      "description": "The managed database's restore details unrestorable file properties.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "File name.",
+          "type": "string",
+          "readOnly": true
+        }
+      }
     }
   },
   "parameters": {