Package-level declarations

Types

Link copied to clipboard
data class AzureActiveDirectoryAppResponse(val appKey: String, val applicationId: String, val tenantId: String)

Azure Active Directory Application

Link copied to clipboard
data class BackupFileInfoResponse(val familySequenceNumber: Int? = null, val fileLocation: String? = null, val status: String? = null)

Information of the backup file

Link copied to clipboard
data class BackupSetInfoResponse(val backupFinishedDate: String? = null, val backupSetId: String? = null, val backupStartDate: String? = null, val backupType: String? = null, val databaseName: String? = null, val firstLsn: String? = null, val isBackupRestored: Boolean? = null, val lastLsn: String? = null, val lastModifiedTime: String? = null, val listOfBackupFiles: List<BackupFileInfoResponse>? = null)

Information of backup set

Link copied to clipboard
data class BlobShareResponse(val sasUri: String)

Blob container storage information.

Input for the task that validates connection to PostgreSQL and source server requirements

data class ConnectToSourcePostgreSqlSyncTaskOutputResponse(val databases: List<String>, val id: String, val sourceServerBrandVersion: String, val sourceServerVersion: String, val validationErrors: List<ReportableExceptionResponse>)

Output for the task that validates connection to PostgreSQL and source server requirements

Properties for the task that validates connection to PostgreSQL server and source server requirements for online migration

Properties for the task that validates connection to SQL Server and source server requirements for online migration

data class ConnectToSourceSqlServerTaskInputResponse(val checkPermissionsGroup: String? = null, val collectAgentJobs: Boolean? = null, val collectLogins: Boolean? = null, val sourceConnectionInfo: SqlConnectionInfoResponse)

Input for the task that validates connection to SQL Server and also validates source server requirements

data class ConnectToSourceSqlServerTaskOutputAgentJobLevelResponse(val id: String, val isEnabled: Boolean, val jobCategory: String, val jobOwner: String, val lastExecutedOn: String, val migrationEligibility: MigrationEligibilityInfoResponse, val name: String, val resultType: String)

AgentJob level output for the task that validates connection to SQL Server and also validates source server requirements

data class ConnectToSourceSqlServerTaskOutputDatabaseLevelResponse(val compatibilityLevel: String, val databaseFiles: List<DatabaseFileInfoResponse>, val databaseState: String, val id: String, val name: String, val resultType: String, val sizeMB: Double)

Database level output for the task that validates connection to SQL Server and also validates source server requirements

data class ConnectToSourceSqlServerTaskOutputLoginLevelResponse(val defaultDatabase: String, val id: String, val isEnabled: Boolean, val loginType: String, val migrationEligibility: MigrationEligibilityInfoResponse, val name: String, val resultType: String)

Login level output for the task that validates connection to SQL Server and also validates source server requirements

data class ConnectToSourceSqlServerTaskOutputTaskLevelResponse(val agentJobs: Map<String, String>, val databases: Map<String, String>, val id: String, val logins: Map<String, String>, val resultType: String, val sourceServerBrandVersion: String, val sourceServerVersion: String, val validationErrors: List<ReportableExceptionResponse>)

Task level output for the task that validates connection to SQL Server and also validates source server requirements

Properties for the task that validates connection to SQL Server and also validates source server requirements

Input for the task that validates connection to Azure Database for MySQL and target server requirements

data class ConnectToTargetAzureDbForMySqlTaskOutputResponse(val databases: List<String>, val id: String, val serverVersion: String, val targetServerBrandVersion: String, val validationErrors: List<ReportableExceptionResponse>)

Output for the task that validates connection to Azure Database for MySQL and target server requirements

Properties for the task that validates connection to Azure Database for MySQL and target server requirements

Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements

data class ConnectToTargetAzureDbForPostgreSqlSyncTaskOutputResponse(val databases: List<String>, val id: String, val targetServerBrandVersion: String, val targetServerVersion: String, val validationErrors: List<ReportableExceptionResponse>)

Output for the task that validates connection to Azure Database for PostgreSQL and target server requirements

Properties for the task that validates connection to Azure Database For PostgreSQL server and target server requirements for online migration

Link copied to clipboard

Input for the task that validates connection to SQL DB and target server requirements

