Tasks - Get

Get task information
The tasks resource is a nested, proxy-only resource representing work performed by a DMS (classic) instance. The GET method retrieves information about a task.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}?api-version=2022-03-30-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}?$expand={$expand}&api-version=2022-03-30-preview

URI Parameters

Name In Required Type Description
groupName
path True

string

Name of the resource group

projectName
path True

string

Name of the project

serviceName
path True

string

Name of the service

subscriptionId
path True

string

Subscription ID that identifies an Azure subscription.

taskName
path True

string

Name of the Task

api-version
query True

string

Version of the API

$expand
query

string

Expand the response

Responses

Name Type Description
200 OK

ProjectTask

A task resource

Other Status Codes

ApiError

Error

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

Tasks_Get

Sample request

GET https://management.azure.com/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/tasks/DmsSdkTask?api-version=2022-03-30-preview

Sample response

{
  "properties": {
    "input": {
      "targetConnectionInfo": {
        "type": "SqlConnectionInfo",
        "dataSource": "ssma-test-server.database.windows.net",
        "authentication": "SqlAuthentication",
        "encryptConnection": true,
        "trustServerCertificate": true,
        "userName": "testuser"
      }
    },
    "taskType": "ConnectToTarget.SqlDb",
    "state": "Queued"
  },
  "etag": "0vPYxzfnDaDH9yhOJAnqTyTRpa09Kb7pm+LEukDBbw8=",
  "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/tasks/DmsSdkTask",
  "name": "DmsSdkTask",
  "type": "Microsoft.DataMigration/services/projects/tasks"
}

Definitions

Name Description
ApiError

Error information.

AuthenticationType

An enumeration of possible authentication types when connecting

AzureActiveDirectoryApp

Azure Active Directory Application

BackupFileInfo

Information of the backup file

BackupFileStatus

An enumeration of Status of the log backup file.

BackupMode

An enumeration of backup modes

BackupSetInfo

Information of backup set

BackupType

Enum of the different backup types.

BlobShare

Blob container storage information.

CommandState

The state of the command. This is ignored if submitted.

ConnectToMongoDbTaskProperties

Properties for the task that validates the connection to and provides information about a MongoDB server

ConnectToSourceMySqlTaskInput

Input for the task that validates MySQL database connection

ConnectToSourceMySqlTaskProperties

Properties for the task that validates MySQL database connection

ConnectToSourceNonSqlTaskOutput

Output for connect to MySQL type source

ConnectToSourceOracleSyncTaskInput

Input for the task that validates Oracle database connection

ConnectToSourceOracleSyncTaskOutput

Output for the task that validates Oracle database connection

ConnectToSourceOracleSyncTaskProperties

Properties for the task that validates Oracle database connection

ConnectToSourcePostgreSqlSyncTaskInput

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

ConnectToSourcePostgreSqlSyncTaskOutput

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

ConnectToSourcePostgreSqlSyncTaskProperties

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

ConnectToSourceSqlServerSyncTaskProperties

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

ConnectToSourceSqlServerTaskInput

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

ConnectToSourceSqlServerTaskOutputAgentJobLevel

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

ConnectToSourceSqlServerTaskOutputDatabaseLevel

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

ConnectToSourceSqlServerTaskOutputLoginLevel

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

ConnectToSourceSqlServerTaskOutputTaskLevel

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

ConnectToSourceSqlServerTaskProperties

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

ConnectToTargetAzureDbForMySqlTaskInput

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

ConnectToTargetAzureDbForMySqlTaskOutput

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

ConnectToTargetAzureDbForMySqlTaskProperties

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

ConnectToTargetAzureDbForPostgreSqlSyncTaskInput

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

ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput

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

ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties

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

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput

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

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput

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

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties

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

ConnectToTargetSqlDbTaskInput

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

ConnectToTargetSqlDbTaskOutput

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

ConnectToTargetSqlDbTaskProperties

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

ConnectToTargetSqlMISyncTaskInput

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

ConnectToTargetSqlMISyncTaskOutput

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

ConnectToTargetSqlMISyncTaskProperties

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

ConnectToTargetSqlMITaskInput

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

ConnectToTargetSqlMITaskOutput

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

ConnectToTargetSqlMITaskProperties

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

ConnectToTargetSqlSqlDbSyncTaskInput

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

ConnectToTargetSqlSqlDbSyncTaskProperties

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

createdByType
DatabaseBackupInfo

Information about backup files when existing backup mode is used.

DatabaseCompatLevel

An enumeration of SQL Server database compatibility levels

DatabaseFileInfo

Database file specific information

DatabaseFileType

An enumeration of SQL Server database file types

DatabaseMigrationStage

Current stage of migration

DatabaseMigrationState

Database level migration state.

DatabaseSchemaMap

Mapping of schemas per database

DatabaseState

An enumeration of SQL Server Database states

DatabaseSummaryResult

Summary of database results in the migration

DatabaseTable

Table properties

DataIntegrityValidationResult

Results for checksum based Data Integrity validation results

DataItemMigrationSummaryResult

Basic summary of a data item migration

ExecutionStatistics

Description about the errors happen while performing migration validation

FileShare

File share information with Path, Username, and Password.

GetTdeCertificatesSqlTaskInput

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

GetTdeCertificatesSqlTaskOutput

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

GetTdeCertificatesSqlTaskProperties

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

GetUserTablesMySqlTaskInput

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

GetUserTablesMySqlTaskOutput

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

GetUserTablesMySqlTaskProperties

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

GetUserTablesOracleTaskInput

Input for the task that gets the list of tables contained within a provided list of Oracle schemas.

GetUserTablesOracleTaskOutput

Output for the task that gets the list of tables contained within a provided list of Oracle schemas.

GetUserTablesOracleTaskProperties

Properties for the task that collects user tables for the given list of Oracle schemas

GetUserTablesPostgreSqlTaskInput

Input for the task that gets the list of tables for a provided list of PostgreSQL databases.

GetUserTablesPostgreSqlTaskOutput

Output for the task that gets the list of tables for a provided list of PostgreSQL databases.

GetUserTablesPostgreSqlTaskProperties

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

GetUserTablesSqlSyncTaskInput

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

GetUserTablesSqlSyncTaskOutput

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

GetUserTablesSqlSyncTaskProperties

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

GetUserTablesSqlTaskInput

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

GetUserTablesSqlTaskOutput

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

GetUserTablesSqlTaskProperties

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

LoginMigrationStage

Enum of the different stage of login migration.

LoginType

Enum mapping of SMO LoginType.

MigrateMISyncCompleteCommandInput

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

MigrateMISyncCompleteCommandOutput

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

MigrateMISyncCompleteCommandProperties

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

MigrateMongoDbTaskProperties

Properties for the task that migrates data between MongoDB data sources

MigrateMySqlAzureDbForMySqlOfflineDatabaseInput

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

MigrateMySqlAzureDbForMySqlOfflineTaskInput

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

MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel
MigrateMySqlAzureDbForMySqlOfflineTaskOutputError
MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel
MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel
MigrateMySqlAzureDbForMySqlOfflineTaskProperties

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

MigrateMySqlAzureDbForMySqlSyncDatabaseInput

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

MigrateMySqlAzureDbForMySqlSyncTaskInput

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

MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError
MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel
MigrateMySqlAzureDbForMySqlSyncTaskOutputError
MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel
MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel
MigrateMySqlAzureDbForMySqlSyncTaskProperties

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

MigrateOracleAzureDbForPostgreSqlSyncTaskProperties

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

MigrateOracleAzureDbPostgreSqlSyncDatabaseInput

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

MigrateOracleAzureDbPostgreSqlSyncTaskInput

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

MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError
MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel
MigrateOracleAzureDbPostgreSqlSyncTaskOutputError
MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel
MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel
MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput

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

MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput

Selected tables for the migration

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput

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

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties

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

MigrateSqlServerSqlDbDatabaseInput

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

MigrateSqlServerSqlDbSyncDatabaseInput

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

MigrateSqlServerSqlDbSyncTaskInput

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

MigrateSqlServerSqlDbSyncTaskOutputDatabaseError
MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel
MigrateSqlServerSqlDbSyncTaskOutputError
MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel
MigrateSqlServerSqlDbSyncTaskOutputTableLevel
MigrateSqlServerSqlDbSyncTaskProperties

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

MigrateSqlServerSqlDbTaskInput

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

MigrateSqlServerSqlDbTaskOutputDatabaseLevel
MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult
MigrateSqlServerSqlDbTaskOutputError
MigrateSqlServerSqlDbTaskOutputMigrationLevel
MigrateSqlServerSqlDbTaskOutputTableLevel
MigrateSqlServerSqlDbTaskOutputValidationResult
MigrateSqlServerSqlDbTaskProperties

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

MigrateSqlServerSqlMIDatabaseInput

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

MigrateSqlServerSqlMISyncTaskInput

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

MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel
MigrateSqlServerSqlMISyncTaskOutputError
MigrateSqlServerSqlMISyncTaskOutputMigrationLevel
MigrateSqlServerSqlMISyncTaskProperties

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

MigrateSqlServerSqlMITaskInput

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

MigrateSqlServerSqlMITaskOutputAgentJobLevel
MigrateSqlServerSqlMITaskOutputDatabaseLevel
MigrateSqlServerSqlMITaskOutputError
MigrateSqlServerSqlMITaskOutputLoginLevel
MigrateSqlServerSqlMITaskOutputMigrationLevel
MigrateSqlServerSqlMITaskProperties

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

MigrateSsisTaskInput

Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance.

MigrateSsisTaskOutputMigrationLevel
MigrateSsisTaskOutputProjectLevel
MigrateSsisTaskProperties

Properties for task that migrates SSIS packages from SQL Server databases to Azure SQL Database Managed Instance.

MigrateSyncCompleteCommandInput

Input for command that completes sync migration for a database.

MigrateSyncCompleteCommandOutput

Output for command that completes sync migration for a database.

MigrateSyncCompleteCommandProperties

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

MigrationEligibilityInfo

Information about migration eligibility of a server object

MigrationReportResult

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

MigrationState

Current state of migration

MigrationStatus

Current status of migration

MigrationValidationDatabaseSummaryResult

Migration Validation Database level summary result

MigrationValidationOptions

Types of validations to run after the migration

MigrationValidationResult

Migration Validation Result

MiSqlConnectionInfo

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

MongoDbClusterInfo

Describes a MongoDB data source

MongoDbClusterType

The type of data source

MongoDbCollectionInfo

Describes a supported collection within a MongoDB database

MongoDbCollectionProgress

Describes the progress of a collection

MongoDbCollectionSettings

Describes how an individual MongoDB collection should be migrated

MongoDbConnectionInfo

Describes a connection to a MongoDB data source

MongoDbDatabaseInfo

Describes a database within a MongoDB data source

MongoDbDatabaseProgress

Describes the progress of a database

MongoDbDatabaseSettings

Describes how an individual MongoDB database should be migrated

MongoDbError

Describes an error or warning that occurred during a MongoDB migration

MongoDbErrorType

The type of error or warning

MongoDbMigrationProgress

Describes the progress of the overall migration

MongoDbMigrationSettings

Describes how a MongoDB data migration should be performed

MongoDbMigrationState
MongoDbReplication

Describes how changes will be replicated from the source to the target. The default is OneTime.

MongoDbShardKeyField

Describes a field reference within a MongoDB shard key

MongoDbShardKeyInfo

Describes a MongoDB shard key

MongoDbShardKeyOrder

The field ordering

MongoDbShardKeySetting

Describes a MongoDB shard key

MongoDbThrottlingSettings

Specifies resource limits for the migration

MySqlConnectionInfo

Information for connecting to MySQL server

MySqlTargetPlatformType

Target Platform for the migration

ObjectType

Type of the object that has the difference. e.g (Table/View/StoredProcedure)

ODataError

Error information in OData format.

OracleConnectionInfo

Information for connecting to Oracle server

OrphanedUserInfo

Information of orphaned users on the SQL server database.

PostgreSqlConnectionInfo

Information for connecting to PostgreSQL server

ProjectTask

A task resource

QueryAnalysisValidationResult

Results for query analysis comparison between the source and target

QueryExecutionResult

Describes query analysis results for execution in source and target

ReplicateMigrationState

Wrapper for replicate reported migration states.

ReportableException

Exception object for all custom exceptions

ScenarioSource

An enumeration of source type

ScenarioTarget

An enumeration of target type

SchemaComparisonValidationResult

Results for schema comparison between the source and target

SchemaComparisonValidationResultType

Description about the errors happen while performing migration validation

SelectedCertificateInput

Info for certificate to be exported for TDE enabled databases.

ServerLevelPermissionsGroup

Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing.

ServerProperties

Server properties for MySQL type source

Severity

Severity of the validation error

SqlConnectionInfo

Information for connecting to SQL database server

SqlSourcePlatform

Server platform type for connection

SsisMigrationInfo

SSIS migration info with SSIS store type, overwrite policy.

SsisMigrationOverwriteOption

The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS (classic) now and future may add Reuse option for container object

SsisMigrationStage

Current stage of SSIS migration

SsisStoreType

An enumeration of supported source SSIS store type in DMS (classic)

StartMigrationScenarioServerRoleResult

Server role migration result

SyncDatabaseMigrationReportingState

Enum of the different state of database level online migration.

SyncMigrationDatabaseErrorEvent

Database migration errors for online migration

SyncTableMigrationState

Enum of the different state of table level online migration.

SystemData
TaskState

The state of the task. This is ignored if submitted.

UpdateActionType

Type of the actual difference for the compared object, while performing schema comparison

ValidateMigrationInputSqlServerSqlDbSyncTaskProperties

Properties for task that validates migration input for SQL to Azure SQL DB sync migrations

ValidateMigrationInputSqlServerSqlMISyncTaskInput

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

ValidateMigrationInputSqlServerSqlMISyncTaskOutput

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

ValidateMigrationInputSqlServerSqlMISyncTaskProperties

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

ValidateMigrationInputSqlServerSqlMITaskInput

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

ValidateMigrationInputSqlServerSqlMITaskOutput

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

ValidateMigrationInputSqlServerSqlMITaskProperties

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

ValidateMongoDbTaskProperties

Properties for the task that validates a migration between MongoDB data sources

ValidateOracleAzureDbForPostgreSqlSyncTaskProperties

Properties for the task that validates a migration for Oracle to Azure Database for PostgreSQL for online migrations

ValidateOracleAzureDbPostgreSqlSyncTaskOutput

Output for task that validates migration input for Oracle to Azure Database for PostgreSQL for online migrations

ValidateSyncMigrationInputSqlServerTaskInput

Input for task that validates migration input for SQL sync migrations

ValidateSyncMigrationInputSqlServerTaskOutput

Output for task that validates migration input for SQL sync migrations

ValidationError

Description about the errors happen while performing migration validation

ValidationStatus

Current status of the validation

WaitStatistics

Wait statistics gathered during query batch execution

ApiError

Error information.

Name Type Description
error

ODataError

Error information in OData format

systemData

SystemData

Metadata pertaining to creation and last modification of the resource.

AuthenticationType

An enumeration of possible authentication types when connecting

Name Type Description
ActiveDirectoryIntegrated

string

ActiveDirectoryPassword

string

None

string

SqlAuthentication

string

WindowsAuthentication

string

AzureActiveDirectoryApp

Azure Active Directory Application

Name Type Description
appKey

string

Key used to authenticate to the Azure Active Directory Application

applicationId

string

Application ID of the Azure Active Directory Application

ignoreAzurePermissions

boolean

Ignore checking azure permissions on the AAD app

tenantId

string

Tenant id of the customer

BackupFileInfo

Information of the backup file

Name Type Description
familySequenceNumber

integer

Sequence number of the backup file in the backup set

fileLocation

string

Location of the backup file in shared folder

status

BackupFileStatus

Status of the backup file during migration

BackupFileStatus

An enumeration of Status of the log backup file.

Name Type Description
Arrived

string

Cancelled

string

Queued

string

Restored

string

Restoring

string

Uploaded

string

Uploading

string

BackupMode

An enumeration of backup modes

Name Type Description
CreateBackup

string

ExistingBackup

string

BackupSetInfo

Information of backup set

Name Type Description
backupFinishedDate

string

Date and time that the backup operation finished

backupSetId

string

Id for the set of backup files

backupStartDate

string

Date and time that the backup operation began

backupType

BackupType

Enum of the different backup types

databaseName

string

Name of the database to which the backup set belongs

firstLsn

string

First log sequence number of the backup file

isBackupRestored

boolean

Whether the backup set is restored or not

lastLsn

string

Last log sequence number of the backup file

lastModifiedTime

string

Last modified time of the backup file in share location

listOfBackupFiles

BackupFileInfo[]

List of files in the backup set

BackupType

Enum of the different backup types.

Name Type Description
Database

string

DifferentialDatabase

string

DifferentialFile

string

DifferentialPartial

string

File

string

Partial

string

TransactionLog

string

BlobShare

Blob container storage information.

Name Type Description
sasUri

string

SAS URI of Azure Storage Account Container.

CommandState

The state of the command. This is ignored if submitted.

Name Type Description
Accepted

string

Failed

string

Running

string

Succeeded

string

Unknown

string

ConnectToMongoDbTaskProperties

Properties for the task that validates the connection to and provides information about a MongoDB server

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MongoDbConnectionInfo

Describes a connection to a MongoDB data source

output

MongoDbClusterInfo[]

An array containing a single MongoDbClusterInfo object

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

Connect.MongoDb

Task type.

ConnectToSourceMySqlTaskInput

Input for the task that validates MySQL database connection

Name Type Default value Description
checkPermissionsGroup

ServerLevelPermissionsGroup

Permission group for validations

isOfflineMigration

boolean

False

Flag for whether or not the migration is offline

sourceConnectionInfo

MySqlConnectionInfo

Information for connecting to MySQL source

targetPlatform

MySqlTargetPlatformType

Target Platform for the migration

ConnectToSourceMySqlTaskProperties

Properties for the task that validates MySQL database connection

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ConnectToSourceMySqlTaskInput

Task input

output

ConnectToSourceNonSqlTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ConnectToSource.MySql

Task type.

ConnectToSourceNonSqlTaskOutput

Output for connect to MySQL type source

Name Type Description
databases

string[]

List of databases on the server

id

string

Result identifier

serverProperties

ServerProperties

Server properties

sourceServerBrandVersion

string

Server brand version

validationErrors

ReportableException[]

Validation errors associated with the task

ConnectToSourceOracleSyncTaskInput

Input for the task that validates Oracle database connection

Name Type Description
sourceConnectionInfo

OracleConnectionInfo

Information for connecting to Oracle source

ConnectToSourceOracleSyncTaskOutput

Output for the task that validates Oracle database connection

Name Type Description
databases

string[]

List of schemas on source server

sourceServerBrandVersion

string

Source server brand version

sourceServerVersion

string

Version of the source server

validationErrors

ReportableException[]

Validation errors associated with the task

ConnectToSourceOracleSyncTaskProperties

Properties for the task that validates Oracle database connection

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ConnectToSourceOracleSyncTaskInput

Task input

output

ConnectToSourceOracleSyncTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ConnectToSource.Oracle.Sync

Task type.

ConnectToSourcePostgreSqlSyncTaskInput

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

Name Type Description
sourceConnectionInfo

PostgreSqlConnectionInfo

Connection information for source PostgreSQL server

ConnectToSourcePostgreSqlSyncTaskOutput

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

Name Type Description
databases

string[]

List of databases on source server

id

string

Result identifier

sourceServerBrandVersion

string

Source server brand version

sourceServerVersion

string

Version of the source server

validationErrors

ReportableException[]

Validation errors associated with the task

ConnectToSourcePostgreSqlSyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ConnectToSourcePostgreSqlSyncTaskInput

Task input

output

ConnectToSourcePostgreSqlSyncTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ConnectToSource.PostgreSql.Sync

Task type.

ConnectToSourceSqlServerSyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ConnectToSourceSqlServerTaskInput

Task input

output ConnectToSourceSqlServerTaskOutput[]:

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ConnectToSource.SqlServer.Sync

Task type.

ConnectToSourceSqlServerTaskInput

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

Name Type Default value Description
checkPermissionsGroup

ServerLevelPermissionsGroup

Permission group for validations

collectAgentJobs

boolean

False

Flag for whether to collect agent jobs from source server.

collectDatabases

boolean

True

Flag for whether to collect databases from source server.

collectLogins

boolean

False

Flag for whether to collect logins from source server.

collectTdeCertificateInfo

boolean

False

Flag for whether to collect TDE Certificate names from source server.

encryptedKeyForSecureFields

string

encrypted key for secure fields

sourceConnectionInfo

SqlConnectionInfo

Connection information for Source SQL Server

validateSsisCatalogOnly

boolean

False

Flag for whether to validate SSIS catalog is reachable on the source server.

ConnectToSourceSqlServerTaskOutputAgentJobLevel

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

Name Type Description
id

string

Result identifier

isEnabled

boolean

The state of the original Agent Job.

jobCategory

string

The type of Agent Job.

jobOwner

string

The owner of the Agent Job

lastExecutedOn

string

UTC Date and time when the Agent Job was last executed.

migrationEligibility

MigrationEligibilityInfo

Information about eligibility of agent job for migration.

name

string

Agent Job name

resultType string:

AgentJobLevelOutput

Type of result - database level or task level

validationErrors

ReportableException[]

Validation errors

ConnectToSourceSqlServerTaskOutputDatabaseLevel

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

Name Type Description
compatibilityLevel

DatabaseCompatLevel

SQL Server compatibility level of database

databaseFiles

DatabaseFileInfo[]

The list of database files

databaseState

DatabaseState

State of the database

id

string

Result identifier

name

string

Database name

resultType string:

DatabaseLevelOutput

Type of result - database level or task level

sizeMB

number

Size of the file in megabytes

ConnectToSourceSqlServerTaskOutputLoginLevel

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

Name Type Description
defaultDatabase

string

The default database for the login.

id

string

Result identifier

isEnabled

boolean

The state of the login.

loginType

LoginType

The type of login.

migrationEligibility

MigrationEligibilityInfo

Information about eligibility of login for migration.

name

string

Login name.

resultType string:

LoginLevelOutput

Type of result - database level or task level

ConnectToSourceSqlServerTaskOutputTaskLevel

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

Name Type Description
agentJobs

object

Source agent jobs as a map from agent job name to id.

databaseTdeCertificateMapping

object

Mapping from database name to TDE certificate name, if applicable

databases

object

Source databases as a map from database name to database id

id

string

Result identifier

logins

object

Source logins as a map from login name to login id.

resultType string:

TaskLevelOutput

Type of result - database level or task level

sourceServerBrandVersion

string

Source server brand version

sourceServerVersion

string

Source server version

validationErrors

ReportableException[]

Validation errors

ConnectToSourceSqlServerTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ConnectToSourceSqlServerTaskInput

Task input

output ConnectToSourceSqlServerTaskOutput[]:

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskId

string

Task id

taskType string:

ConnectToSource.SqlServer

Task type.

ConnectToTargetAzureDbForMySqlTaskInput

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

Name Type Default value Description
isOfflineMigration

boolean

False

Flag for whether or not the migration is offline

sourceConnectionInfo

MySqlConnectionInfo

Connection information for source MySQL server

targetConnectionInfo

MySqlConnectionInfo

Connection information for target Azure Database for MySQL server

ConnectToTargetAzureDbForMySqlTaskOutput

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

Name Type Description
databases

string[]

List of databases on target server

id

string

Result identifier

serverVersion

string

Version of the target server

targetServerBrandVersion

string

Target server brand version

validationErrors