Link copied to clipboard
data class ConnectToTargetSqlDbTaskOutputResponse(val databases: Map<String, String>, val id: String, val targetServerBrandVersion: String, val targetServerVersion: String)

Output for the task that validates connection to SQL DB and target server requirements

Properties for the task that validates connection to SQL DB and target server requirements

Input for the task that validates connection to Azure SQL Database Managed Instance online scenario.

data class ConnectToTargetSqlMISyncTaskOutputResponse(val targetServerBrandVersion: String, val targetServerVersion: String, val validationErrors: List<ReportableExceptionResponse>)

Output for the task that validates connection to Azure SQL Database Managed Instance.

Properties for the task that validates connection to Azure SQL Database Managed Instance

Link copied to clipboard

Input for the task that validates connection to Azure SQL Database Managed Instance.

Link copied to clipboard
data class ConnectToTargetSqlMITaskOutputResponse(val agentJobs: List<String>, val id: String, val logins: List<String>, val targetServerBrandVersion: String, val targetServerVersion: String, val validationErrors: List<ReportableExceptionResponse>)

Output for the task that validates connection to Azure SQL Database Managed Instance.

Properties for the task that validates connection to Azure SQL Database Managed Instance

data class ConnectToTargetSqlSqlDbSyncTaskInputResponse(val sourceConnectionInfo: SqlConnectionInfoResponse, val targetConnectionInfo: SqlConnectionInfoResponse)

Input for the task that validates connection to Azure SQL DB and target server requirements

Properties for the task that validates connection to SQL DB and target server requirements for online migration

Link copied to clipboard
data class CopyProgressDetailsResponse(val copyDuration: Int, val copyStart: String, val copyThroughput: Double, val dataRead: Double, val dataWritten: Double, val parallelCopyType: String, val rowsCopied: Double, val rowsRead: Double, val status: String, val tableName: String, val usedParallelCopies: Int)

Details on progress of ADF copy activity

Link copied to clipboard
data class DatabaseBackupInfoResponse(val backupFiles: List<String>, val backupFinishDate: String, val backupType: String, val databaseName: String, val familyCount: Int, val isCompressed: Boolean, val isDamaged: Boolean, val position: Int)

Information about backup files when existing backup mode is used.

Link copied to clipboard
data class DatabaseFileInfoResponse(val databaseName: String? = null, val fileType: String? = null, val id: String? = null, val logicalName: String? = null, val physicalFullName: String? = null, val restoreFullName: String? = null, val sizeMB: Double? = null)

Database file specific information

Link copied to clipboard
data class DatabaseInfoResponse(val sourceDatabaseName: String)

Project Database Details

Link copied to clipboard
data class DatabaseMigrationPropertiesSqlDbResponse(val endedOn: String, val kind: String, val migrationFailureError: ErrorInfoResponse, val migrationOperationId: String? = null, val migrationService: String? = null, val migrationStatus: String, val migrationStatusDetails: SqlDbMigrationStatusDetailsResponse, val offlineConfiguration: SqlDbOfflineConfigurationResponse, val provisioningError: String? = null, val provisioningState: String, val scope: String? = null, val sourceDatabaseName: String? = null, val sourceServerName: String, val sourceSqlConnection: SqlConnectionInformationResponse? = null, val startedOn: String, val tableList: List<String>? = null, val targetDatabaseCollation: String? = null, val targetSqlConnection: SqlConnectionInformationResponse? = null)

Database Migration Resource properties for SQL database.

Link copied to clipboard
data class DatabaseSummaryResultResponse(val endedOn: String, val errorPrefix: String, val itemsCompletedCount: Double, val itemsCount: Double, val name: String, val resultPrefix: String, val sizeMB: Double, val startedOn: String, val state: String, val statusMessage: String)

Summary of database results in the migration

Link copied to clipboard
data class DatabaseTableResponse(val hasRows: Boolean, val name: String)

Table properties

Link copied to clipboard
data class DataIntegrityValidationResultResponse(val failedObjects: Map<String, String>, val validationErrors: ValidationErrorResponse)

Results for checksum based Data Integrity validation results