ReportableException[]

Validation errors associated with the task

ConnectToTargetAzureDbForMySqlTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ConnectToTargetAzureDbForMySqlTaskInput

Task input

output

ConnectToTargetAzureDbForMySqlTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ConnectToTarget.AzureDbForMySql

Task type.

ConnectToTargetAzureDbForPostgreSqlSyncTaskInput

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

Name Type Description
sourceConnectionInfo

PostgreSqlConnectionInfo

Connection information for source PostgreSQL server

targetConnectionInfo

PostgreSqlConnectionInfo

Connection information for target Azure Database for PostgreSQL server

ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput

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

Name Type Description
databases

string[]

List of databases on target server

id

string

Result identifier

targetServerBrandVersion

string

Target server brand version

targetServerVersion

string

Version of the target server

validationErrors

ReportableException[]

Validation errors associated with the task

ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ConnectToTargetAzureDbForPostgreSqlSyncTaskInput

Task input

output

ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ConnectToTarget.AzureDbForPostgreSql.Sync

Task type.

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput

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

Name Type Description
targetConnectionInfo

PostgreSqlConnectionInfo

Connection information for target Azure Database for PostgreSQL server

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput

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

Name Type Description
databaseSchemaMap

DatabaseSchemaMap[]

Mapping of schemas per database

databases

string[]

List of databases on target server

targetServerBrandVersion

string

Target server brand version

targetServerVersion

string

Version of the target server

validationErrors

ReportableException[]

Validation errors associated with the task

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput

Task input

output

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync

Task type.

ConnectToTargetSqlDbTaskInput

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

Name Type Description
queryObjectCounts

boolean

Boolean flag indicating whether to query object counts for each database on the target server

targetConnectionInfo

SqlConnectionInfo

Connection information for target SQL DB

ConnectToTargetSqlDbTaskOutput

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

Name Type Description
databases

object

Source databases as a map from database name to database id

id

string

Result identifier

targetServerBrandVersion

string

Target server brand version

targetServerVersion

string

Version of the target server

ConnectToTargetSqlDbTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

createdOn

string

DateTime in UTC when the task was created

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ConnectToTargetSqlDbTaskInput

Task input

output

ConnectToTargetSqlDbTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ConnectToTarget.SqlDb

Task type.

ConnectToTargetSqlMISyncTaskInput

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

Name Type Description
azureApp

AzureActiveDirectoryApp

Azure Active Directory Application the DMS (classic) instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account

targetConnectionInfo

MiSqlConnectionInfo

Connection information for Azure SQL Database Managed Instance

ConnectToTargetSqlMISyncTaskOutput

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

Name Type Description
targetServerBrandVersion

string

Target server brand version

targetServerVersion

string

Target server version

validationErrors

ReportableException[]

Validation errors

ConnectToTargetSqlMISyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ConnectToTargetSqlMISyncTaskInput

Task input

output

ConnectToTargetSqlMISyncTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ConnectToTarget.AzureSqlDbMI.Sync.LRS

Task type.

ConnectToTargetSqlMITaskInput

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

Name Type Default value Description
collectAgentJobs

boolean

True

Flag for whether to collect agent jobs from target SQL MI server.

collectLogins

boolean

True

Flag for whether to collect logins from target SQL MI server.

targetConnectionInfo

SqlConnectionInfo

Connection information for target SQL Server

validateSsisCatalogOnly

boolean

False

Flag for whether to validate SSIS catalog is reachable on the target SQL MI server.

ConnectToTargetSqlMITaskOutput

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

Name Type Description
agentJobs

string[]

List of agent jobs on the target server.

id

string

Result identifier

logins

string[]

List of logins on the target server.

targetServerBrandVersion

string

Target server brand version

targetServerVersion

string

Target server version

validationErrors

ReportableException[]

Validation errors

ConnectToTargetSqlMITaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ConnectToTargetSqlMITaskInput

Task input

output

ConnectToTargetSqlMITaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ConnectToTarget.AzureSqlDbMI

Task type.

ConnectToTargetSqlSqlDbSyncTaskInput

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

Name Type Description
sourceConnectionInfo

SqlConnectionInfo

Connection information for source SQL Server

targetConnectionInfo

SqlConnectionInfo

Connection information for target SQL DB

ConnectToTargetSqlSqlDbSyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ConnectToTargetSqlSqlDbSyncTaskInput

Task input

output

ConnectToTargetSqlDbTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ConnectToTarget.SqlDb.Sync

Task type.

createdByType

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DatabaseBackupInfo

Information about backup files when existing backup mode is used.

Name Type Description
backupFiles

string[]

The list of backup files for the current database.

backupFinishDate

string

Date and time when the backup operation finished.

backupType

BackupType

Backup Type.

databaseName

string

Database name.

familyCount

integer

Number of files in the backup set.

isCompressed

boolean

Whether the backup set is compressed

isDamaged

boolean

Database was damaged when backed up, but the backup operation was requested to continue despite errors.

position

integer

Position of current database backup in the file.

DatabaseCompatLevel

An enumeration of SQL Server database compatibility levels

Name Type Description
CompatLevel100

string

CompatLevel110

string

CompatLevel120

string

CompatLevel130

string

CompatLevel140

string

CompatLevel80

string

CompatLevel90

string

DatabaseFileInfo

Database file specific information

Name Type Description
databaseName

string

Name of the database

fileType

DatabaseFileType

Database file type

id

string

Unique identifier for database file

logicalName

string

Logical name of the file

physicalFullName

string

Operating-system full path of the file

restoreFullName

string

Suggested full path of the file for restoring

sizeMB

number

Size of the file in megabytes

DatabaseFileType

An enumeration of SQL Server database file types

Name Type Description
Filestream

string

Fulltext

string

Log

string

NotSupported

string

Rows

string

DatabaseMigrationStage

Current stage of migration

Name Type Description
Backup

string

Completed

string

FileCopy

string

Initialize

string

None

string

Restore

string

DatabaseMigrationState

Database level migration state.

Name Type Description
CANCELLED

string

COMPLETED

string

CUTOVER_START

string

FAILED

string

FULL_BACKUP_UPLOAD_START

string

INITIAL

string

LOG_SHIPPING_START

string

POST_CUTOVER_COMPLETE

string

UNDEFINED

string

UPLOAD_LOG_FILES_START

string

DatabaseSchemaMap

Mapping of schemas per database

Name Type Description
database

string

schemas

string[]

DatabaseState

An enumeration of SQL Server Database states

Name Type Description
Copying

string

Emergency

string

Offline

string

OfflineSecondary

string

Online

string

Recovering

string

RecoveryPending

string

Restoring

string

Suspect

string

DatabaseSummaryResult

Summary of database results in the migration

Name Type Description
endedOn

string

Migration end time

errorPrefix

string

Wildcard string prefix to use for querying all errors of the item

itemsCompletedCount

integer

Number of successfully completed items

itemsCount

integer

Number of items

name

string

Name of the item

resultPrefix

string

Wildcard string prefix to use for querying all sub-tem results of the item

sizeMB

number

Size of the database in megabytes

startedOn

string

Migration start time

state

MigrationState

Current state of migration

statusMessage

string

Status message

DatabaseTable

Table properties

Name Type Description
hasRows

boolean

Indicates whether table is empty or not

name

string

Schema-qualified name of the table

DataIntegrityValidationResult

Results for checksum based Data Integrity validation results

Name Type Description
failedObjects

object

List of failed table names of source and target pair

validationErrors

ValidationError

List of errors that happened while performing data integrity validation

DataItemMigrationSummaryResult

Basic summary of a data item migration

Name Type Description
endedOn

string

Migration end time

errorPrefix

string

Wildcard string prefix to use for querying all errors of the item

itemsCompletedCount

integer

Number of successfully completed items

itemsCount

integer

Number of items

name

string

Name of the item

resultPrefix

string

Wildcard string prefix to use for querying all sub-tem results of the item

startedOn

string

Migration start time

state

MigrationState

Current state of migration

statusMessage

string

Status message

ExecutionStatistics

Description about the errors happen while performing migration validation

Name Type Description
cpuTimeMs

number

CPU Time in millisecond(s) for the query execution

elapsedTimeMs

number

Time taken in millisecond(s) for executing the query

executionCount

integer

No. of query executions

hasErrors

boolean

Indicates whether the query resulted in an error

sqlErrors

string[]

List of sql Errors

waitStats

<string,  WaitStatistics>

Dictionary of sql query execution wait types and the respective statistics

FileShare

File share information with Path, Username, and Password.

Name Type Description
password

string

Password credential used to connect to the share location.

path

string

The folder path for this share.

userName

string

User name credential to connect to the share location

GetTdeCertificatesSqlTaskInput

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

Name Type Description
backupFileShare

FileShare

Backup file share information for file share to be used for temporarily storing files.

connectionInfo

SqlConnectionInfo

Connection information for SQL Server

selectedCertificates

SelectedCertificateInput[]

List containing certificate names and corresponding password to use for encrypting the exported certificate.

GetTdeCertificatesSqlTaskOutput

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

Name Type Description
base64EncodedCertificates

object

Mapping from certificate name to base 64 encoded format.

validationErrors

ReportableException[]

Validation errors

GetTdeCertificatesSqlTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

GetTdeCertificatesSqlTaskInput

Task input

output

GetTdeCertificatesSqlTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

GetTDECertificates.Sql

Task type.

GetUserTablesMySqlTaskInput

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

Name Type Description
connectionInfo

MySqlConnectionInfo

Connection information for SQL Server

selectedDatabases

string[]

List of database names to collect tables for

GetUserTablesMySqlTaskOutput

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

Name Type Description
databasesToTables

object

Mapping from database name to list of tables

id

string

Result identifier

validationErrors

ReportableException[]

Validation errors

GetUserTablesMySqlTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

GetUserTablesMySqlTaskInput

Task input

output

GetUserTablesMySqlTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

GetUserTablesMySql

Task type.

GetUserTablesOracleTaskInput

Input for the task that gets the list of tables contained within a provided list of Oracle schemas.

Name Type Description
connectionInfo

OracleConnectionInfo

Information for connecting to Oracle source

selectedSchemas

string[]

List of Oracle schemas for which to collect tables

GetUserTablesOracleTaskOutput

Output for the task that gets the list of tables contained within a provided list of Oracle schemas.

Name Type Description
schemaName

string

The schema this result is for

tables

DatabaseTable[]

List of valid tables found for this schema

validationErrors

ReportableException[]

Validation errors associated with the task

GetUserTablesOracleTaskProperties

Properties for the task that collects user tables for the given list of Oracle schemas

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

GetUserTablesOracleTaskInput

Task input

output

GetUserTablesOracleTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

GetUserTablesOracle

Task type.

GetUserTablesPostgreSqlTaskInput

Input for the task that gets the list of tables for a provided list of PostgreSQL databases.

Name Type Description
connectionInfo

PostgreSqlConnectionInfo

Information for connecting to PostgreSQL source

selectedDatabases

string[]

List of PostgreSQL databases for which to collect tables

GetUserTablesPostgreSqlTaskOutput

Output for the task that gets the list of tables for a provided list of PostgreSQL databases.

Name Type Description
databaseName

string

The database this result is for

tables

DatabaseTable[]

List of valid tables found for this database

validationErrors

ReportableException[]

Validation errors associated with the task

GetUserTablesPostgreSqlTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

GetUserTablesPostgreSqlTaskInput

Task input

output

GetUserTablesPostgreSqlTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

GetUserTablesPostgreSql

Task type.

GetUserTablesSqlSyncTaskInput

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

Name Type Description
selectedSourceDatabases

string[]

List of source database names to collect tables for

selectedTargetDatabases

string[]

List of target database names to collect tables for

sourceConnectionInfo

SqlConnectionInfo

Connection information for SQL Server

targetConnectionInfo

SqlConnectionInfo

Connection information for SQL DB

GetUserTablesSqlSyncTaskOutput

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

Name Type Description
databasesToSourceTables

object

Mapping from database name to list of source tables

databasesToTargetTables

object

Mapping from database name to list of target tables

tableValidationErrors

object

Mapping from database name to list of validation errors

validationErrors

ReportableException[]

Validation errors

GetUserTablesSqlSyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

GetUserTablesSqlSyncTaskInput

Task input

output

GetUserTablesSqlSyncTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

GetUserTables.AzureSqlDb.Sync

Task type.

GetUserTablesSqlTaskInput

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

Name Type Description
connectionInfo

SqlConnectionInfo

Connection information for SQL Server

encryptedKeyForSecureFields

string

encrypted key for secure fields

selectedDatabases

string[]

List of database names to collect tables for

GetUserTablesSqlTaskOutput

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

Name Type Description
databasesToTables

object

Mapping from database name to list of tables

id

string

Result identifier

validationErrors

ReportableException[]

Validation errors

GetUserTablesSqlTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

GetUserTablesSqlTaskInput

Task input

output

GetUserTablesSqlTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskId

string

Task id

taskType string:

GetUserTables.Sql

Task type.

LoginMigrationStage

Enum of the different stage of login migration.

Name Type Description
AssignRoleMembership

string

AssignRoleOwnership

string

Completed

string

EstablishObjectPermissions

string

EstablishServerPermissions

string

EstablishUserMapping

string

Initialize

string

LoginMigration

string

None

string

LoginType

Enum mapping of SMO LoginType.

Name Type Description
AsymmetricKey

string

Certificate

string

ExternalGroup

string

ExternalUser

string

SqlLogin

string

WindowsGroup

string

WindowsUser

string

MigrateMISyncCompleteCommandInput

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

Name Type Description
sourceDatabaseName

string

Name of managed instance database

MigrateMISyncCompleteCommandOutput

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

Name Type Description
errors

ReportableException[]

List of errors that happened during the command execution

MigrateMISyncCompleteCommandProperties

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

Name Type Description
commandType string:

Migrate.SqlServer.AzureDbSqlMi.Complete

Command type.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MigrateMISyncCompleteCommandInput

Command input

output

MigrateMISyncCompleteCommandOutput

Command output. This is ignored if submitted.

state

CommandState

The state of the command. This is ignored if submitted.

MigrateMongoDbTaskProperties

Properties for the task that migrates data between MongoDB data sources

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MongoDbMigrationSettings

Describes how a MongoDB data migration should be performed

output MongoDbProgress[]:

Base class for MongoDB migration outputs

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

Migrate.MongoDb

Task type.

MigrateMySqlAzureDbForMySqlOfflineDatabaseInput

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

Name Type Description
name

string

Name of the database

tableMap

object

Mapping of source to target tables

targetDatabaseName

string

Name of target database. Note: Target database will be truncated before starting migration.

MigrateMySqlAzureDbForMySqlOfflineTaskInput

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

Name Type Default value Description
encryptedKeyForSecureFields

string

encrypted key for secure fields

makeSourceServerReadOnly

boolean

False

Setting to set the source server read only

optionalAgentSettings

object

Optional parameters for fine tuning the data transfer rate during migration

selectedDatabases

MigrateMySqlAzureDbForMySqlOfflineDatabaseInput[]

Databases to migrate

sourceConnectionInfo

MySqlConnectionInfo

Connection information for source MySQL

startedOn

string

Parameter to specify when the migration started

targetConnectionInfo

MySqlConnectionInfo

Connection information for target Azure Database for MySQL

MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel

Name Type Description
databaseName

string

Name of the database

endedOn

string

Migration end time

errorCount

integer

Number of database/object errors.

errorPrefix

string

Wildcard string prefix to use for querying all errors of the item

exceptionsAndWarnings

ReportableException[]

Migration exceptions and warnings.

id

string

Result identifier

lastStorageUpdate

string

Last time the storage was updated

message

string

Migration progress message

numberOfObjects

integer

Number of objects

numberOfObjectsCompleted

integer

Number of successfully completed objects

objectSummary

<string,  DataItemMigrationSummaryResult>

Summary of object results in the migration

resultPrefix

string

Wildcard string prefix to use for querying all sub-tem results of the item

resultType string:

DatabaseLevelOutput

Result type

stage

DatabaseMigrationStage

Migration stage that this database is in

startedOn

string

Migration start time

state

MigrationState

Current state of migration

statusMessage

string

Status message

MigrateMySqlAzureDbForMySqlOfflineTaskOutputError

Name Type Description
error

ReportableException

Migration error

id

string

Unique identifier for the exception

resultType string:

ErrorOutput

Result type

MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel

Name Type Description
databaseSummary

<string,  DatabaseSummaryResult>

Summary of database results in the migration

databases

object

Selected databases as a map from database name to database id

durationInSeconds

integer

Duration of task execution in seconds.

endedOn

string

Migration end time

exceptionsAndWarnings

ReportableException[]

Migration exceptions and warnings.

id

string

Result identifier

lastStorageUpdate

string

Last time the storage was updated

message

string

Migration progress message

migrationReportResult

MigrationReportResult

Migration Report Result, provides unique url for downloading your migration report.

resultType string:

MigrationLevelOutput

Result type

sourceServerBrandVersion

string

Source server brand version

sourceServerVersion

string

Source server version

startedOn

string

Migration start time

status

MigrationStatus

Current status of migration

statusMessage

string

Migration status message

targetServerBrandVersion

string

Target server brand version

targetServerVersion

string

Target server version

MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel

Name Type Description
endedOn

string

Migration end time

errorPrefix

string

Wildcard string prefix to use for querying all errors of the item

id

string

Result identifier

itemsCompletedCount

integer

Number of successfully completed items

itemsCount

integer

Number of items

lastStorageUpdate

string

Last time the storage was updated

objectName

string

Name of the item

resultPrefix

string

Wildcard string prefix to use for querying all sub-tem results of the item

resultType string:

TableLevelOutput

Result type

startedOn

string

Migration start time

state

MigrationState

Current state of migration

statusMessage

string

Status message

MigrateMySqlAzureDbForMySqlOfflineTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MigrateMySqlAzureDbForMySqlOfflineTaskInput

Task input

isCloneable

boolean

whether the task can be cloned or not

output MigrateMySqlAzureDbForMySqlOfflineTaskOutput[]:

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskId

string

Task id

taskType string:

Migrate.MySql.AzureDbForMySql

Task type.

MigrateMySqlAzureDbForMySqlSyncDatabaseInput

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

Name Type Description
migrationSetting

object

Migration settings which tune the migration behavior

name

string

Name of the database

sourceSetting

object

Source settings to tune source endpoint migration behavior

tableMap

object

Mapping of source to target tables

targetDatabaseName

string

Name of target database. Note: Target database will be truncated before starting migration.

targetSetting

object

Target settings to tune target endpoint migration behavior

MigrateMySqlAzureDbForMySqlSyncTaskInput

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

Name Type Description
selectedDatabases

MigrateMySqlAzureDbForMySqlSyncDatabaseInput[]

Databases to migrate

sourceConnectionInfo

MySqlConnectionInfo

Connection information for source MySQL

targetConnectionInfo

MySqlConnectionInfo

Connection information for target Azure Database for MySQL

MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError

Name Type Description
errorMessage

string

Error message

events

SyncMigrationDatabaseErrorEvent[]

List of error events.

id

string

Result identifier

resultType string:

DatabaseLevelErrorOutput

Result type

MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel

Name Type Description
appliedChanges

integer

Number of applied changes

cdcDeleteCounter

integer

Number of cdc deletes

cdcInsertCounter

integer

Number of cdc inserts

cdcUpdateCounter

integer

Number of cdc updates

databaseName

string

Name of the database

endedOn

string

Migration end time

fullLoadCompletedTables

integer

Number of tables completed in full load

fullLoadErroredTables

integer

Number of tables errored in full load

fullLoadLoadingTables

integer

Number of tables loading in full load

fullLoadQueuedTables

integer

Number of tables queued in full load

id

string

Result identifier

incomingChanges

integer

Number of incoming changes

initializationCompleted

boolean

Indicates if initial load (full load) has been completed

latency

integer

CDC apply latency

migrationState

SyncDatabaseMigrationReportingState

Migration state that this database is in

resultType string:

DatabaseLevelOutput

Result type

startedOn

string

Migration start time

MigrateMySqlAzureDbForMySqlSyncTaskOutputError

Name Type Description
error

ReportableException

Migration error

id

string

Result identifier

resultType string:

ErrorOutput

Result type

MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel

Name Type Description
endedOn

string

Migration end time

id

string

Result identifier

resultType string:

MigrationLevelOutput

Result type

sourceServer

string

Source server name

sourceServerVersion

string

Source server version

startedOn

string

Migration start time

targetServer

string

Target server name

targetServerVersion

string

Target server version

MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel

Name Type Description
cdcDeleteCounter

string

Number of applied deletes

cdcInsertCounter

string

Number of applied inserts

cdcUpdateCounter

string

Number of applied updates

dataErrorsCounter

integer

Number of data errors occurred

databaseName

string

Name of the database

fullLoadEndedOn

string

Full load end time

fullLoadEstFinishTime

string

Estimate to finish full load

fullLoadStartedOn

string

Full load start time

fullLoadTotalRows

integer

Number of rows applied in full load

id

string

Result identifier

lastModifiedTime

string

Last modified time on target

resultType string:

TableLevelOutput

Result type

state

SyncTableMigrationState

Current state of the table migration

tableName

string

Name of the table

totalChangesApplied

integer

Total number of applied changes

MigrateMySqlAzureDbForMySqlSyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MigrateMySqlAzureDbForMySqlSyncTaskInput

Task input

output MigrateMySqlAzureDbForMySqlSyncTaskOutput[]:

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

Migrate.MySql.AzureDbForMySql.Sync

Task type.

MigrateOracleAzureDbForPostgreSqlSyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MigrateOracleAzureDbPostgreSqlSyncTaskInput

Task input

output MigrateOracleAzureDbPostgreSqlSyncTaskOutput[]:

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

Migrate.Oracle.AzureDbForPostgreSql.Sync

Task type.

MigrateOracleAzureDbPostgreSqlSyncDatabaseInput

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

Name Type Description
caseManipulation

string

How to handle object name casing: either Preserve or ToLower

migrationSetting

object

Migration settings which tune the migration behavior

name

string

Name of the migration pipeline

schemaName

string

Name of the source schema

sourceSetting

object

Source settings to tune source endpoint migration behavior

tableMap

object

Mapping of source to target tables

targetDatabaseName

string

Name of target database. Note: Target database will be truncated before starting migration.

targetSetting

object

Target settings to tune target endpoint migration behavior

MigrateOracleAzureDbPostgreSqlSyncTaskInput

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

Name Type Description
selectedDatabases

MigrateOracleAzureDbPostgreSqlSyncDatabaseInput[]

Databases to migrate

sourceConnectionInfo

OracleConnectionInfo

Connection information for source Oracle

targetConnectionInfo

PostgreSqlConnectionInfo

Connection information for target Azure Database for PostgreSQL

MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError

Name Type Description
errorMessage

string

Error message

events

SyncMigrationDatabaseErrorEvent[]

List of error events.

id

string

Result identifier

resultType string:

DatabaseLevelErrorOutput

Result type

MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel

Name Type Description
appliedChanges

integer

Number of applied changes

cdcDeleteCounter

integer

Number of cdc deletes

cdcInsertCounter

integer

Number of cdc inserts

cdcUpdateCounter

integer

Number of cdc updates

databaseName

string

Name of the database

endedOn

string

Migration end time

fullLoadCompletedTables

integer

Number of tables completed in full load

fullLoadErroredTables

integer

Number of tables errored in full load

fullLoadLoadingTables

integer

Number of tables loading in full load

fullLoadQueuedTables

integer

Number of tables queued in full load

id

string

Result identifier

incomingChanges

integer

Number of incoming changes

initializationCompleted