Link copied to clipboard
data class DataItemMigrationSummaryResultResponse(val endedOn: String, val errorPrefix: String, val itemsCompletedCount: Double, val itemsCount: Double, val name: String, val resultPrefix: String, val startedOn: String, val state: String, val statusMessage: String)

Basic summary of a data item migration

Link copied to clipboard
data class ErrorInfoResponse(val code: String, val message: String)

Error details

Link copied to clipboard
data class ExecutionStatisticsResponse(val cpuTimeMs: Double, val elapsedTimeMs: Double, val executionCount: Double, val hasErrors: Boolean, val sqlErrors: List<String>, val waitStats: Map<String, WaitStatisticsResponse>? = null)

Description about the errors happen while performing migration validation

Link copied to clipboard
data class FileShareResponse(val password: String? = null, val path: String, val userName: String? = null)

File share information with Path, Username, and Password.

Link copied to clipboard
data class GetDatabaseMigrationsSqlDbResult(val id: String, val name: String, val properties: DatabaseMigrationPropertiesSqlDbResponse, val systemData: SystemDataResponse, val type: String)

Database Migration Resource for SQL Database.

Link copied to clipboard
data class GetFileResult(val etag: String? = null, val id: String, val name: String, val properties: ProjectFilePropertiesResponse, val type: String)

A file resource

Link copied to clipboard
data class GetProjectResult(val creationTime: String, val databasesInfo: List<DatabaseInfoResponse>? = null, val id: String, val location: String, val name: String, val provisioningState: String, val sourceConnectionInfo: Any? = null, val sourcePlatform: String, val tags: Map<String, String>? = null, val targetConnectionInfo: Any? = null, val targetPlatform: String, val type: String)

A project resource

Link copied to clipboard
data class GetServiceResult(val etag: String? = null, val id: String, val kind: String? = null, val location: String, val name: String, val provisioningState: String, val publicKey: String? = null, val sku: ServiceSkuResponse? = null, val tags: Map<String, String>? = null, val type: String, val virtualSubnetId: String)

A Database Migration Service resource