boolean

Indicates if initial load (full load) has been completed

latency

integer

CDC apply latency

migrationState

SyncDatabaseMigrationReportingState

Migration state that this database is in

resultType string:

DatabaseLevelOutput

Result type

startedOn

string

Migration start time

MigrateOracleAzureDbPostgreSqlSyncTaskOutputError

Name Type Description
error

ReportableException

Migration error

id

string

Result identifier

resultType string:

ErrorOutput

Result type

MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel

Name Type Description
endedOn

string

Migration end time

id

string

Result identifier

resultType string:

MigrationLevelOutput

Result type

sourceServer

string

Source server name

sourceServerVersion

string

Source server version

startedOn

string

Migration start time

targetServer

string

Target server name

targetServerVersion

string

Target server version

MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel

Name Type Description
cdcDeleteCounter

integer

Number of applied deletes

cdcInsertCounter

integer

Number of applied inserts

cdcUpdateCounter

integer

Number of applied updates

dataErrorsCounter

integer

Number of data errors occurred

databaseName

string

Name of the database

fullLoadEndedOn

string

Full load end time

fullLoadEstFinishTime

string

Estimate to finish full load

fullLoadStartedOn

string

Full load start time

fullLoadTotalRows

integer

Number of rows applied in full load

id

string

Result identifier

lastModifiedTime

string

Last modified time on target

resultType string:

TableLevelOutput

Result type

state

SyncTableMigrationState

Current state of the table migration

tableName

string

Name of the table

totalChangesApplied

integer

Total number of applied changes

MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput

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

Name Type Description
id

string

Result identifier

migrationSetting

Migration settings which tune the migration behavior

name

string

Name of the database

selectedTables

MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput[]

Tables selected for migration

sourceSetting

object

Source settings to tune source endpoint migration behavior

targetDatabaseName

string

Name of target database. Note: Target database will be truncated before starting migration.

targetSetting

object

Target settings to tune target endpoint migration behavior

MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput

Selected tables for the migration

Name Type Description
name

string

Name of the table to migrate

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput

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

Name Type Description
encryptedKeyForSecureFields

string

encrypted key for secure fields

selectedDatabases

MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput[]

Databases to migrate

sourceConnectionInfo

PostgreSqlConnectionInfo

Connection information for source PostgreSQL

startedOn

string

Migration start time

targetConnectionInfo

PostgreSqlConnectionInfo

Connection information for target Azure Database for PostgreSQL

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError

Name Type Description
errorMessage

string

Error message

events

SyncMigrationDatabaseErrorEvent[]

List of error events.

id

string

Result identifier

resultType string:

DatabaseLevelErrorOutput

Result type

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel

Name Type Description
appliedChanges

integer

Number of applied changes

cdcDeleteCounter

integer

Number of cdc deletes

cdcInsertCounter

integer

Number of cdc inserts

cdcUpdateCounter

integer

Number of cdc updates

databaseName

string

Name of the database

endedOn

string

Migration end time

fullLoadCompletedTables

integer

Number of tables completed in full load

fullLoadErroredTables

integer

Number of tables errored in full load

fullLoadLoadingTables

integer

Number of tables loading in full load

fullLoadQueuedTables

integer

Number of tables queued in full load

id

string

Result identifier

incomingChanges

integer

Number of incoming changes

initializationCompleted

boolean

Indicates if initial load (full load) has been completed

latency

integer

CDC apply latency

migrationState

SyncDatabaseMigrationReportingState

Migration state that this database is in

resultType string:

DatabaseLevelOutput

Result type

startedOn

string

Migration start time

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError

Name Type Description
error

ReportableException

Migration error

events

SyncMigrationDatabaseErrorEvent[]

List of error events

id

string

Result identifier

resultType string:

ErrorOutput

Result type

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel

Name Type Description
databaseCount

number

Number of databases to include

endedOn

string

Migration end time

id

string

Result identifier

resultType string:

MigrationLevelOutput

Result type

sourceServer

string

Source server name

sourceServerType

ScenarioSource

Source server type.

sourceServerVersion

string

Source server version

startedOn

string

Migration start time

state

ReplicateMigrationState

Migration status

targetServer

string

Target server name

targetServerType

ScenarioTarget

Target server type.

targetServerVersion

string

Target server version

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel

Name Type Description
cdcDeleteCounter

integer

Number of applied deletes

cdcInsertCounter

integer

Number of applied inserts

cdcUpdateCounter

integer

Number of applied updates

dataErrorsCounter

integer

Number of data errors occurred

databaseName

string

Name of the database

fullLoadEndedOn

string

Full load end time

fullLoadEstFinishTime

string

Estimate to finish full load

fullLoadStartedOn

string

Full load start time

fullLoadTotalRows

integer

Number of rows applied in full load

id

string

Result identifier

lastModifiedTime

string

Last modified time on target

resultType string:

TableLevelOutput

Result type

state

SyncTableMigrationState

Current state of the table migration

tableName

string

Name of the table

totalChangesApplied

integer

Total number of applied changes

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

createdOn

string

DateTime in UTC when the task was created

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput

Task input

isCloneable

boolean

whether the task can be cloned or not

output MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput[]:

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskId

string

task id

taskType string:

Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2

Task type.

MigrateSqlServerSqlDbDatabaseInput

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

Name Type Description
id

string

id of the database

makeSourceDbReadOnly

boolean

Whether to set database read only before migration

name

string

Name of the database

schemaSetting

object

Settings selected for DB schema migration.

tableMap

object

Mapping of source to target tables

targetDatabaseName

string

Name of target database. Note: Target database will be truncated before starting migration.

MigrateSqlServerSqlDbSyncDatabaseInput

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

Name Type Description
id

string

Unique identifier for database

migrationSetting

object

Migration settings which tune the migration behavior

name

string

Name of database

schemaName

string

Schema name to be migrated

sourceSetting

object

Source settings to tune source endpoint migration behavior

tableMap

object

Mapping of source to target tables

targetDatabaseName

string

Target database name

targetSetting

object

Target settings to tune target endpoint migration behavior

MigrateSqlServerSqlDbSyncTaskInput

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

Name Type Description
selectedDatabases

MigrateSqlServerSqlDbSyncDatabaseInput[]

Databases to migrate

sourceConnectionInfo

SqlConnectionInfo

Information for connecting to source

targetConnectionInfo

SqlConnectionInfo

Information for connecting to target

validationOptions

MigrationValidationOptions

Validation options

MigrateSqlServerSqlDbSyncTaskOutputDatabaseError

Name Type Description
errorMessage

string

Error message

events

SyncMigrationDatabaseErrorEvent[]

List of error events.

id

string

Result identifier

resultType string:

DatabaseLevelErrorOutput

Result type

MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel

Name Type Description
appliedChanges

integer

Number of applied changes

cdcDeleteCounter

integer

Number of cdc deletes

cdcInsertCounter

integer

Number of cdc inserts

cdcUpdateCounter

integer

Number of cdc updates

databaseName

string

Name of the database

endedOn

string

Migration end time

fullLoadCompletedTables

integer

Number of tables completed in full load

fullLoadErroredTables

integer

Number of tables errored in full load

fullLoadLoadingTables

integer

Number of tables loading in full load

fullLoadQueuedTables

integer

Number of tables queued in full load

id

string

Result identifier

incomingChanges

integer

Number of incoming changes

initializationCompleted

boolean

Indicates if initial load (full load) has been completed

latency

integer

CDC apply latency

migrationState

SyncDatabaseMigrationReportingState

Migration state that this database is in

resultType string:

DatabaseLevelOutput

Result type

startedOn

string

Migration start time

MigrateSqlServerSqlDbSyncTaskOutputError

Name Type Description
error

ReportableException

Migration error

id

string

Result identifier

resultType string:

ErrorOutput

Result type

MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel

Name Type Description
databaseCount

integer

Count of databases

endedOn

string

Migration end time

id

string

Result identifier

resultType string:

MigrationLevelOutput

Result type

sourceServer

string

Source server name

sourceServerVersion

string

Source server version

startedOn

string

Migration start time

targetServer

string

Target server name

targetServerVersion

string

Target server version

MigrateSqlServerSqlDbSyncTaskOutputTableLevel

Name Type Description
cdcDeleteCounter

integer

Number of applied deletes

cdcInsertCounter

integer

Number of applied inserts

cdcUpdateCounter

integer

Number of applied updates

dataErrorsCounter

integer

Number of data errors occurred

databaseName

string

Name of the database

fullLoadEndedOn

string

Full load end time

fullLoadEstFinishTime

string

Estimate to finish full load

fullLoadStartedOn

string

Full load start time

fullLoadTotalRows

integer

Number of rows applied in full load

id

string

Result identifier

lastModifiedTime

string

Last modified time on target

resultType string:

TableLevelOutput

Result type

state

SyncTableMigrationState

Current state of the table migration

tableName

string

Name of the table

totalChangesApplied

integer

Total number of applied changes

MigrateSqlServerSqlDbSyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MigrateSqlServerSqlDbSyncTaskInput

Task input

output MigrateSqlServerSqlDbSyncTaskOutput[]:

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

Migrate.SqlServer.AzureSqlDb.Sync

Task type.

MigrateSqlServerSqlDbTaskInput

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

Name Type Description
encryptedKeyForSecureFields

string

encrypted key for secure fields

selectedDatabases

MigrateSqlServerSqlDbDatabaseInput[]

Databases to migrate

sourceConnectionInfo

SqlConnectionInfo

Information for connecting to source

startedOn

string

Date and time relative to UTC when the migration was started on

targetConnectionInfo

SqlConnectionInfo

Information for connecting to target

validationOptions

MigrationValidationOptions

Options for enabling various post migration validations. Available options, 1.) Data Integrity Check: Performs a checksum based comparison on source and target tables after the migration to ensure the correctness of the data. 2.) Schema Validation: Performs a thorough schema comparison between the source and target tables and provides a list of differences between the source and target database, 3.) Query Analysis: Executes a set of queries picked up automatically either from the Query Plan Cache or Query Store and execute them and compares the execution time between the source and target database.

MigrateSqlServerSqlDbTaskOutputDatabaseLevel

Name Type Description
databaseName

string

Name of the item

endedOn

string

Migration end time

errorCount

integer

Number of database/object errors.

errorPrefix

string

Wildcard string prefix to use for querying all errors of the item

exceptionsAndWarnings

ReportableException[]

Migration exceptions and warnings.

id

string

Result identifier

message

string

Migration progress message

numberOfObjects

integer

Number of objects

numberOfObjectsCompleted

integer

Number of successfully completed objects

objectSummary

<string,  DataItemMigrationSummaryResult>

Summary of object results in the migration

resultPrefix

string

Wildcard string prefix to use for querying all sub-tem results of the item

resultType string:

DatabaseLevelOutput

Result type

stage

DatabaseMigrationStage

Migration stage that this database is in

startedOn

string

Migration start time

state

MigrationState

Current state of migration

statusMessage

string

Status message

MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult

Name Type Description
dataIntegrityValidationResult

DataIntegrityValidationResult

Provides data integrity validation result between the source and target tables that are migrated.

endedOn

string

Validation end time

id

string

Result identifier

migrationId

string

Migration Identifier

queryAnalysisValidationResult

QueryAnalysisValidationResult

Results of some of the query execution result between source and target database

resultType string:

MigrationDatabaseLevelValidationOutput

Result type

schemaValidationResult

SchemaComparisonValidationResult

Provides schema comparison result between source and target database

sourceDatabaseName

string

Name of the source database

startedOn

string

Validation start time

status

ValidationStatus

Current status of validation at the database level

targetDatabaseName

string

Name of the target database

MigrateSqlServerSqlDbTaskOutputError

Name Type Description
error

ReportableException

Migration error

id

string

Unique identifier for the exception

resultType string:

ErrorOutput

Result type

MigrateSqlServerSqlDbTaskOutputMigrationLevel

Name Type Description
databaseSummary