Link copied to clipboard
data class GetSqlMigrationServiceResult(val id: String, val integrationRuntimeState: String, val location: String? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

A SQL Migration Service.

Link copied to clipboard
data class GetTaskResult(val etag: String? = null, val id: String, val name: String, val properties: Any, val type: String)

A task resource

Link copied to clipboard
data class GetTdeCertificatesSqlTaskInputResponse(val backupFileShare: FileShareResponse, val connectionInfo: SqlConnectionInfoResponse, val selectedCertificates: List<SelectedCertificateInputResponse>)

Input for the task that gets TDE certificates in Base64 encoded format.

Link copied to clipboard
data class GetTdeCertificatesSqlTaskOutputResponse(val base64EncodedCertificates: Map<String, List<String>>, val validationErrors: List<ReportableExceptionResponse>)

Output of the task that gets TDE certificates in Base64 encoded format.

Properties for the task that gets TDE certificates in Base64 encoded format.

Link copied to clipboard
data class GetUserTablesSqlSyncTaskInputResponse(val selectedSourceDatabases: List<String>, val selectedTargetDatabases: List<String>, val sourceConnectionInfo: SqlConnectionInfoResponse, val targetConnectionInfo: SqlConnectionInfoResponse)

Input for the task that collects user tables for the given list of databases

Link copied to clipboard
data class GetUserTablesSqlSyncTaskOutputResponse(val databasesToSourceTables: Map<String, List<DatabaseTableResponse>>, val databasesToTargetTables: Map<String, List<DatabaseTableResponse>>, val tableValidationErrors: Map<String, List<String>>, val validationErrors: List<ReportableExceptionResponse>)

Output of the task that collects user tables for the given list of databases

Properties for the task that collects user tables for the given list of databases

Link copied to clipboard
data class GetUserTablesSqlTaskInputResponse(val connectionInfo: SqlConnectionInfoResponse, val selectedDatabases: List<String>)

Input for the task that collects user tables for the given list of databases

Link copied to clipboard
data class GetUserTablesSqlTaskOutputResponse(val databasesToTables: Map<String, List<DatabaseTableResponse>>, val id: String, val validationErrors: List<ReportableExceptionResponse>)

Output of the task that collects user tables for the given list of databases

Link copied to clipboard

Properties for the task that collects user tables for the given list of databases

Link copied to clipboard
data class ListSqlMigrationServiceAuthKeysResult(val authKey1: String? = null, val authKey2: String? = null)

An authentication key.

Integration Runtime Monitoring Data.

data class MigrateMISyncCompleteCommandInputResponse(val sourceDatabaseName: String)

Input for command that completes online migration for an Azure SQL Database Managed Instance.

Output for command that completes online migration for an Azure SQL Database Managed Instance.

Properties for the command that completes online migration for an Azure SQL Database Managed Instance.

data class MigrateMySqlAzureDbForMySqlSyncDatabaseInputResponse(val migrationSetting: Map<String, String>? = null, val name: String? = null, val sourceSetting: Map<String, String>? = null, val targetDatabaseName: String? = null, val targetSetting: Map<String, String>? = null)

Database specific information for MySQL to Azure Database for MySQL migration task inputs

Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations

data class MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevelResponse(val appliedChanges: Double, val cdcDeleteCounter: Double, val cdcInsertCounter: Double, val cdcUpdateCounter: Double, val databaseName: String, val endedOn: String, val fullLoadCompletedTables: Double, val fullLoadErroredTables: Double, val fullLoadLoadingTables: Double, val fullLoadQueuedTables: Double, val id: String, val incomingChanges: Double, val initializationCompleted: Boolean, val latency: Double, val migrationState: String, val resultType: String, val startedOn: String)
data class MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevelResponse(val endedOn: String, val id: String, val resultType: String, val sourceServer: String, val sourceServerVersion: String, val startedOn: String, val targetServer: String, val targetServerVersion: String)
data class MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevelResponse(val cdcDeleteCounter: String, val cdcInsertCounter: String, val cdcUpdateCounter: String, val dataErrorsCounter: Double, val databaseName: String, val fullLoadEndedOn: String, val fullLoadEstFinishTime: String, val fullLoadStartedOn: String, val fullLoadTotalRows: Double, val id: String, val lastModifiedTime: String, val resultType: String, val state: String, val tableName: String, val totalChangesApplied: Double)

Properties for the task that migrates MySQL databases to Azure Database for MySQL for online migrations

data class MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputResponse(val migrationSetting: Map<String, String>? = null, val name: String? = null, val sourceSetting: Map<String, String>? = null, val targetDatabaseName: String? = null, val targetSetting: Map<String, String>? = null)

Database specific information for PostgreSQL to Azure Database for PostgreSQL migration task inputs

Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations

data class MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevelResponse(val appliedChanges: Double, val cdcDeleteCounter: Double, val cdcInsertCounter: Double, val cdcUpdateCounter: Double, val databaseName: String, val endedOn: String, val fullLoadCompletedTables: Double, val fullLoadErroredTables: Double, val fullLoadLoadingTables: Double, val fullLoadQueuedTables: Double, val id: String, val incomingChanges: Double, val initializationCompleted: Boolean, val latency: Double, val migrationState: String, val resultType: String, val startedOn: String)
data class MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevelResponse(val endedOn: String, val id: String, val resultType: String, val sourceServer: String, val sourceServerVersion: String, val startedOn: String, val targetServer: String, val targetServerVersion: String)
data class MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevelResponse(val cdcDeleteCounter: Double, val cdcInsertCounter: Double, val cdcUpdateCounter: Double, val dataErrorsCounter: Double, val databaseName: String, val fullLoadEndedOn: String, val fullLoadEstFinishTime: String, val fullLoadStartedOn: String, val fullLoadTotalRows: Double, val id: String, val lastModifiedTime: String, val resultType: String, val state: String, val tableName: String, val totalChangesApplied: Double)

Properties for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations

data class MigrateSqlServerSqlDbDatabaseInputResponse(val makeSourceDbReadOnly: Boolean? = null, val name: String? = null, val tableMap: Map<String, String>? = null, val targetDatabaseName: String? = null)

Database specific information for SQL to Azure SQL DB migration task inputs

data class MigrateSqlServerSqlDbSyncDatabaseInputResponse(val id: String? = null, val migrationSetting: Map<String, String>? = null, val name: String? = null, val schemaName: String? = null, val sourceSetting: Map<String, String>? = null, val tableMap: Map<String, String>? = null, val targetDatabaseName: String? = null, val targetSetting: Map<String, String>? = null)

Database specific information for SQL to Azure SQL DB sync migration task inputs

data class MigrateSqlServerSqlDbSyncTaskInputResponse(val selectedDatabases: List<MigrateSqlServerSqlDbSyncDatabaseInputResponse>, val sourceConnectionInfo: SqlConnectionInfoResponse, val targetConnectionInfo: SqlConnectionInfoResponse, val validationOptions: MigrationValidationOptionsResponse? = null)

Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations

data class MigrateSqlServerSqlDbSyncTaskOutputDatabaseErrorResponse(val errorMessage: String? = null, val events: List<SyncMigrationDatabaseErrorEventResponse>? = null, val id: String, val resultType: String)
data class MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevelResponse(val appliedChanges: Double, val cdcDeleteCounter: Double, val cdcInsertCounter: Double, val cdcUpdateCounter: Double, val databaseName: String, val endedOn: String, val fullLoadCompletedTables: Double, val fullLoadErroredTables: Double, val fullLoadLoadingTables: Double, val fullLoadQueuedTables: Double, val id: String, val incomingChanges: Double, val initializationCompleted: Boolean, val latency: Double, val migrationState: String, val resultType: String, val startedOn: String)
data class MigrateSqlServerSqlDbSyncTaskOutputMigrationLevelResponse(val databaseCount: Int, val endedOn: String, val id: String, val resultType: String, val sourceServer: String, val sourceServerVersion: String, val startedOn: String, val targetServer: String, val targetServerVersion: String)
data class MigrateSqlServerSqlDbSyncTaskOutputTableLevelResponse(val cdcDeleteCounter: Double, val cdcInsertCounter: Double, val cdcUpdateCounter: Double, val dataErrorsCounter: Double, val databaseName: String, val fullLoadEndedOn: String, val fullLoadEstFinishTime: String, val fullLoadStartedOn: String, val fullLoadTotalRows: Double, val id: String, val lastModifiedTime: String, val resultType: String, val state: String, val tableName: String, val totalChangesApplied: Double)

Properties for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations

Link copied to clipboard
data class MigrateSqlServerSqlDbTaskInputResponse(val selectedDatabases: List<MigrateSqlServerSqlDbDatabaseInputResponse>, val sourceConnectionInfo: SqlConnectionInfoResponse, val targetConnectionInfo: SqlConnectionInfoResponse, val validationOptions: MigrationValidationOptionsResponse? = null)

Input for the task that migrates on-prem SQL Server databases to Azure SQL Database

data class MigrateSqlServerSqlDbTaskOutputDatabaseLevelResponse(val databaseName: String, val endedOn: String, val errorCount: Double, val errorPrefix: String, val exceptionsAndWarnings: List<ReportableExceptionResponse>, val id: String, val message: String, val numberOfObjects: Double, val numberOfObjectsCompleted: Double, val objectSummary: Map<String, DataItemMigrationSummaryResultResponse>, val resultPrefix: String, val resultType: String, val stage: String, val startedOn: String, val state: String, val statusMessage: String)

Database level result for Sql Server to Azure Sql DB migration.

data class MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResultResponse(val dataIntegrityValidationResult: DataIntegrityValidationResultResponse, val endedOn: String, val id: String, val migrationId: String, val queryAnalysisValidationResult: QueryAnalysisValidationResultResponse, val resultType: String, val schemaValidationResult: SchemaComparisonValidationResultResponse, val sourceDatabaseName: String, val startedOn: String, val status: String, val targetDatabaseName: String)

Database validation result for Sql Server to Azure Sql DB migration.

Task errors for Sql Server to Azure Sql DB migration.

data class MigrateSqlServerSqlDbTaskOutputMigrationLevelResponse(val databaseSummary: Map<String, DatabaseSummaryResultResponse>, val databases: Map<String, String>, val durationInSeconds: Double, val endedOn: String, val exceptionsAndWarnings: List<ReportableExceptionResponse>, val id: String, val message: String, val migrationReport: MigrationReportResultResponse, val resultType: String, val sourceServerBrandVersion: String, val sourceServerVersion: String, val startedOn: String, val status: String, val statusMessage: String, val targetServerBrandVersion: String, val targetServerVersion: String)

Migration level result for Sql server to Azure Sql DB migration.

data class MigrateSqlServerSqlDbTaskOutputTableLevelResponse(val endedOn: String, val errorPrefix: String, val id: String, val itemsCompletedCount: Double, val itemsCount: Double, val objectName: String, val resultPrefix: String, val resultType: String, val startedOn: String, val state: String, val statusMessage: String)

Table level result for Sql Server to Azure Sql DB migration.

data class MigrateSqlServerSqlDbTaskOutputValidationResultResponse(val id: String, val migrationId: String, val resultType: String, val status: String, val summaryResults: Map<String, MigrationValidationDatabaseSummaryResultResponse>? = null)

Validation result for Sql Server to Azure Sql DB migration.

Properties for the task that migrates on-prem SQL Server databases to Azure SQL Database

data class MigrateSqlServerSqlMIDatabaseInputResponse(val backupFilePaths: List<String>? = null, val backupFileShare: FileShareResponse? = null, val name: String, val restoreDatabaseName: String)

Database specific information for SQL to Azure SQL DB Managed Instance migration task inputs

data class MigrateSqlServerSqlMISyncTaskInputResponse(val azureApp: AzureActiveDirectoryAppResponse, val backupFileShare: FileShareResponse? = null, val selectedDatabases: List<MigrateSqlServerSqlMIDatabaseInputResponse>, val sourceConnectionInfo: SqlConnectionInfoResponse, val storageResourceId: String, val targetConnectionInfo: MiSqlConnectionInfoResponse)

Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario.

data class MigrateSqlServerSqlMISyncTaskOutputDatabaseLevelResponse(val activeBackupSets: List<BackupSetInfoResponse>, val containerName: String, val endedOn: String, val errorPrefix: String, val exceptionsAndWarnings: List<ReportableExceptionResponse>, val fullBackupSetInfo: BackupSetInfoResponse, val id: String, val isFullBackupRestored: Boolean, val lastRestoredBackupSetInfo: BackupSetInfoResponse, val migrationState: String, val resultType: String, val sourceDatabaseName: String, val startedOn: String)
data class MigrateSqlServerSqlMISyncTaskOutputMigrationLevelResponse(val databaseCount: Int, val databaseErrorCount: Int, val endedOn: String, val id: String, val resultType: String, val sourceServerBrandVersion: String, val sourceServerName: String, val sourceServerVersion: String, val startedOn: String, val state: String, val targetServerBrandVersion: String, val targetServerName: String, val targetServerVersion: String)

Properties for task that migrates SQL Server databases to Azure SQL Database Managed Instance sync scenario

Link copied to clipboard
data class MigrateSqlServerSqlMITaskInputResponse(val backupBlobShare: BlobShareResponse, val backupFileShare: FileShareResponse? = null, val backupMode: String? = null, val selectedAgentJobs: List<String>? = null, val selectedDatabases: List<MigrateSqlServerSqlMIDatabaseInputResponse>, val selectedLogins: List<String>? = null, val sourceConnectionInfo: SqlConnectionInfoResponse, val targetConnectionInfo: SqlConnectionInfoResponse)

Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance.

data class MigrateSqlServerSqlMITaskOutputAgentJobLevelResponse(val endedOn: String, val exceptionsAndWarnings: List<ReportableExceptionResponse>, val id: String, val isEnabled: Boolean, val message: String, val name: String, val resultType: String, val startedOn: String, val state: String)
data class MigrateSqlServerSqlMITaskOutputDatabaseLevelResponse(val databaseName: String, val endedOn: String, val exceptionsAndWarnings: List<ReportableExceptionResponse>, val id: String, val message: String, val resultType: String, val sizeMB: Double, val stage: String, val startedOn: String, val state: String)
data class MigrateSqlServerSqlMITaskOutputLoginLevelResponse(val endedOn: String, val exceptionsAndWarnings: List<ReportableExceptionResponse>, val id: String, val loginName: String, val message: String, val resultType: String, val stage: String, val startedOn: String, val state: String)
data class MigrateSqlServerSqlMITaskOutputMigrationLevelResponse(val agentJobs: Map<String, String>, val databases: Map<String, String>, val endedOn: String, val exceptionsAndWarnings: List<ReportableExceptionResponse>, val id: String, val logins: Map<String, String>, val message: String, val orphanedUsersInfo: List<OrphanedUserInfoResponse>, val resultType: String, val serverRoleResults: Map<String, StartMigrationScenarioServerRoleResultResponse>, val sourceServerBrandVersion: String, val sourceServerVersion: String, val startedOn: String, val state: String, val status: String, val targetServerBrandVersion: String, val targetServerVersion: String)

Properties for task that migrates SQL Server databases to Azure SQL Database Managed Instance

Link copied to clipboard
data class MigrateSyncCompleteCommandInputResponse(val commitTimeStamp: String? = null, val databaseName: String)

Input for command that completes sync migration for a database.

Link copied to clipboard

Output for command that completes sync migration for a database.

Properties for the command that completes sync migration for a database.

Link copied to clipboard
data class MigrationEligibilityInfoResponse(val isEligibleForMigration: Boolean, val validationMessages: List<String>)

Information about migration eligibility of a server object

Link copied to clipboard
data class MigrationReportResultResponse(val id: String, val reportUrl: String)

Migration validation report result, contains the url for downloading the generated report.

data class MigrationValidationDatabaseSummaryResultResponse(val endedOn: String, val id: String, val migrationId: String, val sourceDatabaseName: String, val startedOn: String, val status: String, val targetDatabaseName: String)

Migration Validation Database level summary result

Link copied to clipboard
data class MigrationValidationOptionsResponse(val enableDataIntegrityValidation: Boolean? = null, val enableQueryAnalysisValidation: Boolean? = null, val enableSchemaValidation: Boolean? = null)

Types of validations to run after the migration

Link copied to clipboard
data class MiSqlConnectionInfoResponse(val managedInstanceResourceId: String, val password: String? = null, val type: String, val userName: String? = null)

Properties required to create a connection to Azure SQL database Managed instance

Link copied to clipboard
data class MySqlConnectionInfoResponse(val password: String? = null, val port: Int, val serverName: String, val type: String, val userName: String? = null)

Information for connecting to MySQL server

Link copied to clipboard
data class NodeMonitoringDataResponse(val additionalProperties: Map<String, Any>, val availableMemoryInMB: Int, val concurrentJobsLimit: Int, val concurrentJobsRunning: Int, val cpuUtilization: Int, val maxConcurrentJobs: Int, val nodeName: String, val receivedBytes: Double, val sentBytes: Double)
Link copied to clipboard
data class ODataErrorResponse(val code: String, val details: List<ODataErrorResponse>, val message: String)

Error information in OData format.

Link copied to clipboard
data class OrphanedUserInfoResponse(val databaseName: String? = null, val name: String? = null)

Information of orphaned users on the SQL server database.

Link copied to clipboard
data class PostgreSqlConnectionInfoResponse(val databaseName: String? = null, val password: String? = null, val port: Int, val serverName: String, val type: String, val userName: String? = null)

Information for connecting to PostgreSQL server

Link copied to clipboard
data class ProjectFilePropertiesResponse(val extension: String? = null, val filePath: String? = null, val lastModified: String, val mediaType: String? = null, val size: Double)

Base class for file properties.

Link copied to clipboard

Results for query analysis comparison between the source and target

Link copied to clipboard
data class QueryExecutionResultResponse(val queryText: String, val sourceResult: ExecutionStatisticsResponse, val statementsInBatch: Double, val targetResult: ExecutionStatisticsResponse)

Describes query analysis results for execution in source and target

Link copied to clipboard
data class ReportableExceptionResponse(val actionableMessage: String? = null, val filePath: String, val hResult: Int, val lineNumber: String, val message: String, val stackTrace: String)

Exception object for all custom exceptions

Link copied to clipboard
data class SchemaComparisonValidationResultResponse(val schemaDifferences: SchemaComparisonValidationResultTypeResponse, val sourceDatabaseObjectCount: Map<String, Double>? = null, val targetDatabaseObjectCount: Map<String, Double>? = null, val validationErrors: ValidationErrorResponse)

Results for schema comparison between the source and target

data class SchemaComparisonValidationResultTypeResponse(val objectName: String, val objectType: String, val updateAction: String)

Description about the errors happen while performing migration validation

Link copied to clipboard
data class SelectedCertificateInputResponse(val certificateName: String, val password: String)

Info for certificate to be exported for TDE enabled databases.

Link copied to clipboard
data class ServiceSkuResponse(val capacity: Int? = null, val family: String? = null, val name: String? = null, val size: String? = null, val tier: String? = null)

An Azure SKU instance

Link copied to clipboard
data class SqlConnectionInfoResponse(val additionalSettings: String? = null, val authentication: String? = null, val dataSource: String, val encryptConnection: Boolean? = null, val password: String? = null, val platform: String? = null, val trustServerCertificate: Boolean? = null, val type: String, val userName: String? = null)

Information for connecting to SQL database server

Link copied to clipboard
data class SqlConnectionInformationResponse(val authentication: String? = null, val dataSource: String? = null, val encryptConnection: Boolean? = null, val password: String? = null, val trustServerCertificate: Boolean? = null, val userName: String? = null)

Source SQL Connection

Link copied to clipboard
data class SqlDbMigrationStatusDetailsResponse(val listOfCopyProgressDetails: List<CopyProgressDetailsResponse>, val migrationState: String, val sqlDataCopyErrors: List<String>)

Detailed status of current Sql Db migration.

Link copied to clipboard

Offline configuration

data class StartMigrationScenarioServerRoleResultResponse(val exceptionsAndWarnings: List<ReportableExceptionResponse>, val name: String, val state: String)

Server role migration result

Link copied to clipboard
data class SyncMigrationDatabaseErrorEventResponse(val eventText: String, val eventTypeString: String, val timestampString: String)

Database migration errors for online migration

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)
data class ValidateMigrationInputSqlServerSqlMISyncTaskInputResponse(val azureApp: AzureActiveDirectoryAppResponse, val backupFileShare: FileShareResponse? = null, val selectedDatabases: List<MigrateSqlServerSqlMIDatabaseInputResponse>, val sourceConnectionInfo: SqlConnectionInfoResponse, val storageResourceId: String, val targetConnectionInfo: MiSqlConnectionInfoResponse)

Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario.