<string,  DatabaseSummaryResult>

Summary of database results in the migration

databases

object

Selected databases as a map from database name to database id

durationInSeconds

integer

Duration of task execution in seconds.

endedOn

string

Migration end time

exceptionsAndWarnings

ReportableException[]

Migration exceptions and warnings.

id

string

Result identifier

message

string

Migration progress message

migrationReportResult

MigrationReportResult

Migration Report Result, provides unique url for downloading your migration report.

migrationValidationResult MigrationValidationResult:

MigrateSqlServerSqlDbTaskOutputValidationResult

Migration Validation Results

resultType string:

MigrationLevelOutput

Result type

sourceServerBrandVersion

string

Source server brand version

sourceServerVersion

string

Source server version

startedOn

string

Migration start time

status

MigrationStatus

Current status of migration

statusMessage

string

Migration status message

targetServerBrandVersion

string

Target server brand version

targetServerVersion

string

Target server version

MigrateSqlServerSqlDbTaskOutputTableLevel

Name Type Description
endedOn

string

Migration end time

errorPrefix

string

Wildcard string prefix to use for querying all errors of the item

id

string

Result identifier

itemsCompletedCount

integer

Number of successfully completed items

itemsCount

integer

Number of items

objectName

string

Name of the item

resultPrefix

string

Wildcard string prefix to use for querying all sub-tem results of the item

resultType string:

TableLevelOutput

Result type

startedOn

string

Migration start time

state

MigrationState

Current state of migration

statusMessage

string

Status message

MigrateSqlServerSqlDbTaskOutputValidationResult

Name Type Description
id

string

Result identifier

migrationId

string

Migration Identifier

resultType string:

MigrationValidationOutput

Result type

status

ValidationStatus

Current status of validation at the migration level. Status from the database validation result status will be aggregated here.

summaryResults

<string,  MigrationValidationDatabaseSummaryResult>

Validation summary results for each database

MigrateSqlServerSqlDbTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

createdOn

string

DateTime in UTC when the task was created

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MigrateSqlServerSqlDbTaskInput

Task input

isCloneable

boolean

whether the task can be cloned or not

output MigrateSqlServerSqlDbTaskOutput[]:

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskId

string

task id

taskType string:

Migrate.SqlServer.SqlDb

Task type.

MigrateSqlServerSqlMIDatabaseInput

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

Name Type Description
backupFilePaths

string[]

The list of backup files to be used in case of existing backups.

backupFileShare

FileShare

Backup file share information for backing up this database.

id

string

id of the database

name

string

Name of the database

restoreDatabaseName

string

Name of the database at destination

MigrateSqlServerSqlMISyncTaskInput

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

Name Type Description
azureApp

AzureActiveDirectoryApp

Azure Active Directory Application the DMS (classic) instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account

backupFileShare

FileShare

Backup file share information for all selected databases.

numberOfParallelDatabaseMigrations

number

Number of database migrations to start in parallel

selectedDatabases

MigrateSqlServerSqlMIDatabaseInput[]

Databases to migrate

sourceConnectionInfo

SqlConnectionInfo

Connection information for source SQL Server

storageResourceId

string

Fully qualified resourceId of storage

targetConnectionInfo

MiSqlConnectionInfo

Connection information for Azure SQL Database Managed Instance

MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel

Name Type Description
activeBackupSets

BackupSetInfo[]

Backup sets that are currently active (Either being uploaded or getting restored)

containerName

string

Name of container created in the Azure Storage account where backups are copied to

endedOn

string

Database migration end time

errorPrefix

string

prefix string to use for querying errors for this database

exceptionsAndWarnings

ReportableException[]

Migration exceptions and warnings

fullBackupSetInfo

BackupSetInfo

Details of full backup set

id

string

Result identifier

isFullBackupRestored

boolean

Whether full backup has been applied to the target database or not

lastRestoredBackupSetInfo

BackupSetInfo

Last applied backup set information

migrationState

DatabaseMigrationState

Current state of database

resultType string:

DatabaseLevelOutput

Result type

sourceDatabaseName

string

Name of the database

startedOn

string

Database migration start time

MigrateSqlServerSqlMISyncTaskOutputError

Name Type Description
error

ReportableException

Migration error

id

string

Unique identifier for the exception

resultType string:

ErrorOutput

Result type

MigrateSqlServerSqlMISyncTaskOutputMigrationLevel

Name Type Description
databaseCount

integer

Count of databases

databaseErrorCount

integer

Number of database level errors

endedOn

string

Migration end time

id

string

Result identifier

resultType string:

MigrationLevelOutput

Result type

sourceServerBrandVersion

string

Source server brand version

sourceServerName

string

Source server name

sourceServerVersion

string

Source server version

startedOn

string

Migration start time

state

MigrationState

Current state of migration

targetServerBrandVersion

string

Target server brand version

targetServerName

string

Target server name

targetServerVersion

string

Target server version

MigrateSqlServerSqlMISyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

createdOn

string

DateTime in UTC when the task was created

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MigrateSqlServerSqlMISyncTaskInput

Task input

output MigrateSqlServerSqlMISyncTaskOutput[]:

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

Migrate.SqlServer.AzureSqlDbMI.Sync.LRS

Task type.

MigrateSqlServerSqlMITaskInput

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

Name Type Description
aadDomainName

string

Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected

backupBlobShare

BlobShare

SAS URI of Azure Storage Account Container to be used for storing backup files.

backupFileShare

FileShare

Backup file share information for all selected databases.

backupMode

BackupMode

Backup Mode to specify whether to use existing backup or create new backup. If using existing backups, backup file paths are required to be provided in selectedDatabases.

encryptedKeyForSecureFields

string

encrypted key for secure fields

selectedAgentJobs

string[]

Agent Jobs to migrate.

selectedDatabases

MigrateSqlServerSqlMIDatabaseInput[]

Databases to migrate

selectedLogins

string[]

Logins to migrate.

sourceConnectionInfo

SqlConnectionInfo

Information for connecting to source

startedOn

string

Date and time relative to UTC when the migration was started on

targetConnectionInfo

SqlConnectionInfo

Information for connecting to target

MigrateSqlServerSqlMITaskOutputAgentJobLevel

Name Type Description
endedOn

string

Migration end time

exceptionsAndWarnings

ReportableException[]

Migration errors and warnings per job

id

string

Result identifier

isEnabled

boolean

The state of the original Agent Job.

message

string

Migration progress message

name

string

Agent Job name.

resultType string:

AgentJobLevelOutput

Result type

startedOn

string

Migration start time

state

MigrationState

Current state of migration

MigrateSqlServerSqlMITaskOutputDatabaseLevel

Name Type Description
databaseName

string

Name of the database

endedOn

string

Migration end time

exceptionsAndWarnings

ReportableException[]

Migration exceptions and warnings

id

string

Result identifier

message

string

Migration progress message

resultType string:

DatabaseLevelOutput

Result type

sizeMB

number

Size of the database in megabytes

stage

DatabaseMigrationStage

Current stage of migration

startedOn

string

Migration start time

state

MigrationState

Current state of migration

MigrateSqlServerSqlMITaskOutputError

Name Type Description
error

ReportableException

Migration error

id

string

Unique identifier for the exception

resultType string:

ErrorOutput

Result type

MigrateSqlServerSqlMITaskOutputLoginLevel

Name Type Description
endedOn

string

Login migration end time

exceptionsAndWarnings

ReportableException[]

Login migration errors and warnings per login

id

string

Result identifier

loginName

string

Login name.

message

string

Login migration progress message

resultType string:

LoginLevelOutput

Result type

stage

LoginMigrationStage

Current stage of login

startedOn

string

Login migration start time

state

MigrationState

Current state of login

MigrateSqlServerSqlMITaskOutputMigrationLevel

Name Type Description
agentJobs

object

Selected agent jobs as a map from name to id

databases

object

Selected databases as a map from database name to database id

endedOn

string

Migration end time

exceptionsAndWarnings

ReportableException[]

Migration exceptions and warnings.

id

string

Result identifier

logins

object

Selected logins as a map from name to id

message

string

Migration progress message

orphanedUsersInfo

OrphanedUserInfo[]

List of orphaned users.

resultType string:

MigrationLevelOutput

Result type

serverRoleResults

<string,  StartMigrationScenarioServerRoleResult>

Map of server role migration results.

sourceServerBrandVersion

string

Source server brand version

sourceServerVersion

string

Source server version

startedOn

string

Migration start time

state

MigrationState

Current state of migration

status

MigrationStatus

Current status of migration

targetServerBrandVersion

string

Target server brand version

targetServerVersion

string

Target server version

MigrateSqlServerSqlMITaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

createdOn

string

DateTime in UTC when the task was created

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MigrateSqlServerSqlMITaskInput

Task input

isCloneable

boolean

whether the task can be cloned or not

output MigrateSqlServerSqlMITaskOutput[]:

Task output. This is ignored if submitted.

parentTaskId

string

parent task id

state

TaskState

The state of the task. This is ignored if submitted.

taskId

string

task id

taskType string:

Migrate.SqlServer.AzureSqlDbMI

Task type.

MigrateSsisTaskInput

Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance.

Name Type Description
sourceConnectionInfo

SqlConnectionInfo

Information for connecting to source

ssisMigrationInfo

SsisMigrationInfo

SSIS package migration information.

targetConnectionInfo

SqlConnectionInfo

Information for connecting to target

MigrateSsisTaskOutputMigrationLevel

Name Type Description
endedOn

string

Migration end time

exceptionsAndWarnings

ReportableException[]

Migration exceptions and warnings.

id

string

Result identifier

message

string

Migration progress message

resultType string:

MigrationLevelOutput

Result type

sourceServerBrandVersion

string

Source server brand version

sourceServerVersion

string

Source server version

stage

SsisMigrationStage

Stage of SSIS migration.

startedOn

string

Migration start time

status

MigrationStatus

Current status of migration

targetServerBrandVersion

string

Target server brand version

targetServerVersion

string

Target server version

MigrateSsisTaskOutputProjectLevel

Name Type Description
endedOn

string

Migration end time

exceptionsAndWarnings

ReportableException[]

Migration exceptions and warnings

folderName

string

Name of the folder

id

string

Result identifier

message

string

Migration progress message

projectName

string

Name of the project

resultType string:

SsisProjectLevelOutput

Result type

stage

SsisMigrationStage

Stage of SSIS migration.

startedOn

string

Migration start time

state

MigrationState

Current state of migration

MigrateSsisTaskProperties

Properties for task that migrates SSIS packages from SQL Server databases to Azure SQL Database Managed Instance.

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MigrateSsisTaskInput

Task input

output MigrateSsisTaskOutput[]:

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

Migrate.Ssis

Task type.

MigrateSyncCompleteCommandInput

Input for command that completes sync migration for a database.

Name Type Description
commitTimeStamp

string

Time stamp to complete

databaseName

string

Name of database

MigrateSyncCompleteCommandOutput

Output for command that completes sync migration for a database.

Name Type Description
errors

ReportableException[]

List of errors that happened during the command execution

id

string

Result identifier

MigrateSyncCompleteCommandProperties

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

Name Type Description
commandId

string

Command id

commandType string:

Migrate.Sync.Complete.Database

Command type.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MigrateSyncCompleteCommandInput

Command input

output

MigrateSyncCompleteCommandOutput

Command output. This is ignored if submitted.

state

CommandState

The state of the command. This is ignored if submitted.

MigrationEligibilityInfo

Information about migration eligibility of a server object

Name Type Description
isEligibleForMigration

boolean

Whether object is eligible for migration or not.

validationMessages

string[]

Information about eligibility failure for the server object.

MigrationReportResult

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

Name Type Description
id

string

Migration validation result identifier

reportUrl

string

The url of the report.

MigrationState

Current state of migration

Name Type Description
Completed

string

Failed

string

InProgress

string

None

string

Skipped

string

Stopped

string

Warning

string

MigrationStatus

Current status of migration

Name Type Description
Completed

string

CompletedWithWarnings

string

Configured

string

Connecting

string

Default

string

Error

string

Running

string

SelectLogins

string

SourceAndTargetSelected

string

Stopped

string

MigrationValidationDatabaseSummaryResult

Migration Validation Database level summary result

Name Type Description
endedOn

string

Validation end time

id

string

Result identifier

migrationId

string

Migration Identifier

sourceDatabaseName

string

Name of the source database

startedOn

string

Validation start time

status

ValidationStatus

Current status of validation at the database level

targetDatabaseName

string

Name of the target database

MigrationValidationOptions

Types of validations to run after the migration

Name Type Description
enableDataIntegrityValidation

boolean

Allows to perform a checksum based data integrity validation between source and target for the selected database / tables .

enableQueryAnalysisValidation

boolean

Allows to perform a quick and intelligent query analysis by retrieving queries from the source database and executes them in the target. The result will have execution statistics for executions in source and target databases for the extracted queries.

enableSchemaValidation

boolean

Allows to compare the schema information between source and target.

MigrationValidationResult

Migration Validation Result

Name Type Description
id

string

Migration validation result identifier

migrationId

string

Migration Identifier

status

ValidationStatus

Current status of validation at the migration level. Status from the database validation result status will be aggregated here.

summaryResults

<string,  MigrationValidationDatabaseSummaryResult>

Validation summary results for each database

MiSqlConnectionInfo

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

Name Type Description
managedInstanceResourceId

string

Resource id for Azure SQL database Managed instance

password

string

Password credential.

type string:

MiSqlConnectionInfo

Type of connection info

userName

string

User name

MongoDbClusterInfo

Describes a MongoDB data source

Name Type Description
databases

MongoDbDatabaseInfo[]

A list of non-system databases in the cluster

supportsSharding

boolean

Whether the cluster supports sharded collections

type

MongoDbClusterType

The type of data source

version

string

The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer.

MongoDbClusterType

The type of data source

Name Type Description
BlobContainer

string

CosmosDb

string

MongoDb

string

MongoDbCollectionInfo

Describes a supported collection within a MongoDB database

Name Type Description
averageDocumentSize

integer

The average document size, or -1 if the average size is unknown

dataSize

integer

The estimated total data size, in bytes, or -1 if the size is unknown.

databaseName

string

The name of the database containing the collection

documentCount

integer

The estimated total number of documents, or -1 if the document count is unknown

isCapped

boolean

Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer)

isSystemCollection

boolean

Whether the collection is system collection

isView

boolean

Whether the collection is a view of another collection

name

string

The unqualified name of the database or collection

qualifiedName

string

The qualified name of the database or collection. For a collection, this is the database-qualified name.

shardKey

MongoDbShardKeyInfo

The shard key on the collection, or null if the collection is not sharded

supportsSharding

boolean

Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary.

viewOf

string

The name of the collection that this is a view of, if IsView is true

MongoDbCollectionProgress

Describes the progress of a collection

Name Type Description
bytesCopied

integer

The number of document bytes copied during the Copying stage

documentsCopied

integer

The number of documents copied during the Copying stage

elapsedTime

string

The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)

errors

<string,  MongoDbError>

The errors and warnings that have occurred for the current object. The keys are the error codes.

eventsPending

integer

The number of oplog events awaiting replay

eventsReplayed

integer

The number of oplog events replayed so far

lastEventTime

string

The timestamp of the last oplog event received, or null if no oplog event has been received yet

lastReplayTime

string

The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet

name

string

The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null.

qualifiedName

string

The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null.

resultType string:

Collection

The type of progress object

state

MongoDbMigrationState

totalBytes

integer

The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown

totalDocuments

integer

The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown

MongoDbCollectionSettings

Describes how an individual MongoDB collection should be migrated

Name Type Description
canDelete

boolean

Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true.

shardKey

MongoDbShardKeySetting

Describes a MongoDB shard key

targetRUs

integer

The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets.

MongoDbConnectionInfo

Describes a connection to a MongoDB data source

Name Type Default value Description
additionalSettings

string

Additional connection settings

authentication

AuthenticationType

Authentication type to use for connection

connectionString

string

A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties

dataSource

string

Data source

encryptConnection

boolean

Whether to encrypt the connection

enforceSSL

boolean

password

string

Password credential.

port

integer

port for server

serverBrandVersion

string

server brand version

serverName

string

name of the server

serverVersion

string

server version

trustServerCertificate

boolean

False

Whether to trust the server certificate

type

string

Type of connection info

userName

string

User name

MongoDbDatabaseInfo

Describes a database within a MongoDB data source

Name Type Description
averageDocumentSize

integer

The average document size, or -1 if the average size is unknown

collections

MongoDbCollectionInfo[]

A list of supported collections in a MongoDB database

dataSize

integer

The estimated total data size, in bytes, or -1 if the size is unknown.

documentCount

integer

The estimated total number of documents, or -1 if the document count is unknown

name

string

The unqualified name of the database or collection

qualifiedName

string

The qualified name of the database or collection. For a collection, this is the database-qualified name.

supportsSharding

boolean

Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary.

MongoDbDatabaseProgress

Describes the progress of a database

Name Type Description
bytesCopied

integer

The number of document bytes copied during the Copying stage

collections

object

The progress of the collections in the database. The keys are the unqualified names of the collections

documentsCopied

integer

The number of documents copied during the Copying stage

elapsedTime

string

The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)

errors

<string,  MongoDbError>

The errors and warnings that have occurred for the current object. The keys are the error codes.

eventsPending

integer

The number of oplog events awaiting replay

eventsReplayed

integer

The number of oplog events replayed so far

lastEventTime

string

The timestamp of the last oplog event received, or null if no oplog event has been received yet

lastReplayTime

string

The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet

name

string

The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null.

qualifiedName

string

The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null.

resultType string:

Database

The type of progress object

state

MongoDbMigrationState

totalBytes

integer

The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown

totalDocuments

integer

The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown

MongoDbDatabaseSettings

Describes how an individual MongoDB database should be migrated

Name Type Description
collections

<string,  MongoDbCollectionSettings>

The collections on the source database to migrate to the target. The keys are the unqualified names of the collections.

targetRUs

integer

The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets.

MongoDbError

Describes an error or warning that occurred during a MongoDB migration

Name Type Description
code

string

The non-localized, machine-readable code that describes the error or warning

count

integer

The number of times the error or warning has occurred

message

string

The localized, human-readable message that describes the error or warning

type

MongoDbErrorType

The type of error or warning

MongoDbErrorType

The type of error or warning

Name Type Description
Error

string

ValidationError

string

Warning

string

MongoDbMigrationProgress

Describes the progress of the overall migration

Name Type Description
bytesCopied

integer

The number of document bytes copied during the Copying stage

databases

<string,  MongoDbDatabaseProgress>

The progress of the databases in the migration. The keys are the names of the databases

documentsCopied

integer

The number of documents copied during the Copying stage

elapsedTime

string

The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)

errors

<string,  MongoDbError>

The errors and warnings that have occurred for the current object. The keys are the error codes.

eventsPending

integer

The number of oplog events awaiting replay

eventsReplayed

integer

The number of oplog events replayed so far

lastEventTime

string

The timestamp of the last oplog event received, or null if no oplog event has been received yet

lastReplayTime

string

The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet

name

string

The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null.

qualifiedName

string

The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null.

resultType string:

Migration

The type of progress object

state

MongoDbMigrationState

totalBytes

integer

The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown

totalDocuments

integer

The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown

MongoDbMigrationSettings

Describes how a MongoDB data migration should be performed

Name Type Description
boostRUs

integer

The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets.

databases

<string,  MongoDbDatabaseSettings>

The databases on the source cluster to migrate to the target. The keys are the names of the databases.

replication

MongoDbReplication

Describes how changes will be replicated from the source to the target. The default is OneTime.

source

MongoDbConnectionInfo

Settings used to connect to the source cluster

target

MongoDbConnectionInfo

Settings used to connect to the target cluster

throttling

MongoDbThrottlingSettings

Settings used to limit the resource usage of the migration

MongoDbMigrationState

Name Type Description
Canceled

string

Complete

string

Copying

string

Failed

string

Finalizing

string

InitialReplay

string

Initializing

string

NotStarted

string

Replaying

string

Restarting

string

ValidatingInput

string

MongoDbReplication

Describes how changes will be replicated from the source to the target. The default is OneTime.

Name Type Description
Continuous

string

Disabled

string

OneTime

string

MongoDbShardKeyField

Describes a field reference within a MongoDB shard key

Name Type Description
name

string

The name of the field

order

MongoDbShardKeyOrder

The field ordering

MongoDbShardKeyInfo

Describes a MongoDB shard key

Name Type Description
fields

MongoDbShardKeyField[]

The fields within the shard key

isUnique

boolean

Whether the shard key is unique

MongoDbShardKeyOrder

The field ordering

Name Type Description
Forward

string

Hashed

string

Reverse

string

MongoDbShardKeySetting

Describes a MongoDB shard key

Name Type Description
fields

MongoDbShardKeyField[]

The fields within the shard key

isUnique

boolean

Whether the shard key is unique

MongoDbThrottlingSettings

Specifies resource limits for the migration

Name Type Description
maxParallelism

integer

The maximum number of work items (e.g. collection copies) that will be processed in parallel

minFreeCpu

integer

The percentage of CPU time that the migrator will try to avoid using, from 0 to 100

minFreeMemoryMb

integer

The number of megabytes of RAM that the migrator will try to avoid using

MySqlConnectionInfo

Information for connecting to MySQL server

Name Type Default value Description
additionalSettings

string

Additional connection settings

authentication

AuthenticationType

Authentication type to use for connection

dataSource

string

Data source

encryptConnection

boolean

True

Whether to encrypt the connection

password

string

Password credential.

port

integer

Port for Server

serverName

string

Name of the server

type string:

MySqlConnectionInfo

Type of connection info

userName

string

User name

MySqlTargetPlatformType

Target Platform for the migration

Name Type Description
AzureDbForMySQL

string

SqlServer

string

ObjectType

Type of the object that has the difference. e.g (Table/View/StoredProcedure)

Name Type Description
Function

string

StoredProcedures

string

Table

string

User

string

View

string

ODataError

Error information in OData format.

Name Type Description
code

string

The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError'

details

ODataError[]

Inner errors that caused this error

message

string

The human-readable description of the error

OracleConnectionInfo

Information for connecting to Oracle server

Name Type Description
authentication

AuthenticationType

Authentication type to use for connection

dataSource

string

EZConnect or TNSName connection string.

password

string

Password credential.

port

integer

port for server

serverName

string

name of the server

serverVersion

string

server version

type string:

OracleConnectionInfo

Type of connection info

userName

string

User name

OrphanedUserInfo

Information of orphaned users on the SQL server database.

Name Type Description
databaseName

string

Parent database of the user

name

string

Name of the orphaned user

PostgreSqlConnectionInfo

Information for connecting to PostgreSQL server

Name Type Default value Description
additionalSettings

string

Additional connection settings

authentication

AuthenticationType

Authentication type to use for connection

dataSource

string

Data source

databaseName

string

Name of the database

encryptConnection

boolean

True

Whether to encrypt the connection

password

string

Password credential.

port

integer

Port for Server

serverBrandVersion

string

server brand version

serverName

string

Name of the server

serverVersion

string

server version

trustServerCertificate

boolean

False

Whether to trust the server certificate

type string:

PostgreSqlConnectionInfo

Type of connection info

userName

string

User name

ProjectTask

A task resource

Name Type Description
etag

string

HTTP strong entity tag value. This is ignored if submitted.

id

string

Resource ID.

name

string

Resource name.

properties ProjectTaskProperties:

Custom task properties

systemData

SystemData

Metadata pertaining to creation and last modification of the resource.

type

string

Resource type.

QueryAnalysisValidationResult

Results for query analysis comparison between the source and target