Output for task that validates migration input for Azure SQL Database Managed Instance online migration

Properties for task that validates migration input for SQL to Azure SQL Database Managed Instance sync scenario

data class ValidateMigrationInputSqlServerSqlMITaskInputResponse(val backupBlobShare: BlobShareResponse, val backupFileShare: FileShareResponse? = null, val backupMode: String? = null, val selectedDatabases: List<MigrateSqlServerSqlMIDatabaseInputResponse>, val selectedLogins: List<String>? = null, val sourceConnectionInfo: SqlConnectionInfoResponse, val targetConnectionInfo: SqlConnectionInfoResponse)

Input for task that validates migration input for SQL to Azure SQL Managed Instance

data class ValidateMigrationInputSqlServerSqlMITaskOutputResponse(val backupFolderErrors: List<ReportableExceptionResponse>, val backupShareCredentialsErrors: List<ReportableExceptionResponse>, val backupStorageAccountErrors: List<ReportableExceptionResponse>, val databaseBackupInfo: DatabaseBackupInfoResponse? = null, val existingBackupErrors: List<ReportableExceptionResponse>, val id: String, val name: String, val restoreDatabaseNameErrors: List<ReportableExceptionResponse>)

Output for task that validates migration input for SQL to Azure SQL Managed Instance migrations

Properties for task that validates migration input for SQL to Azure SQL Database Managed Instance

Input for task that validates migration input for SQL sync migrations

Output for task that validates migration input for SQL sync migrations

Link copied to clipboard
data class ValidationErrorResponse(val severity: String, val text: String)

Description about the errors happen while performing migration validation

Link copied to clipboard
data class WaitStatisticsResponse(val waitCount: Double, val waitTimeMs: Double, val waitType: String)

Wait statistics gathered during query batch execution