Name Type Description
queryResults

QueryExecutionResult

List of queries executed and it's execution results in source and target

validationErrors

ValidationError

Errors that are part of the execution

QueryExecutionResult

Describes query analysis results for execution in source and target

Name Type Description
queryText

string

Query text retrieved from the source server

sourceResult

ExecutionStatistics

Query analysis result from the source

statementsInBatch

integer

Total no. of statements in the batch

targetResult

ExecutionStatistics

Query analysis result from the target

ReplicateMigrationState

Wrapper for replicate reported migration states.

Name Type Description
ACTION_REQUIRED

string

COMPLETE

string

FAILED

string

PENDING

string

UNDEFINED

string

VALIDATING

string

ReportableException

Exception object for all custom exceptions

Name Type Description
actionableMessage

string

Actionable steps for this exception

filePath

string

The path to the file where exception occurred

hResult

integer

Coded numerical value that is assigned to a specific exception

lineNumber

string

The line number where exception occurred

message

string

Error message

stackTrace

string

Stack trace

ScenarioSource

An enumeration of source type

Name Type Description
Access

string

DB2

string

MongoDB

string

MySQL

string

MySQLRDS

string

Oracle

string

PostgreSQL

string

PostgreSQLRDS

string

SQL

string

SQLRDS

string

Sybase

string

ScenarioTarget

An enumeration of target type

Name Type Description
AzureDBForMySql

string

AzureDBForPostgresSQL

string

MongoDB

string

SQLDB

string

SQLDW

string

SQLMI

string

SQLServer

string

SchemaComparisonValidationResult

Results for schema comparison between the source and target

Name Type Description
schemaDifferences

SchemaComparisonValidationResultType

List of schema differences between the source and target databases

sourceDatabaseObjectCount

object

Count of source database objects

targetDatabaseObjectCount

object

Count of target database objects

validationErrors

ValidationError

List of errors that happened while performing schema compare validation

SchemaComparisonValidationResultType

Description about the errors happen while performing migration validation

Name Type Description
objectName

string

Name of the object that has the difference

objectType

ObjectType

Type of the object that has the difference. e.g (Table/View/StoredProcedure)

updateAction

UpdateActionType

Update action type with respect to target

SelectedCertificateInput

Info for certificate to be exported for TDE enabled databases.

Name Type Description
certificateName

string

Name of certificate to be exported.

password

string

Password to use for encrypting the exported certificate.

ServerLevelPermissionsGroup

Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing.

Name Type Description
Default

string

MigrationFromMySQLToAzureDBForMySQL

string

MigrationFromSqlServerToAzureDB

string

MigrationFromSqlServerToAzureMI

string

MigrationFromSqlServerToAzureVM

string

ServerProperties

Server properties for MySQL type source

Name Type Description
serverDatabaseCount

integer

Number of databases in the server

serverEdition

string

Edition of the database server

serverName

string

Name of the server

serverOperatingSystemVersion

string

Version of the operating system

serverPlatform

string

Name of the server platform

serverVersion

string

Version of the database server

Severity

Severity of the validation error

Name Type Description
Error

string

Message

string

Warning

string

SqlConnectionInfo

Information for connecting to SQL database server

Name Type Default value Description
additionalSettings

string

Additional connection settings

authentication

AuthenticationType

Authentication type to use for connection

dataSource

string

Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber

encryptConnection

boolean

True

Whether to encrypt the connection

password

string

Password credential.

platform

SqlSourcePlatform

Server platform type for connection

port

integer

Port for Server

resourceId

string

Represents the ID of an HTTP resource represented by an Azure resource provider.

serverBrandVersion

string

server brand version

serverName

string

name of the server

serverVersion

string

server version

trustServerCertificate

boolean

False

Whether to trust the server certificate

type string:

SqlConnectionInfo

Type of connection info

userName

string

User name

SqlSourcePlatform

Server platform type for connection

Name Type Description
SqlOnPrem

string

SsisMigrationInfo

SSIS migration info with SSIS store type, overwrite policy.

Name Type Description
environmentOverwriteOption

SsisMigrationOverwriteOption

The overwrite option for the SSIS environment migration

projectOverwriteOption

SsisMigrationOverwriteOption

The overwrite option for the SSIS project migration

ssisStoreType

SsisStoreType

The SSIS store type of source, only SSIS catalog is supported now in DMS (classic)

SsisMigrationOverwriteOption

The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS (classic) now and future may add Reuse option for container object

Name Type Description
Ignore

string

Overwrite

string

SsisMigrationStage

Current stage of SSIS migration

Name Type Description
Completed

string

InProgress

string

Initialize

string

None

string

SsisStoreType

An enumeration of supported source SSIS store type in DMS (classic)

Name Type Description
SsisCatalog

string

StartMigrationScenarioServerRoleResult

Server role migration result

Name Type Description
exceptionsAndWarnings

ReportableException[]

Migration exceptions and warnings.

name

string

Name of server role.

state

MigrationState

Current state of migration

SyncDatabaseMigrationReportingState

Enum of the different state of database level online migration.

Name Type Description
BACKUP_COMPLETED

string

BACKUP_IN_PROGRESS

string

CANCELLED

string

CANCELLING

string

COMPLETE

string

COMPLETING

string

CONFIGURING

string

FAILED

string

INITIALIAZING

string

READY_TO_COMPLETE

string

RESTORE_COMPLETED

string

RESTORE_IN_PROGRESS

string

RUNNING

string

STARTING

string

UNDEFINED

string

VALIDATING

string

VALIDATION_COMPLETE

string

VALIDATION_FAILED

string

SyncMigrationDatabaseErrorEvent

Database migration errors for online migration

Name Type Description
eventText

string

Event text.

eventTypeString

string

Event type.

timestampString

string

String value of timestamp.

SyncTableMigrationState

Enum of the different state of table level online migration.

Name Type Description
BEFORE_LOAD

string

CANCELED

string

COMPLETED

string

ERROR

string

FAILED

string

FULL_LOAD

string

SystemData

Name Type Description
createdAt

string

createdBy

string

createdByType

createdByType

lastModifiedAt

string

lastModifiedBy

string

lastModifiedByType

createdByType

TaskState

The state of the task. This is ignored if submitted.

Name Type Description
Canceled

string

Failed

string

FailedInputValidation

string

Faulted

string

Queued

string

Running

string

Succeeded

string

Unknown

string

UpdateActionType

Type of the actual difference for the compared object, while performing schema comparison

Name Type Description
AddedOnTarget

string

ChangedOnTarget

string

DeletedOnTarget

string

ValidateMigrationInputSqlServerSqlDbSyncTaskProperties

Properties for task that validates migration input for SQL to Azure SQL DB sync migrations

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ValidateSyncMigrationInputSqlServerTaskInput

Task input

output

ValidateSyncMigrationInputSqlServerTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ValidateMigrationInput.SqlServer.SqlDb.Sync

Task type.

ValidateMigrationInputSqlServerSqlMISyncTaskInput

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

Name Type Description
azureApp

AzureActiveDirectoryApp

Azure Active Directory Application the DMS (classic) instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account

backupFileShare

FileShare

Backup file share information for all selected databases.

selectedDatabases

MigrateSqlServerSqlMIDatabaseInput[]

Databases to migrate

sourceConnectionInfo

SqlConnectionInfo

Connection information for source SQL Server

storageResourceId

string

Fully qualified resourceId of storage

targetConnectionInfo

MiSqlConnectionInfo

Connection information for Azure SQL Database Managed Instance

ValidateMigrationInputSqlServerSqlMISyncTaskOutput

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

Name Type Description
id

string

Database identifier

name

string

Name of database

validationErrors

ReportableException[]

Errors associated with a selected database object

ValidateMigrationInputSqlServerSqlMISyncTaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ValidateMigrationInputSqlServerSqlMISyncTaskInput

Task input

output

ValidateMigrationInputSqlServerSqlMISyncTaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS

Task type.

ValidateMigrationInputSqlServerSqlMITaskInput

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

Name Type Description
backupBlobShare

BlobShare

SAS URI of Azure Storage Account Container to be used for storing backup files.

backupFileShare

FileShare

Backup file share information for all selected databases.

backupMode

BackupMode

Backup Mode to specify whether to use existing backup or create new backup.

selectedDatabases

MigrateSqlServerSqlMIDatabaseInput[]

Databases to migrate

selectedLogins

string[]

Logins to migrate

sourceConnectionInfo

SqlConnectionInfo

Information for connecting to source

targetConnectionInfo

SqlConnectionInfo

Information for connecting to target

ValidateMigrationInputSqlServerSqlMITaskOutput

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

Name Type Description
backupFolderErrors

ReportableException[]

Errors associated with the BackupFolder path

backupShareCredentialsErrors

ReportableException[]

Errors associated with backup share user name and password credentials

backupStorageAccountErrors

ReportableException[]

Errors associated with the storage account provided.

databaseBackupInfo

DatabaseBackupInfo

Information about backup files when existing backup mode is used.

existingBackupErrors

ReportableException[]

Errors associated with existing backup files.

id

string

Result identifier

name

string

Name of database

restoreDatabaseNameErrors

ReportableException[]

Errors associated with the RestoreDatabaseName

ValidateMigrationInputSqlServerSqlMITaskProperties

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

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

ValidateMigrationInputSqlServerSqlMITaskInput

Task input

output

ValidateMigrationInputSqlServerSqlMITaskOutput[]

Task output. This is ignored if submitted.

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

ValidateMigrationInput.SqlServer.AzureSqlDbMI

Task type.

ValidateMongoDbTaskProperties

Properties for the task that validates a migration between MongoDB data sources

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MongoDbMigrationSettings

Describes how a MongoDB data migration should be performed

output

MongoDbMigrationProgress[]

An array containing a single MongoDbMigrationProgress object

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

Validate.MongoDb

Task type.

ValidateOracleAzureDbForPostgreSqlSyncTaskProperties

Properties for the task that validates a migration for Oracle to Azure Database for PostgreSQL for online migrations

Name Type Description
clientData

object

Key value pairs of client data to attach meta data information to task

commands CommandProperties[]:

Array of command properties.

errors

ODataError[]

Array of errors. This is ignored if submitted.

input

MigrateOracleAzureDbPostgreSqlSyncTaskInput

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

output

ValidateOracleAzureDbPostgreSqlSyncTaskOutput[]

An array containing a single validation error response object

state

TaskState

The state of the task. This is ignored if submitted.

taskType string:

Validate.Oracle.AzureDbPostgreSql.Sync

Task type.

ValidateOracleAzureDbPostgreSqlSyncTaskOutput

Output for task that validates migration input for Oracle to Azure Database for PostgreSQL for online migrations

Name Type Description
validationErrors

ReportableException[]

Errors associated with a selected database object

ValidateSyncMigrationInputSqlServerTaskInput

Input for task that validates migration input for SQL sync migrations

Name Type Description
selectedDatabases

MigrateSqlServerSqlDbSyncDatabaseInput[]

Databases to migrate

sourceConnectionInfo

SqlConnectionInfo

Information for connecting to source SQL server

targetConnectionInfo

SqlConnectionInfo

Information for connecting to target

ValidateSyncMigrationInputSqlServerTaskOutput

Output for task that validates migration input for SQL sync migrations

Name Type Description
id

string

Database identifier

name

string

Name of database

validationErrors

ReportableException[]

Errors associated with a selected database object

ValidationError

Description about the errors happen while performing migration validation

Name Type Description
severity

Severity

Severity of the error

text

string

Error Text

ValidationStatus

Current status of the validation

Name Type Description
Completed

string

CompletedWithIssues

string

Default

string

Failed

string

InProgress

string

Initialized

string

NotStarted

string

Stopped

string

WaitStatistics

Wait statistics gathered during query batch execution

Name Type Default value Description
waitCount

integer

Total no. of waits

waitTimeMs

number

0

Total wait time in millisecond(s)

waitType

string

Type of the Wait