azure.mgmt.datamigration.models module

class azure.mgmt.datamigration.models.ApiError(*, error: Optional[_models.ODataError] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Error information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • error (ODataError) – Error information in OData format.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments

error (ODataError) – Error information in OData format.

class azure.mgmt.datamigration.models.AuthenticationKeys(*, auth_key1: Optional[str] = None, auth_key2: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

An authentication key.

Variables

  • auth_key1 (str) – The first authentication key.

  • auth_key2 (str) – The second authentication key.

Keyword Arguments

  • auth_key1 (str) – The first authentication key.

  • auth_key2 (str) – The second authentication key.

class azure.mgmt.datamigration.models.AuthenticationType(value)[source]

Bases: str, enum.Enum

An enumeration of possible authentication types when connecting.

ACTIVE_DIRECTORY_INTEGRATED = 'ActiveDirectoryIntegrated'
ACTIVE_DIRECTORY_PASSWORD = 'ActiveDirectoryPassword'
NONE = 'None'
SQL_AUTHENTICATION = 'SqlAuthentication'
WINDOWS_AUTHENTICATION = 'WindowsAuthentication'
class azure.mgmt.datamigration.models.AvailableServiceSku(*, resource_type: Optional[str] = None, sku: Optional[_models.AvailableServiceSkuSku] = None, capacity: Optional[_models.AvailableServiceSkuCapacity] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes the available service SKU.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.AvailableServiceSkuCapacity(*, minimum: Optional[int] = None, maximum: Optional[int] = None, default: Optional[int] = None, scale_type: Optional[Union[str, _models.ServiceScalability]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

A description of the scaling capacities of the SKU.

Variables

  • minimum (int) – The minimum capacity, usually 0 or 1.

  • maximum (int) – The maximum capacity.

  • default (int) – The default capacity.

  • scale_type (str or ServiceScalability) – The scalability approach. Known values are: “none”, “manual”, and “automatic”.

Keyword Arguments

  • minimum (int) – The minimum capacity, usually 0 or 1.

  • maximum (int) – The maximum capacity.

  • default (int) – The default capacity.

  • scale_type (str or ServiceScalability) – The scalability approach. Known values are: “none”, “manual”, and “automatic”.

class azure.mgmt.datamigration.models.AvailableServiceSkuSku(*, name: Optional[str] = None, family: Optional[str] = None, size: Optional[str] = None, tier: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

SKU name, tier, etc.

Variables

  • name (str) – The name of the SKU.

  • family (str) – SKU family.

  • size (str) – SKU size.

  • tier (str) – The tier of the SKU, such as “Basic”, “General Purpose”, or “Business Critical”.

Keyword Arguments

  • name (str) – The name of the SKU.

  • family (str) – SKU family.

  • size (str) – SKU size.

  • tier (str) – The tier of the SKU, such as “Basic”, “General Purpose”, or “Business Critical”.

class azure.mgmt.datamigration.models.AzureActiveDirectoryApp(*, application_id: Optional[str] = None, app_key: Optional[str] = None, tenant_id: Optional[str] = None, ignore_azure_permissions: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Azure Active Directory Application.

Variables

  • application_id (str) – Application ID of the Azure Active Directory Application.

  • app_key (str) – Key used to authenticate to the Azure Active Directory Application.

  • tenant_id (str) – Tenant id of the customer.

  • ignore_azure_permissions (bool) – Ignore checking azure permissions on the AAD app.

Keyword Arguments

  • application_id (str) – Application ID of the Azure Active Directory Application.

  • app_key (str) – Key used to authenticate to the Azure Active Directory Application.

  • tenant_id (str) – Tenant id of the customer.

  • ignore_azure_permissions (bool) – Ignore checking azure permissions on the AAD app.

class azure.mgmt.datamigration.models.AzureBlob(*, storage_account_resource_id: Optional[str] = None, account_key: Optional[str] = None, blob_container_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Azure Blob Details.

Variables

  • storage_account_resource_id (str) – Resource Id of the storage account where backups are stored.

  • account_key (str) – Storage Account Key.

  • blob_container_name (str) – Blob container name where backups are stored.

Keyword Arguments

  • storage_account_resource_id (str) – Resource Id of the storage account where backups are stored.

  • account_key (str) – Storage Account Key.

  • blob_container_name (str) – Blob container name where backups are stored.

class azure.mgmt.datamigration.models.BackupConfiguration(*, source_location: Optional[_models.SourceLocation] = None, target_location: Optional[_models.TargetLocation] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Backup Configuration.

Variables

  • source_location (SourceLocation) – Source location of backups.

  • target_location (TargetLocation) – Target location for copying backups.

Keyword Arguments

  • source_location (SourceLocation) – Source location of backups.

  • target_location (TargetLocation) – Target location for copying backups.

class azure.mgmt.datamigration.models.BackupFileInfo(*, file_location: Optional[str] = None, family_sequence_number: Optional[int] = None, status: Optional[Union[str, _models.BackupFileStatus]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Information of the backup file.

Variables

  • file_location (str) – Location of the backup file in shared folder.

  • family_sequence_number (int) – Sequence number of the backup file in the backup set.

  • status (str or BackupFileStatus) – Status of the backup file during migration. Known values are: “Arrived”, “Queued”, “Uploading”, “Uploaded”, “Restoring”, “Restored”, and “Cancelled”.

Keyword Arguments

  • file_location (str) – Location of the backup file in shared folder.

  • family_sequence_number (int) – Sequence number of the backup file in the backup set.

  • status (str or BackupFileStatus) – Status of the backup file during migration. Known values are: “Arrived”, “Queued”, “Uploading”, “Uploaded”, “Restoring”, “Restored”, and “Cancelled”.

class azure.mgmt.datamigration.models.BackupFileStatus(value)[source]

Bases: str, enum.Enum

An enumeration of Status of the log backup file.

ARRIVED = 'Arrived'
CANCELLED = 'Cancelled'
QUEUED = 'Queued'
RESTORED = 'Restored'
RESTORING = 'Restoring'
UPLOADED = 'Uploaded'
UPLOADING = 'Uploading'
class azure.mgmt.datamigration.models.BackupMode(value)[source]

Bases: str, enum.Enum

An enumeration of backup modes.

CREATE_BACKUP = 'CreateBackup'
EXISTING_BACKUP = 'ExistingBackup'
class azure.mgmt.datamigration.models.BackupSetInfo(*, backup_set_id: Optional[str] = None, first_lsn: Optional[str] = None, last_lsn: Optional[str] = None, last_modified_time: Optional[datetime.datetime] = None, backup_type: Optional[Union[str, _models.BackupType]] = None, list_of_backup_files: Optional[List[_models.BackupFileInfo]] = None, database_name: Optional[str] = None, backup_start_date: Optional[datetime.datetime] = None, backup_finished_date: Optional[datetime.datetime] = None, is_backup_restored: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Information of backup set.

Variables

  • backup_set_id (str) – Id for the set of backup files.

  • first_lsn (str) – First log sequence number of the backup file.

  • last_lsn (str) – Last log sequence number of the backup file.

  • last_modified_time (datetime) – Last modified time of the backup file in share location.

  • backup_type (str or BackupType) – Enum of the different backup types. Known values are: “Database”, “TransactionLog”, “File”, “DifferentialDatabase”, “DifferentialFile”, “Partial”, and “DifferentialPartial”.

  • list_of_backup_files (list[BackupFileInfo]) – List of files in the backup set.

  • database_name (str) – Name of the database to which the backup set belongs.

  • backup_start_date (datetime) – Date and time that the backup operation began.

  • backup_finished_date (datetime) – Date and time that the backup operation finished.

  • is_backup_restored (bool) – Whether the backup set is restored or not.

Keyword Arguments

  • backup_set_id (str) – Id for the set of backup files.

  • first_lsn (str) – First log sequence number of the backup file.

  • last_lsn (str) – Last log sequence number of the backup file.

  • last_modified_time (datetime) – Last modified time of the backup file in share location.

  • backup_type (str or BackupType) – Enum of the different backup types. Known values are: “Database”, “TransactionLog”, “File”, “DifferentialDatabase”, “DifferentialFile”, “Partial”, and “DifferentialPartial”.

  • list_of_backup_files (list[BackupFileInfo]) – List of files in the backup set.

  • database_name (str) – Name of the database to which the backup set belongs.

  • backup_start_date (datetime) – Date and time that the backup operation began.

  • backup_finished_date (datetime) – Date and time that the backup operation finished.

  • is_backup_restored (bool) – Whether the backup set is restored or not.

class azure.mgmt.datamigration.models.BackupType(value)[source]

Bases: str, enum.Enum

Enum of the different backup types.

DATABASE = 'Database'
DIFFERENTIAL_DATABASE = 'DifferentialDatabase'
DIFFERENTIAL_FILE = 'DifferentialFile'
DIFFERENTIAL_PARTIAL = 'DifferentialPartial'
FILE = 'File'
PARTIAL = 'Partial'
TRANSACTION_LOG = 'TransactionLog'
class azure.mgmt.datamigration.models.BlobShare(*, sas_uri: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Blob container storage information.

Variables

sas_uri (str) – SAS URI of Azure Storage Account Container.

Keyword Arguments

sas_uri (str) – SAS URI of Azure Storage Account Container.

class azure.mgmt.datamigration.models.CheckOCIDriverTaskInput(*, server_version: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Input for the service task to check for OCI drivers.

Variables

server_version (str) – Version of the source server to check against. Optional.

Keyword Arguments

server_version (str) – Version of the source server to check against. Optional.

class azure.mgmt.datamigration.models.CheckOCIDriverTaskOutput(*, installed_driver: Optional[_models.OracleOCIDriverInfo] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Output for the service task to check for OCI drivers.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
Keyword Arguments

installed_driver (OracleOCIDriverInfo) – Information about the installed driver if found and valid.

class azure.mgmt.datamigration.models.CheckOCIDriverTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.CheckOCIDriverTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

Properties for the task that checks for OCI drivers.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (CheckOCIDriverTaskInput) – Input for the service task to check for OCI drivers.

  • output (list[CheckOCIDriverTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (CheckOCIDriverTaskInput) – Input for the service task to check for OCI drivers.

class azure.mgmt.datamigration.models.CommandProperties(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Base class for all types of DMS command properties. If command is not supported by current client, this object is returned.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MigrateMISyncCompleteCommandProperties, MigrateSyncCompleteCommandProperties, MongoDbCancelCommand, MongoDbFinishCommand, MongoDbRestartCommand

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • command_type (str or CommandType) – Command type. Required. Known values are: “Migrate.Sync.Complete.Database”, “Migrate.SqlServer.AzureDbSqlMi.Complete”, “cancel”, “finish”, and “restart”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or CommandState) – The state of the command. This is ignored if submitted. Known values are: “Unknown”, “Accepted”, “Running”, “Succeeded”, and “Failed”.

class azure.mgmt.datamigration.models.CommandState(value)[source]

Bases: str, enum.Enum

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

ACCEPTED = 'Accepted'
FAILED = 'Failed'
RUNNING = 'Running'
SUCCEEDED = 'Succeeded'
UNKNOWN = 'Unknown'
class azure.mgmt.datamigration.models.CommandType(value)[source]

Bases: str, enum.Enum

Command type.

CANCEL = 'cancel'
FINISH = 'finish'
MIGRATE_SQL_SERVER_AZURE_DB_SQL_MI_COMPLETE = 'Migrate.SqlServer.AzureDbSqlMi.Complete'
MIGRATE_SYNC_COMPLETE_DATABASE = 'Migrate.Sync.Complete.Database'
RESTART = 'restart'
class azure.mgmt.datamigration.models.ConnectToMongoDbTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MongoDbConnectionInfo] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MongoDbConnectionInfo) – Describes a connection to a MongoDB data source.

  • output (list[MongoDbClusterInfo]) – An array containing a single MongoDbClusterInfo object.

Keyword Arguments

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MongoDbConnectionInfo) – Describes a connection to a MongoDB data source.

class azure.mgmt.datamigration.models.ConnectToSourceMySqlTaskInput(*, source_connection_info: _models.MySqlConnectionInfo, target_platform: Optional[Union[str, _models.MySqlTargetPlatformType]] = None, check_permissions_group: Optional[Union[str, _models.ServerLevelPermissionsGroup]] = None, is_offline_migration: bool = False, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Input for the task that validates MySQL database connection.

All required parameters must be populated in order to send to Azure.

Variables

  • source_connection_info (MySqlConnectionInfo) – Information for connecting to MySQL source. Required.

  • target_platform (str or MySqlTargetPlatformType) – Target Platform for the migration. Known values are: “SqlServer” and “AzureDbForMySQL”.

  • check_permissions_group (str or ServerLevelPermissionsGroup) – Permission group for validations. Known values are: “Default”, “MigrationFromSqlServerToAzureDB”, “MigrationFromSqlServerToAzureMI”, “MigrationFromMySQLToAzureDBForMySQL”, and “MigrationFromSqlServerToAzureVM”.

  • is_offline_migration (bool) – Flag for whether or not the migration is offline.

Keyword Arguments

  • source_connection_info (MySqlConnectionInfo) – Information for connecting to MySQL source. Required.

  • target_platform (str or MySqlTargetPlatformType) – Target Platform for the migration. Known values are: “SqlServer” and “AzureDbForMySQL”.

  • check_permissions_group (str or ServerLevelPermissionsGroup) – Permission group for validations. Known values are: “Default”, “MigrationFromSqlServerToAzureDB”, “MigrationFromSqlServerToAzureMI”, “MigrationFromMySQLToAzureDBForMySQL”, and “MigrationFromSqlServerToAzureVM”.

  • is_offline_migration (bool) – Flag for whether or not the migration is offline.

class azure.mgmt.datamigration.models.ConnectToSourceMySqlTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ConnectToSourceMySqlTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

Properties for the task that validates MySQL database connection.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToSourceMySqlTaskInput) – Task input.

  • output (list[ConnectToSourceNonSqlTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ConnectToSourceNonSqlTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Output for connect to MySQL type source.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Result identifier.

  • source_server_brand_version (str) – Server brand version.

  • server_properties (ServerProperties) – Server properties.

  • databases (list[str]) – List of databases on the server.

  • validation_errors (list[ReportableException]) – Validation errors associated with the task.

class azure.mgmt.datamigration.models.ConnectToSourceOracleSyncTaskInput(*, source_connection_info: _models.OracleConnectionInfo, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Input for the task that validates Oracle database connection.

All required parameters must be populated in order to send to Azure.

Variables

source_connection_info (OracleConnectionInfo) – Information for connecting to Oracle source. Required.

Keyword Arguments

source_connection_info (OracleConnectionInfo) – Information for connecting to Oracle source. Required.

class azure.mgmt.datamigration.models.ConnectToSourceOracleSyncTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Output for the task that validates Oracle database connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • source_server_version (str) – Version of the source server.

  • databases (list[str]) – List of schemas on source server.

  • source_server_brand_version (str) – Source server brand version.

  • validation_errors (list[ReportableException]) – Validation errors associated with the task.

class azure.mgmt.datamigration.models.ConnectToSourceOracleSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ConnectToSourceOracleSyncTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

Properties for the task that validates Oracle database connection.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToSourceOracleSyncTaskInput) – Task input.

  • output (list[ConnectToSourceOracleSyncTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ConnectToSourcePostgreSqlSyncTaskInput(*, source_connection_info: _models.PostgreSqlConnectionInfo, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

source_connection_info (PostgreSqlConnectionInfo) – Connection information for source PostgreSQL server. Required.

Keyword Arguments

source_connection_info (PostgreSqlConnectionInfo) – Connection information for source PostgreSQL server. Required.

class azure.mgmt.datamigration.models.ConnectToSourcePostgreSqlSyncTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Result identifier.

  • source_server_version (str) – Version of the source server.

  • databases (list[str]) – List of databases on source server.

  • source_server_brand_version (str) – Source server brand version.

  • validation_errors (list[ReportableException]) – Validation errors associated with the task.

class azure.mgmt.datamigration.models.ConnectToSourcePostgreSqlSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ConnectToSourcePostgreSqlSyncTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToSourcePostgreSqlSyncTaskInput) – Task input.

  • output (list[ConnectToSourcePostgreSqlSyncTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ConnectToSourceSqlServerSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ConnectToSourceSqlServerTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToSourceSqlServerTaskInput) – Task input.

  • output (list[ConnectToSourceSqlServerTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ConnectToSourceSqlServerTaskInput(*, source_connection_info: _models.SqlConnectionInfo, check_permissions_group: Optional[Union[str, _models.ServerLevelPermissionsGroup]] = None, collect_databases: bool = True, collect_logins: bool = False, collect_agent_jobs: bool = False, collect_tde_certificate_info: bool = False, validate_ssis_catalog_only: bool = False, encrypted_key_for_secure_fields: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • source_connection_info (SqlConnectionInfo) – Connection information for Source SQL Server. Required.

  • check_permissions_group (str or ServerLevelPermissionsGroup) – Permission group for validations. Known values are: “Default”, “MigrationFromSqlServerToAzureDB”, “MigrationFromSqlServerToAzureMI”, “MigrationFromMySQLToAzureDBForMySQL”, and “MigrationFromSqlServerToAzureVM”.

  • collect_databases (bool) – Flag for whether to collect databases from source server.

  • collect_logins (bool) – Flag for whether to collect logins from source server.

  • collect_agent_jobs (bool) – Flag for whether to collect agent jobs from source server.

  • collect_tde_certificate_info (bool) – Flag for whether to collect TDE Certificate names from source server.

  • validate_ssis_catalog_only (bool) – Flag for whether to validate SSIS catalog is reachable on the source server.

  • encrypted_key_for_secure_fields (str) – encrypted key for secure fields.

Keyword Arguments

  • source_connection_info (SqlConnectionInfo) – Connection information for Source SQL Server. Required.

  • check_permissions_group (str or ServerLevelPermissionsGroup) – Permission group for validations. Known values are: “Default”, “MigrationFromSqlServerToAzureDB”, “MigrationFromSqlServerToAzureMI”, “MigrationFromMySQLToAzureDBForMySQL”, and “MigrationFromSqlServerToAzureVM”.

  • collect_databases (bool) – Flag for whether to collect databases from source server.

  • collect_logins (bool) – Flag for whether to collect logins from source server.

  • collect_agent_jobs (bool) – Flag for whether to collect agent jobs from source server.

  • collect_tde_certificate_info (bool) – Flag for whether to collect TDE Certificate names from source server.

  • validate_ssis_catalog_only (bool) – Flag for whether to validate SSIS catalog is reachable on the source server.

  • encrypted_key_for_secure_fields (str) – encrypted key for secure fields.

class azure.mgmt.datamigration.models.ConnectToSourceSqlServerTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ConnectToSourceSqlServerTaskOutputAgentJobLevel, ConnectToSourceSqlServerTaskOutputDatabaseLevel, ConnectToSourceSqlServerTaskOutputLoginLevel, ConnectToSourceSqlServerTaskOutputTaskLevel

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Type of result - database level or task level. Required.

class azure.mgmt.datamigration.models.ConnectToSourceSqlServerTaskOutputAgentJobLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ConnectToSourceSqlServerTaskOutput

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Type of result - database level or task level. Required.

  • name (str) – Agent Job name.

  • job_category (str) – The type of Agent Job.

  • is_enabled (bool) – The state of the original Agent Job.

  • job_owner (str) – The owner of the Agent Job.

  • last_executed_on (datetime) – UTC Date and time when the Agent Job was last executed.

  • validation_errors (list[ReportableException]) – Validation errors.

  • migration_eligibility (MigrationEligibilityInfo) – Information about eligibility of agent job for migration.

class azure.mgmt.datamigration.models.ConnectToSourceSqlServerTaskOutputDatabaseLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ConnectToSourceSqlServerTaskOutput

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Type of result - database level or task level. Required.

  • name (str) – Database name.

  • size_mb (float) – Size of the file in megabytes.

  • database_files (list[DatabaseFileInfo]) – The list of database files.

  • compatibility_level (str or DatabaseCompatLevel) – SQL Server compatibility level of database. Known values are: “CompatLevel80”, “CompatLevel90”, “CompatLevel100”, “CompatLevel110”, “CompatLevel120”, “CompatLevel130”, and “CompatLevel140”.

  • database_state (str or DatabaseState) – State of the database. Known values are: “Online”, “Restoring”, “Recovering”, “RecoveryPending”, “Suspect”, “Emergency”, “Offline”, “Copying”, and “OfflineSecondary”.

class azure.mgmt.datamigration.models.ConnectToSourceSqlServerTaskOutputLoginLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ConnectToSourceSqlServerTaskOutput

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Type of result - database level or task level. Required.

  • name (str) – Login name.

  • login_type (str or LoginType) – The type of login. Known values are: “WindowsUser”, “WindowsGroup”, “SqlLogin”, “Certificate”, “AsymmetricKey”, “ExternalUser”, and “ExternalGroup”.

  • default_database (str) – The default database for the login.

  • is_enabled (bool) – The state of the login.

  • migration_eligibility (MigrationEligibilityInfo) – Information about eligibility of login for migration.

class azure.mgmt.datamigration.models.ConnectToSourceSqlServerTaskOutputTaskLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ConnectToSourceSqlServerTaskOutput

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Type of result - database level or task level. Required.

  • databases (str) – Source databases as a map from database name to database id.

  • logins (str) – Source logins as a map from login name to login id.

  • agent_jobs (str) – Source agent jobs as a map from agent job name to id.

  • database_tde_certificate_mapping (str) – Mapping from database name to TDE certificate name, if applicable.

  • source_server_version (str) – Source server version.

  • source_server_brand_version (str) – Source server brand version.

  • validation_errors (list[ReportableException]) – Validation errors.

class azure.mgmt.datamigration.models.ConnectToSourceSqlServerTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ConnectToSourceSqlServerTaskInput] = None, task_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToSourceSqlServerTaskInput) – Task input.

  • output (list[ConnectToSourceSqlServerTaskOutput]) – Task output. This is ignored if submitted.

  • task_id (str) – Task id.

Keyword Arguments
class azure.mgmt.datamigration.models.ConnectToTargetAzureDbForMySqlTaskInput(*, source_connection_info: _models.MySqlConnectionInfo, target_connection_info: _models.MySqlConnectionInfo, is_offline_migration: bool = False, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • source_connection_info (MySqlConnectionInfo) – Connection information for source MySQL server. Required.

  • target_connection_info (MySqlConnectionInfo) – Connection information for target Azure Database for MySQL server. Required.

  • is_offline_migration (bool) – Flag for whether or not the migration is offline.

Keyword Arguments

  • source_connection_info (MySqlConnectionInfo) – Connection information for source MySQL server. Required.

  • target_connection_info (MySqlConnectionInfo) – Connection information for target Azure Database for MySQL server. Required.

  • is_offline_migration (bool) – Flag for whether or not the migration is offline.

class azure.mgmt.datamigration.models.ConnectToTargetAzureDbForMySqlTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Result identifier.

  • server_version (str) – Version of the target server.

  • databases (list[str]) – List of databases on target server.

  • target_server_brand_version (str) – Target server brand version.

  • validation_errors (list[ReportableException]) – Validation errors associated with the task.

class azure.mgmt.datamigration.models.ConnectToTargetAzureDbForMySqlTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ConnectToTargetAzureDbForMySqlTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToTargetAzureDbForMySqlTaskInput) – Task input.

  • output (list[ConnectToTargetAzureDbForMySqlTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ConnectToTargetAzureDbForPostgreSqlSyncTaskInput(*, source_connection_info: _models.PostgreSqlConnectionInfo, target_connection_info: _models.PostgreSqlConnectionInfo, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • source_connection_info (PostgreSqlConnectionInfo) – Connection information for source PostgreSQL server. Required.

  • target_connection_info (PostgreSqlConnectionInfo) – Connection information for target Azure Database for PostgreSQL server. Required.

Keyword Arguments

  • source_connection_info (PostgreSqlConnectionInfo) – Connection information for source PostgreSQL server. Required.

  • target_connection_info (PostgreSqlConnectionInfo) – Connection information for target Azure Database for PostgreSQL server. Required.

class azure.mgmt.datamigration.models.ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Result identifier.

  • target_server_version (str) – Version of the target server.

  • databases (list[str]) – List of databases on target server.

  • target_server_brand_version (str) – Target server brand version.

  • validation_errors (list[ReportableException]) – Validation errors associated with the task.

class azure.mgmt.datamigration.models.ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ConnectToTargetAzureDbForPostgreSqlSyncTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToTargetAzureDbForPostgreSqlSyncTaskInput) – Task input.

  • output (list[ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput(*, target_connection_info: _models.PostgreSqlConnectionInfo, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

target_connection_info (PostgreSqlConnectionInfo) – Connection information for target Azure Database for PostgreSQL server. Required.

Keyword Arguments

target_connection_info (PostgreSqlConnectionInfo) – Connection information for target Azure Database for PostgreSQL server. Required.

class azure.mgmt.datamigration.models.ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput(*, database_schema_map: Optional[List[_models.ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables
Keyword Arguments

database_schema_map (list[ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem]) – Mapping of schemas per database.

class azure.mgmt.datamigration.models.ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem(*, database: Optional[str] = None, schemas: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput) – Task input.

  • output (list[ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ConnectToTargetSqlDbSyncTaskInput(*, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.SqlConnectionInfo, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • source_connection_info (SqlConnectionInfo) – Connection information for source SQL Server. Required.

  • target_connection_info (SqlConnectionInfo) – Connection information for target SQL DB. Required.

Keyword Arguments

  • source_connection_info (SqlConnectionInfo) – Connection information for source SQL Server. Required.

  • target_connection_info (SqlConnectionInfo) – Connection information for target SQL DB. Required.

class azure.mgmt.datamigration.models.ConnectToTargetSqlDbSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ConnectToTargetSqlDbSyncTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToTargetSqlDbSyncTaskInput) – Task input.

  • output (list[ConnectToTargetSqlDbTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ConnectToTargetSqlDbTaskInput(*, target_connection_info: _models.SqlConnectionInfo, query_object_counts: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • target_connection_info (SqlConnectionInfo) – Connection information for target SQL DB. Required.

  • query_object_counts (bool) – Boolean flag indicating whether to query object counts for each database on the target server.

Keyword Arguments

  • target_connection_info (SqlConnectionInfo) – Connection information for target SQL DB. Required.

  • query_object_counts (bool) – Boolean flag indicating whether to query object counts for each database on the target server.

class azure.mgmt.datamigration.models.ConnectToTargetSqlDbTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Result identifier.

  • databases (str) – Source databases as a map from database name to database id.

  • target_server_version (str) – Version of the target server.

  • target_server_brand_version (str) – Target server brand version.

class azure.mgmt.datamigration.models.ConnectToTargetSqlDbTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ConnectToTargetSqlDbTaskInput] = None, created_on: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToTargetSqlDbTaskInput) – Task input.

  • output (list[ConnectToTargetSqlDbTaskOutput]) – Task output. This is ignored if submitted.

  • created_on (str) – DateTime in UTC when the task was created.

Keyword Arguments

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToTargetSqlDbTaskInput) – Task input.

  • created_on (str) – DateTime in UTC when the task was created.

class azure.mgmt.datamigration.models.ConnectToTargetSqlMISyncTaskInput(*, target_connection_info: _models.MiSqlConnectionInfo, azure_app: _models.AzureActiveDirectoryApp, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • target_connection_info (MiSqlConnectionInfo) – Connection information for Azure SQL Database Managed Instance. Required.

  • azure_app (AzureActiveDirectoryApp) – Azure Active Directory Application the DMS instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account. Required.

Keyword Arguments

  • target_connection_info (MiSqlConnectionInfo) – Connection information for Azure SQL Database Managed Instance. Required.

  • azure_app (AzureActiveDirectoryApp) – Azure Active Directory Application the DMS instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account. Required.

class azure.mgmt.datamigration.models.ConnectToTargetSqlMISyncTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • target_server_version (str) – Target server version.

  • target_server_brand_version (str) – Target server brand version.

  • validation_errors (list[ReportableException]) – Validation errors.

class azure.mgmt.datamigration.models.ConnectToTargetSqlMISyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ConnectToTargetSqlMISyncTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToTargetSqlMISyncTaskInput) – Task input.

  • output (list[ConnectToTargetSqlMISyncTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ConnectToTargetSqlMITaskInput(*, target_connection_info: _models.SqlConnectionInfo, collect_logins: bool = True, collect_agent_jobs: bool = True, validate_ssis_catalog_only: bool = False, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • target_connection_info (SqlConnectionInfo) – Connection information for target SQL Server. Required.

  • collect_logins (bool) – Flag for whether to collect logins from target SQL MI server.

  • collect_agent_jobs (bool) – Flag for whether to collect agent jobs from target SQL MI server.

  • validate_ssis_catalog_only (bool) – Flag for whether to validate SSIS catalog is reachable on the target SQL MI server.

Keyword Arguments

  • target_connection_info (SqlConnectionInfo) – Connection information for target SQL Server. Required.

  • collect_logins (bool) – Flag for whether to collect logins from target SQL MI server.

  • collect_agent_jobs (bool) – Flag for whether to collect agent jobs from target SQL MI server.

  • validate_ssis_catalog_only (bool) – Flag for whether to validate SSIS catalog is reachable on the target SQL MI server.

class azure.mgmt.datamigration.models.ConnectToTargetSqlMITaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Result identifier.

  • target_server_version (str) – Target server version.

  • target_server_brand_version (str) – Target server brand version.

  • logins (list[str]) – List of logins on the target server.

  • agent_jobs (list[str]) – List of agent jobs on the target server.

  • validation_errors (list[ReportableException]) – Validation errors.

class azure.mgmt.datamigration.models.ConnectToTargetSqlMITaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ConnectToTargetSqlMITaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ConnectToTargetSqlMITaskInput) – Task input.

  • output (list[ConnectToTargetSqlMITaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ConnectionInfo(*, user_name: Optional[str] = None, password: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Defines the connection properties of a server.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MiSqlConnectionInfo, MongoDbConnectionInfo, MySqlConnectionInfo, OracleConnectionInfo, PostgreSqlConnectionInfo, SqlConnectionInfo

All required parameters must be populated in order to send to Azure.

Variables

  • type (str) – Type of connection info. Required.

  • user_name (str) – User name.

  • password (str) – Password credential.

Keyword Arguments

  • user_name (str) – User name.

  • password (str) – Password credential.

class azure.mgmt.datamigration.models.CopyProgressDetails(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Details on progress of ADF copy activity.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • table_name (str) – Table Name.

  • status (str) – Status of the Copy activity (InProgress, Succeeded, Failed, Canceled).

  • parallel_copy_type (str) – Type of parallel copy (Dynamic range, Physical partition, none).

  • used_parallel_copies (int) – The degree of parallelization.

  • data_read (int) – Bytes read.

  • data_written (int) – Bytes written.

  • rows_read (int) – Rows read.

  • rows_copied (int) – Rows Copied.

  • copy_start (datetime) – Copy Start.

  • copy_throughput (float) – Copy throughput in KBps.

  • copy_duration (int) – Copy Duration in seconds.

class azure.mgmt.datamigration.models.CreatedByType(value)[source]

Bases: str, enum.Enum

CreatedByType.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.datamigration.models.DataIntegrityValidationResult(*, failed_objects: Optional[Dict[str, str]] = None, validation_errors: Optional[_models.ValidationError] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Results for checksum based Data Integrity validation results.

Variables

  • failed_objects (dict[str, str]) – List of failed table names of source and target pair.

  • validation_errors (ValidationError) – List of errors that happened while performing data integrity validation.

Keyword Arguments

  • failed_objects (dict[str, str]) – List of failed table names of source and target pair.

  • validation_errors (ValidationError) – List of errors that happened while performing data integrity validation.

class azure.mgmt.datamigration.models.DataItemMigrationSummaryResult(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Basic summary of a data item migration.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name (str) – Name of the item.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • state (str or MigrationState) – Current state of migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • status_message (str) – Status message.

  • items_count (int) – Number of items.

  • items_completed_count (int) – Number of successfully completed items.

  • error_prefix (str) – Wildcard string prefix to use for querying all errors of the item.

  • result_prefix (str) – Wildcard string prefix to use for querying all sub-tem results of the item.

class azure.mgmt.datamigration.models.DataMigrationError(*, type: Optional[Union[str, _models.ErrorType]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Migration Task errors.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • message (str) – Error description.

  • type (str or ErrorType) – Error type. Known values are: “Default”, “Warning”, and “Error”.

Keyword Arguments

type (str or ErrorType) – Error type. Known values are: “Default”, “Warning”, and “Error”.

class azure.mgmt.datamigration.models.DataMigrationProjectMetadata(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Common metadata for migration projects.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • source_server_name (str) – Source server name.

  • source_server_port (str) – Source server port number.

  • source_username (str) – Source username.

  • target_server_name (str) – Target server name.

  • target_username (str) – Target username.

  • target_db_name (str) – Target database name.

  • target_using_win_auth (bool) – Whether target connection is Windows authentication.

  • selected_migration_tables (list[MigrationTableMetadata]) – List of tables selected for migration.

class azure.mgmt.datamigration.models.DataMigrationResultCode(value)[source]

Bases: str, enum.Enum

Result code of the data migration.

COMPLETED = 'Completed'
FATAL_ERROR = 'FatalError'
INITIAL = 'Initial'
OBJECT_NOT_EXISTS_IN_SOURCE = 'ObjectNotExistsInSource'
OBJECT_NOT_EXISTS_IN_TARGET = 'ObjectNotExistsInTarget'
TARGET_OBJECT_IS_INACCESSIBLE = 'TargetObjectIsInaccessible'
class azure.mgmt.datamigration.models.DataMigrationService(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, kind: Optional[str] = None, sku: Optional[_models.ServiceSku] = None, public_key: Optional[str] = None, virtual_subnet_id: Optional[str] = None, virtual_nic_id: Optional[str] = None, auto_stop_delay: Optional[str] = None, delete_resources_on_stop: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.TrackedResource

A Database Migration Service resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • location (str) –

  • tags (dict[str, str]) – Dictionary of <string>.

  • id (str) –

  • name (str) –

  • type (str) –

  • system_data (SystemData) –

  • etag (str) – HTTP strong entity tag value. Ignored if submitted.

  • kind (str) – The resource kind. Only ‘vm’ (the default) is supported.

  • sku (ServiceSku) – Service SKU.

  • provisioning_state (str or ServiceProvisioningState) – The resource’s provisioning state. Known values are: “Accepted”, “Deleting”, “Deploying”, “Stopped”, “Stopping”, “Starting”, “FailedToStart”, “FailedToStop”, “Succeeded”, and “Failed”.

  • public_key (str) – The public key of the service, used to encrypt secrets sent to the service.

  • virtual_subnet_id (str) – The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined.

  • virtual_nic_id (str) – The ID of the Microsoft.Network/networkInterfaces resource which the service have.

  • auto_stop_delay (str) – The time delay before the service is auto-stopped when idle.

  • delete_resources_on_stop (bool) – Whether service resources should be deleted when stopped. (Turned on by default).

Keyword Arguments

  • location (str) –

  • tags (dict[str, str]) – Dictionary of <string>.

  • etag (str) – HTTP strong entity tag value. Ignored if submitted.

  • kind (str) – The resource kind. Only ‘vm’ (the default) is supported.

  • sku (ServiceSku) – Service SKU.

  • public_key (str) – The public key of the service, used to encrypt secrets sent to the service.

  • virtual_subnet_id (str) – The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined.

  • virtual_nic_id (str) – The ID of the Microsoft.Network/networkInterfaces resource which the service have.

  • auto_stop_delay (str) – The time delay before the service is auto-stopped when idle.

  • delete_resources_on_stop (bool) – Whether service resources should be deleted when stopped. (Turned on by default).

class azure.mgmt.datamigration.models.DataMigrationServiceList(*, value: Optional[List[_models.DataMigrationService]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

OData page of service objects.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.DataMigrationServiceStatusResponse(*, agent_version: Optional[str] = None, agent_configuration: Optional[collections.abc.MutableMapping[str, Any]] = None, status: Optional[str] = None, vm_size: Optional[str] = None, supported_task_types: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Service health status.

Variables

  • agent_version (str) – The DMS instance agent version.

  • agent_configuration (JSON) – Agent Configuration.

  • status (str) – The machine-readable status, such as ‘Initializing’, ‘Offline’, ‘Online’, ‘Deploying’, ‘Deleting’, ‘Stopped’, ‘Stopping’, ‘Starting’, ‘FailedToStart’, ‘FailedToStop’ or ‘Failed’.

  • vm_size (str) – The services virtual machine size, such as ‘Standard_D2_v2’.

  • supported_task_types (list[str]) – The list of supported task types.

Keyword Arguments

  • agent_version (str) – The DMS instance agent version.

  • agent_configuration (JSON) – Agent Configuration.

  • status (str) – The machine-readable status, such as ‘Initializing’, ‘Offline’, ‘Online’, ‘Deploying’, ‘Deleting’, ‘Stopped’, ‘Stopping’, ‘Starting’, ‘FailedToStart’, ‘FailedToStop’ or ‘Failed’.

  • vm_size (str) – The services virtual machine size, such as ‘Standard_D2_v2’.

  • supported_task_types (list[str]) – The list of supported task types.

class azure.mgmt.datamigration.models.Database(*, id: Optional[str] = None, name: Optional[str] = None, compatibility_level: Optional[Union[str, _models.DatabaseCompatLevel]] = None, collation: Optional[str] = None, server_name: Optional[str] = None, fqdn: Optional[str] = None, install_id: Optional[str] = None, server_version: Optional[str] = None, server_edition: Optional[str] = None, server_level: Optional[str] = None, server_default_data_path: Optional[str] = None, server_default_log_path: Optional[str] = None, server_default_backup_path: Optional[str] = None, server_core_count: Optional[int] = None, server_visible_online_core_count: Optional[int] = None, database_state: Optional[Union[str, _models.DatabaseState]] = None, server_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Information about a single database.

Variables

  • id (str) – Unique identifier for the database.

  • name (str) – Name of the database.

  • compatibility_level (str or DatabaseCompatLevel) – SQL Server compatibility level of database. Known values are: “CompatLevel80”, “CompatLevel90”, “CompatLevel100”, “CompatLevel110”, “CompatLevel120”, “CompatLevel130”, and “CompatLevel140”.

  • collation (str) – Collation name of the database.

  • server_name (str) – Name of the server.

  • fqdn (str) – Fully qualified name.

  • install_id (str) – Install id of the database.

  • server_version (str) – Version of the server.

  • server_edition (str) – Edition of the server.

  • server_level (str) – Product level of the server (RTM, SP, CTP).

  • server_default_data_path (str) – Default path of the data files.

  • server_default_log_path (str) – Default path of the log files.

  • server_default_backup_path (str) – Default path of the backup folder.

  • server_core_count (int) – Number of cores on the server.

  • server_visible_online_core_count (int) – Number of cores on the server that have VISIBLE ONLINE status.

  • database_state (str or DatabaseState) – State of the database. Known values are: “Online”, “Restoring”, “Recovering”, “RecoveryPending”, “Suspect”, “Emergency”, “Offline”, “Copying”, and “OfflineSecondary”.

  • server_id (str) – The unique Server Id.

Keyword Arguments

  • id (str) – Unique identifier for the database.

  • name (str) – Name of the database.

  • compatibility_level (str or DatabaseCompatLevel) – SQL Server compatibility level of database. Known values are: “CompatLevel80”, “CompatLevel90”, “CompatLevel100”, “CompatLevel110”, “CompatLevel120”, “CompatLevel130”, and “CompatLevel140”.

  • collation (str) – Collation name of the database.

  • server_name (str) – Name of the server.

  • fqdn (str) – Fully qualified name.

  • install_id (str) – Install id of the database.

  • server_version (str) – Version of the server.

  • server_edition (str) – Edition of the server.

  • server_level (str) – Product level of the server (RTM, SP, CTP).

  • server_default_data_path (str) – Default path of the data files.

  • server_default_log_path (str) – Default path of the log files.

  • server_default_backup_path (str) – Default path of the backup folder.

  • server_core_count (int) – Number of cores on the server.

  • server_visible_online_core_count (int) – Number of cores on the server that have VISIBLE ONLINE status.

  • database_state (str or DatabaseState) – State of the database. Known values are: “Online”, “Restoring”, “Recovering”, “RecoveryPending”, “Suspect”, “Emergency”, “Offline”, “Copying”, and “OfflineSecondary”.

  • server_id (str) – The unique Server Id.

class azure.mgmt.datamigration.models.DatabaseBackupInfo(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Information about backup files when existing backup mode is used.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • database_name (str) – Database name.

  • backup_type (str or BackupType) – Backup Type. Known values are: “Database”, “TransactionLog”, “File”, “DifferentialDatabase”, “DifferentialFile”, “Partial”, and “DifferentialPartial”.

  • backup_files (list[str]) – The list of backup files for the current database.

  • position (int) – Position of current database backup in the file.

  • is_damaged (bool) – Database was damaged when backed up, but the backup operation was requested to continue despite errors.

  • is_compressed (bool) – Whether the backup set is compressed.

  • family_count (int) – Number of files in the backup set.

  • backup_finish_date (datetime) – Date and time when the backup operation finished.

class azure.mgmt.datamigration.models.DatabaseCompatLevel(value)[source]

Bases: str, enum.Enum

An enumeration of SQL Server database compatibility levels.

COMPAT_LEVEL100 = 'CompatLevel100'
COMPAT_LEVEL110 = 'CompatLevel110'
COMPAT_LEVEL120 = 'CompatLevel120'
COMPAT_LEVEL130 = 'CompatLevel130'
COMPAT_LEVEL140 = 'CompatLevel140'
COMPAT_LEVEL80 = 'CompatLevel80'
COMPAT_LEVEL90 = 'CompatLevel90'
class azure.mgmt.datamigration.models.DatabaseFileInfo(*, database_name: Optional[str] = None, id: Optional[str] = None, logical_name: Optional[str] = None, physical_full_name: Optional[str] = None, restore_full_name: Optional[str] = None, file_type: Optional[Union[str, _models.DatabaseFileType]] = None, size_mb: Optional[float] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Database file specific information.

Variables

  • database_name (str) – Name of the database.

  • id (str) – Unique identifier for database file.

  • logical_name (str) – Logical name of the file.

  • physical_full_name (str) – Operating-system full path of the file.

  • restore_full_name (str) – Suggested full path of the file for restoring.

  • file_type (str or DatabaseFileType) – Database file type. Known values are: “Rows”, “Log”, “Filestream”, “NotSupported”, and “Fulltext”.

  • size_mb (float) – Size of the file in megabytes.

Keyword Arguments

  • database_name (str) – Name of the database.

  • id (str) – Unique identifier for database file.

  • logical_name (str) – Logical name of the file.

  • physical_full_name (str) – Operating-system full path of the file.

  • restore_full_name (str) – Suggested full path of the file for restoring.

  • file_type (str or DatabaseFileType) – Database file type. Known values are: “Rows”, “Log”, “Filestream”, “NotSupported”, and “Fulltext”.

  • size_mb (float) – Size of the file in megabytes.

class azure.mgmt.datamigration.models.DatabaseFileInput(*, id: Optional[str] = None, logical_name: Optional[str] = None, physical_full_name: Optional[str] = None, restore_full_name: Optional[str] = None, file_type: Optional[Union[str, _models.DatabaseFileType]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Database file specific information for input.

Variables

  • id (str) – Unique identifier for database file.

  • logical_name (str) – Logical name of the file.

  • physical_full_name (str) – Operating-system full path of the file.

  • restore_full_name (str) – Suggested full path of the file for restoring.

  • file_type (str or DatabaseFileType) – Database file type. Known values are: “Rows”, “Log”, “Filestream”, “NotSupported”, and “Fulltext”.

Keyword Arguments

  • id (str) – Unique identifier for database file.

  • logical_name (str) – Logical name of the file.

  • physical_full_name (str) – Operating-system full path of the file.

  • restore_full_name (str) – Suggested full path of the file for restoring.

  • file_type (str or DatabaseFileType) – Database file type. Known values are: “Rows”, “Log”, “Filestream”, “NotSupported”, and “Fulltext”.

class azure.mgmt.datamigration.models.DatabaseFileType(value)[source]

Bases: str, enum.Enum

An enumeration of SQL Server database file types.

FILESTREAM = 'Filestream'
FULLTEXT = 'Fulltext'
LOG = 'Log'
NOT_SUPPORTED = 'NotSupported'
ROWS = 'Rows'
class azure.mgmt.datamigration.models.DatabaseInfo(*, source_database_name: str, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Project Database Details.

All required parameters must be populated in order to send to Azure.

Variables

source_database_name (str) – Name of the database. Required.

Keyword Arguments

source_database_name (str) – Name of the database. Required.

class azure.mgmt.datamigration.models.DatabaseMigration(*, properties: Optional[_models.DatabaseMigrationProperties] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProxyResource

Database Migration Resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
Keyword Arguments

properties (DatabaseMigrationProperties) – Database Migration Resource properties.

class azure.mgmt.datamigration.models.DatabaseMigrationListResult(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

A list of Database Migrations.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.datamigration.models.DatabaseMigrationProperties(*, scope: Optional[str] = None, source_sql_connection: Optional[_models.SqlConnectionInformation] = None, source_database_name: Optional[str] = None, migration_service: Optional[str] = None, migration_operation_id: Optional[str] = None, target_database_collation: Optional[str] = None, provisioning_error: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Database Migration Resource properties.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DatabaseMigrationPropertiesSqlDb, DatabaseMigrationPropertiesSqlMi, DatabaseMigrationPropertiesSqlVm

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • kind (str or ResourceType) – Required. Known values are: “SqlMi”, “SqlVm”, and “SqlDb”.

  • scope (str) – Resource Id of the target resource (SQL VM or SQL Managed Instance).

  • provisioning_state (str) – Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started.

  • migration_status (str) – Migration status.

  • started_on (datetime) – Database migration start time.

  • ended_on (datetime) – Database migration end time.

  • source_sql_connection (SqlConnectionInformation) – Source SQL Server connection details.

  • source_database_name (str) – Name of the source database.

  • source_server_name (str) – Name of the source sql server.

  • migration_service (str) – Resource Id of the Migration Service.

  • migration_operation_id (str) – ID tracking current migration operation.

  • migration_failure_error (ErrorInfo) – Error details in case of migration failure.

  • target_database_collation (str) – Database collation to be used for the target database.

  • provisioning_error (str) – Error message for migration provisioning failure, if any.

Keyword Arguments

  • scope (str) – Resource Id of the target resource (SQL VM or SQL Managed Instance).

  • source_sql_connection (SqlConnectionInformation) – Source SQL Server connection details.

  • source_database_name (str) – Name of the source database.

  • migration_service (str) – Resource Id of the Migration Service.

  • migration_operation_id (str) – ID tracking current migration operation.

  • target_database_collation (str) – Database collation to be used for the target database.

  • provisioning_error (str) – Error message for migration provisioning failure, if any.

class azure.mgmt.datamigration.models.DatabaseMigrationPropertiesSqlDb(*, scope: Optional[str] = None, source_sql_connection: Optional[_models.SqlConnectionInformation] = None, source_database_name: Optional[str] = None, migration_service: Optional[str] = None, migration_operation_id: Optional[str] = None, target_database_collation: Optional[str] = None, provisioning_error: Optional[str] = None, target_sql_connection: Optional[_models.SqlConnectionInformation] = None, table_list: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.DatabaseMigrationProperties

Database Migration Resource properties for SQL database.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • kind (str or ResourceType) – Required. Known values are: “SqlMi”, “SqlVm”, and “SqlDb”.

  • scope (str) – Resource Id of the target resource (SQL VM or SQL Managed Instance).

  • provisioning_state (str) – Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started.

  • migration_status (str) – Migration status.

  • started_on (datetime) – Database migration start time.

  • ended_on (datetime) – Database migration end time.

  • source_sql_connection (SqlConnectionInformation) – Source SQL Server connection details.

  • source_database_name (str) – Name of the source database.

  • source_server_name (str) – Name of the source sql server.

  • migration_service (str) – Resource Id of the Migration Service.

  • migration_operation_id (str) – ID tracking current migration operation.

  • migration_failure_error (ErrorInfo) – Error details in case of migration failure.

  • target_database_collation (str) – Database collation to be used for the target database.

  • provisioning_error (str) – Error message for migration provisioning failure, if any.

  • migration_status_details (SqlDbMigrationStatusDetails) – Detailed migration status. Not included by default.

  • target_sql_connection (SqlConnectionInformation) – Target SQL DB connection details.

  • offline_configuration (SqlDbOfflineConfiguration) – Offline configuration.

  • table_list (list[str]) – List of tables to copy.

Keyword Arguments

  • scope (str) – Resource Id of the target resource (SQL VM or SQL Managed Instance).

  • source_sql_connection (SqlConnectionInformation) – Source SQL Server connection details.

  • source_database_name (str) – Name of the source database.

  • migration_service (str) – Resource Id of the Migration Service.

  • migration_operation_id (str) – ID tracking current migration operation.

  • target_database_collation (str) – Database collation to be used for the target database.

  • provisioning_error (str) – Error message for migration provisioning failure, if any.

  • target_sql_connection (SqlConnectionInformation) – Target SQL DB connection details.

  • table_list (list[str]) – List of tables to copy.

class azure.mgmt.datamigration.models.DatabaseMigrationPropertiesSqlMi(*, scope: Optional[str] = None, source_sql_connection: Optional[_models.SqlConnectionInformation] = None, source_database_name: Optional[str] = None, migration_service: Optional[str] = None, migration_operation_id: Optional[str] = None, target_database_collation: Optional[str] = None, provisioning_error: Optional[str] = None, backup_configuration: Optional[_models.BackupConfiguration] = None, offline_configuration: Optional[_models.OfflineConfiguration] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.DatabaseMigrationProperties

Database Migration Resource properties for SQL Managed Instance.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • kind (str or ResourceType) – Required. Known values are: “SqlMi”, “SqlVm”, and “SqlDb”.

  • scope (str) – Resource Id of the target resource (SQL VM or SQL Managed Instance).

  • provisioning_state (str) – Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started.

  • migration_status (str) – Migration status.

  • started_on (datetime) – Database migration start time.

  • ended_on (datetime) – Database migration end time.

  • source_sql_connection (SqlConnectionInformation) – Source SQL Server connection details.

  • source_database_name (str) – Name of the source database.

  • source_server_name (str) – Name of the source sql server.

  • migration_service (str) – Resource Id of the Migration Service.

  • migration_operation_id (str) – ID tracking current migration operation.

  • migration_failure_error (ErrorInfo) – Error details in case of migration failure.

  • target_database_collation (str) – Database collation to be used for the target database.

  • provisioning_error (str) – Error message for migration provisioning failure, if any.

  • migration_status_details (MigrationStatusDetails) – Detailed migration status. Not included by default.

  • backup_configuration (BackupConfiguration) – Backup configuration info.

  • offline_configuration (OfflineConfiguration) – Offline configuration.

Keyword Arguments

  • scope (str) – Resource Id of the target resource (SQL VM or SQL Managed Instance).

  • source_sql_connection (SqlConnectionInformation) – Source SQL Server connection details.

  • source_database_name (str) – Name of the source database.

  • migration_service (str) – Resource Id of the Migration Service.

  • migration_operation_id (str) – ID tracking current migration operation.

  • target_database_collation (str) – Database collation to be used for the target database.

  • provisioning_error (str) – Error message for migration provisioning failure, if any.

  • backup_configuration (BackupConfiguration) – Backup configuration info.

  • offline_configuration (OfflineConfiguration) – Offline configuration.

class azure.mgmt.datamigration.models.DatabaseMigrationPropertiesSqlVm(*, scope: Optional[str] = None, source_sql_connection: Optional[_models.SqlConnectionInformation] = None, source_database_name: Optional[str] = None, migration_service: Optional[str] = None, migration_operation_id: Optional[str] = None, target_database_collation: Optional[str] = None, provisioning_error: Optional[str] = None, backup_configuration: Optional[_models.BackupConfiguration] = None, offline_configuration: Optional[_models.OfflineConfiguration] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.DatabaseMigrationProperties

Database Migration Resource properties for SQL Virtual Machine.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • kind (str or ResourceType) – Required. Known values are: “SqlMi”, “SqlVm”, and “SqlDb”.

  • scope (str) – Resource Id of the target resource (SQL VM or SQL Managed Instance).

  • provisioning_state (str) – Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started.

  • migration_status (str) – Migration status.

  • started_on (datetime) – Database migration start time.

  • ended_on (datetime) – Database migration end time.

  • source_sql_connection (SqlConnectionInformation) – Source SQL Server connection details.

  • source_database_name (str) – Name of the source database.

  • source_server_name (str) – Name of the source sql server.

  • migration_service (str) – Resource Id of the Migration Service.

  • migration_operation_id (str) – ID tracking current migration operation.

  • migration_failure_error (ErrorInfo) – Error details in case of migration failure.

  • target_database_collation (str) – Database collation to be used for the target database.

  • provisioning_error (str) – Error message for migration provisioning failure, if any.

  • migration_status_details (MigrationStatusDetails) – Detailed migration status. Not included by default.

  • backup_configuration (BackupConfiguration) – Backup configuration info.

  • offline_configuration (OfflineConfiguration) – Offline configuration.

Keyword Arguments

  • scope (str) – Resource Id of the target resource (SQL VM or SQL Managed Instance).

  • source_sql_connection (SqlConnectionInformation) – Source SQL Server connection details.

  • source_database_name (str) – Name of the source database.

  • migration_service (str) – Resource Id of the Migration Service.

  • migration_operation_id (str) – ID tracking current migration operation.

  • target_database_collation (str) – Database collation to be used for the target database.

  • provisioning_error (str) – Error message for migration provisioning failure, if any.

  • backup_configuration (BackupConfiguration) – Backup configuration info.

  • offline_configuration (OfflineConfiguration) – Offline configuration.

class azure.mgmt.datamigration.models.DatabaseMigrationSqlDb(*, properties: Optional[_models.DatabaseMigrationPropertiesSqlDb] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProxyResource

Database Migration Resource for SQL Database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
Keyword Arguments

properties (DatabaseMigrationPropertiesSqlDb) – Database Migration Resource properties for SQL database.

class azure.mgmt.datamigration.models.DatabaseMigrationSqlMi(*, properties: Optional[_models.DatabaseMigrationPropertiesSqlMi] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProxyResource

Database Migration Resource for SQL Managed Instance.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
Keyword Arguments

properties (DatabaseMigrationPropertiesSqlMi) – Database Migration Resource properties for SQL Managed Instance.

class azure.mgmt.datamigration.models.DatabaseMigrationSqlVm(*, properties: Optional[_models.DatabaseMigrationPropertiesSqlVm] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProxyResource

Database Migration Resource for SQL Virtual Machine.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
Keyword Arguments

properties (DatabaseMigrationPropertiesSqlVm) – Database Migration Resource properties for SQL Virtual Machine.

class azure.mgmt.datamigration.models.DatabaseMigrationStage(value)[source]

Bases: str, enum.Enum

Current stage of migration.

BACKUP = 'Backup'
COMPLETED = 'Completed'
FILE_COPY = 'FileCopy'
INITIALIZE = 'Initialize'
NONE = 'None'
RESTORE = 'Restore'
class azure.mgmt.datamigration.models.DatabaseMigrationState(value)[source]

Bases: str, enum.Enum

Database level migration state.

CANCELLED = 'CANCELLED'
COMPLETED = 'COMPLETED'
CUTOVER_START = 'CUTOVER_START'
FAILED = 'FAILED'
FULL_BACKUP_UPLOAD_START = 'FULL_BACKUP_UPLOAD_START'
INITIAL = 'INITIAL'
LOG_SHIPPING_START = 'LOG_SHIPPING_START'
POST_CUTOVER_COMPLETE = 'POST_CUTOVER_COMPLETE'
UNDEFINED = 'UNDEFINED'
UPLOAD_LOG_FILES_START = 'UPLOAD_LOG_FILES_START'
class azure.mgmt.datamigration.models.DatabaseObjectName(*, object_type: Optional[Union[str, _models.ObjectType]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

A representation of the name of an object in a database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • database_name (str) – The unescaped name of the database containing the object.

  • object_name (str) – The unescaped name of the object.

  • schema_name (str) – The unescaped name of the schema containing the object.

  • object_type (str or ObjectType) – Type of the object in the database. Known values are: “StoredProcedures”, “Table”, “User”, “View”, and “Function”.

Keyword Arguments

object_type (str or ObjectType) – Type of the object in the database. Known values are: “StoredProcedures”, “Table”, “User”, “View”, and “Function”.

class azure.mgmt.datamigration.models.DatabaseState(value)[source]

Bases: str, enum.Enum

An enumeration of SQL Server Database states.

COPYING = 'Copying'
EMERGENCY = 'Emergency'
OFFLINE = 'Offline'
OFFLINE_SECONDARY = 'OfflineSecondary'
ONLINE = 'Online'
RECOVERING = 'Recovering'
RECOVERY_PENDING = 'RecoveryPending'
RESTORING = 'Restoring'
SUSPECT = 'Suspect'
class azure.mgmt.datamigration.models.DatabaseSummaryResult(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.DataItemMigrationSummaryResult

Summary of database results in the migration.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name (str) – Name of the item.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • state (str or MigrationState) – Current state of migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • status_message (str) – Status message.

  • items_count (int) – Number of items.

  • items_completed_count (int) – Number of successfully completed items.

  • error_prefix (str) – Wildcard string prefix to use for querying all errors of the item.

  • result_prefix (str) – Wildcard string prefix to use for querying all sub-tem results of the item.

  • size_mb (float) – Size of the database in megabytes.

class azure.mgmt.datamigration.models.DatabaseTable(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Table properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • has_rows (bool) – Indicates whether table is empty or not.

  • name (str) – Schema-qualified name of the table.

class azure.mgmt.datamigration.models.DeleteNode(*, node_name: Optional[str] = None, integration_runtime_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Details of node to be deleted.

Variables

  • node_name (str) – The name of node to delete.

  • integration_runtime_name (str) – The name of integration runtime.

Keyword Arguments

  • node_name (str) – The name of node to delete.

  • integration_runtime_name (str) – The name of integration runtime.

class azure.mgmt.datamigration.models.ErrorInfo(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Error details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • code (str) – Error code.

  • message (str) – Error message.

class azure.mgmt.datamigration.models.ErrorType(value)[source]

Bases: str, enum.Enum

Error type.

DEFAULT = 'Default'
ERROR = 'Error'
WARNING = 'Warning'
class azure.mgmt.datamigration.models.ExecutionStatistics(*, execution_count: Optional[int] = None, cpu_time_ms: Optional[float] = None, elapsed_time_ms: Optional[float] = None, wait_stats: Optional[Dict[str, _models.WaitStatistics]] = None, has_errors: Optional[bool] = None, sql_errors: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Description about the errors happen while performing migration validation.

Variables

  • execution_count (int) – No. of query executions.

  • cpu_time_ms (float) – CPU Time in millisecond(s) for the query execution.

  • elapsed_time_ms (float) – Time taken in millisecond(s) for executing the query.

  • wait_stats (dict[str, WaitStatistics]) – Dictionary of sql query execution wait types and the respective statistics.

  • has_errors (bool) – Indicates whether the query resulted in an error.

  • sql_errors (list[str]) – List of sql Errors.

Keyword Arguments

  • execution_count (int) – No. of query executions.

  • cpu_time_ms (float) – CPU Time in millisecond(s) for the query execution.

  • elapsed_time_ms (float) – Time taken in millisecond(s) for executing the query.

  • wait_stats (dict[str, WaitStatistics]) – Dictionary of sql query execution wait types and the respective statistics.

  • has_errors (bool) – Indicates whether the query resulted in an error.

  • sql_errors (list[str]) – List of sql Errors.

class azure.mgmt.datamigration.models.FileList(*, value: Optional[List[_models.ProjectFile]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

OData page of files.

Variables

  • value (list[ProjectFile]) – List of files.

  • next_link (str) – URL to load the next page of files.

Keyword Arguments

  • value (list[ProjectFile]) – List of files.

  • next_link (str) – URL to load the next page of files.

class azure.mgmt.datamigration.models.FileShare(*, path: str, user_name: Optional[str] = None, password: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

File share information with Path, Username, and Password.

All required parameters must be populated in order to send to Azure.

Variables

  • user_name (str) – User name credential to connect to the share location.

  • password (str) – Password credential used to connect to the share location.

  • path (str) – The folder path for this share. Required.

Keyword Arguments

  • user_name (str) – User name credential to connect to the share location.

  • password (str) – Password credential used to connect to the share location.

  • path (str) – The folder path for this share. Required.

class azure.mgmt.datamigration.models.FileStorageInfo(*, uri: Optional[str] = None, headers: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

File storage information.

Variables

  • uri (str) – A URI that can be used to access the file content.

  • headers (dict[str, str]) – Dictionary of <string>.

Keyword Arguments

  • uri (str) – A URI that can be used to access the file content.

  • headers (dict[str, str]) – Dictionary of <string>.

class azure.mgmt.datamigration.models.GetProjectDetailsNonSqlTaskInput(*, project_name: str, project_location: str, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Input for the task that reads configuration from project artifacts.

All required parameters must be populated in order to send to Azure.

Variables

  • project_name (str) – Name of the migration project. Required.

  • project_location (str) – A URL that points to the location to access project artifacts. Required.

Keyword Arguments

  • project_name (str) – Name of the migration project. Required.

  • project_location (str) – A URL that points to the location to access project artifacts. Required.

class azure.mgmt.datamigration.models.GetTdeCertificatesSqlTaskInput(*, connection_info: _models.SqlConnectionInfo, backup_file_share: _models.FileShare, selected_certificates: List[_models.SelectedCertificateInput], **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • connection_info (SqlConnectionInfo) – Connection information for SQL Server. Required.

  • backup_file_share (FileShare) – Backup file share information for file share to be used for temporarily storing files. Required.

  • selected_certificates (list[SelectedCertificateInput]) – List containing certificate names and corresponding password to use for encrypting the exported certificate. Required.

Keyword Arguments

  • connection_info (SqlConnectionInfo) – Connection information for SQL Server. Required.

  • backup_file_share (FileShare) – Backup file share information for file share to be used for temporarily storing files. Required.

  • selected_certificates (list[SelectedCertificateInput]) – List containing certificate names and corresponding password to use for encrypting the exported certificate. Required.

class azure.mgmt.datamigration.models.GetTdeCertificatesSqlTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • base64_encoded_certificates (str) – Mapping from certificate name to base 64 encoded format.

  • validation_errors (list[ReportableException]) – Validation errors.

class azure.mgmt.datamigration.models.GetTdeCertificatesSqlTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.GetTdeCertificatesSqlTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (GetTdeCertificatesSqlTaskInput) – Task input.

  • output (list[GetTdeCertificatesSqlTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.GetUserTablesMySqlTaskInput(*, connection_info: _models.MySqlConnectionInfo, selected_databases: List[str], **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • connection_info (MySqlConnectionInfo) – Connection information for SQL Server. Required.

  • selected_databases (list[str]) – List of database names to collect tables for. Required.

Keyword Arguments

  • connection_info (MySqlConnectionInfo) – Connection information for SQL Server. Required.

  • selected_databases (list[str]) – List of database names to collect tables for. Required.

class azure.mgmt.datamigration.models.GetUserTablesMySqlTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Result identifier.

  • databases_to_tables (str) – Mapping from database name to list of tables.

  • validation_errors (list[ReportableException]) – Validation errors.

class azure.mgmt.datamigration.models.GetUserTablesMySqlTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.GetUserTablesMySqlTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (GetUserTablesMySqlTaskInput) – Task input.

  • output (list[GetUserTablesMySqlTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.GetUserTablesOracleTaskInput(*, connection_info: _models.OracleConnectionInfo, selected_schemas: List[str], **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • connection_info (OracleConnectionInfo) – Information for connecting to Oracle source. Required.

  • selected_schemas (list[str]) – List of Oracle schemas for which to collect tables. Required.

Keyword Arguments

  • connection_info (OracleConnectionInfo) – Information for connecting to Oracle source. Required.

  • selected_schemas (list[str]) – List of Oracle schemas for which to collect tables. Required.

class azure.mgmt.datamigration.models.GetUserTablesOracleTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • schema_name (str) – The schema this result is for.

  • tables (list[DatabaseTable]) – List of valid tables found for this schema.

  • validation_errors (list[ReportableException]) – Validation errors associated with the task.

class azure.mgmt.datamigration.models.GetUserTablesOracleTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.GetUserTablesOracleTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (GetUserTablesOracleTaskInput) – Task input.

  • output (list[GetUserTablesOracleTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.GetUserTablesPostgreSqlTaskInput(*, connection_info: _models.PostgreSqlConnectionInfo, selected_databases: List[str], **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • connection_info (PostgreSqlConnectionInfo) – Information for connecting to PostgreSQL source. Required.

  • selected_databases (list[str]) – List of PostgreSQL databases for which to collect tables. Required.

Keyword Arguments

  • connection_info (PostgreSqlConnectionInfo) – Information for connecting to PostgreSQL source. Required.

  • selected_databases (list[str]) – List of PostgreSQL databases for which to collect tables. Required.

class azure.mgmt.datamigration.models.GetUserTablesPostgreSqlTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • database_name (str) – The database this result is for.

  • tables (list[DatabaseTable]) – List of valid tables found for this database.

  • validation_errors (list[ReportableException]) – Validation errors associated with the task.

class azure.mgmt.datamigration.models.GetUserTablesPostgreSqlTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.GetUserTablesPostgreSqlTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (GetUserTablesPostgreSqlTaskInput) – Task input.

  • output (list[GetUserTablesPostgreSqlTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.GetUserTablesSqlSyncTaskInput(*, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.SqlConnectionInfo, selected_source_databases: List[str], selected_target_databases: List[str], **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • source_connection_info (SqlConnectionInfo) – Connection information for SQL Server. Required.

  • target_connection_info (SqlConnectionInfo) – Connection information for SQL DB. Required.

  • selected_source_databases (list[str]) – List of source database names to collect tables for. Required.

  • selected_target_databases (list[str]) – List of target database names to collect tables for. Required.

Keyword Arguments

  • source_connection_info (SqlConnectionInfo) – Connection information for SQL Server. Required.

  • target_connection_info (SqlConnectionInfo) – Connection information for SQL DB. Required.

  • selected_source_databases (list[str]) – List of source database names to collect tables for. Required.

  • selected_target_databases (list[str]) – List of target database names to collect tables for. Required.

class azure.mgmt.datamigration.models.GetUserTablesSqlSyncTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • databases_to_source_tables (str) – Mapping from database name to list of source tables.

  • databases_to_target_tables (str) – Mapping from database name to list of target tables.

  • table_validation_errors (str) – Mapping from database name to list of validation errors.

  • validation_errors (list[ReportableException]) – Validation errors.

class azure.mgmt.datamigration.models.GetUserTablesSqlSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.GetUserTablesSqlSyncTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (GetUserTablesSqlSyncTaskInput) – Task input.

  • output (list[GetUserTablesSqlSyncTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.GetUserTablesSqlTaskInput(*, connection_info: _models.SqlConnectionInfo, selected_databases: List[str], encrypted_key_for_secure_fields: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • connection_info (SqlConnectionInfo) – Connection information for SQL Server. Required.

  • selected_databases (list[str]) – List of database names to collect tables for. Required.

  • encrypted_key_for_secure_fields (str) – encrypted key for secure fields.

Keyword Arguments

  • connection_info (SqlConnectionInfo) – Connection information for SQL Server. Required.

  • selected_databases (list[str]) – List of database names to collect tables for. Required.

  • encrypted_key_for_secure_fields (str) – encrypted key for secure fields.

class azure.mgmt.datamigration.models.GetUserTablesSqlTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Result identifier.

  • databases_to_tables (str) – Mapping from database name to list of tables.

  • validation_errors (list[ReportableException]) – Validation errors.

class azure.mgmt.datamigration.models.GetUserTablesSqlTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.GetUserTablesSqlTaskInput] = None, task_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (GetUserTablesSqlTaskInput) – Task input.

  • output (list[GetUserTablesSqlTaskOutput]) – Task output. This is ignored if submitted.

  • task_id (str) – Task id.

Keyword Arguments
class azure.mgmt.datamigration.models.InstallOCIDriverTaskInput(*, driver_package_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Input for the service task to install an OCI driver.

Variables

driver_package_name (str) – Name of the uploaded driver package to install.

Keyword Arguments

driver_package_name (str) – Name of the uploaded driver package to install.

class azure.mgmt.datamigration.models.InstallOCIDriverTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Output for the service task to install an OCI driver.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

validation_errors (list[ReportableException]) – Validation errors.

class azure.mgmt.datamigration.models.InstallOCIDriverTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.InstallOCIDriverTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

Properties for the task that installs an OCI driver.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (InstallOCIDriverTaskInput) – Input for the service task to install an OCI driver.

  • output (list[InstallOCIDriverTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (InstallOCIDriverTaskInput) – Input for the service task to install an OCI driver.

class azure.mgmt.datamigration.models.IntegrationRuntimeMonitoringData(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Integration Runtime Monitoring Data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name (str) – The name of Integration Runtime.

  • nodes (list[NodeMonitoringData]) – Integration Runtime node monitoring data.

class azure.mgmt.datamigration.models.LoginMigrationStage(value)[source]

Bases: str, enum.Enum

Enum of the different stage of login migration.

ASSIGN_ROLE_MEMBERSHIP = 'AssignRoleMembership'
ASSIGN_ROLE_OWNERSHIP = 'AssignRoleOwnership'
COMPLETED = 'Completed'
ESTABLISH_OBJECT_PERMISSIONS = 'EstablishObjectPermissions'
ESTABLISH_SERVER_PERMISSIONS = 'EstablishServerPermissions'
ESTABLISH_USER_MAPPING = 'EstablishUserMapping'
INITIALIZE = 'Initialize'
LOGIN_MIGRATION = 'LoginMigration'
NONE = 'None'
class azure.mgmt.datamigration.models.LoginType(value)[source]

Bases: str, enum.Enum

Enum mapping of SMO LoginType.

ASYMMETRIC_KEY = 'AsymmetricKey'
CERTIFICATE = 'Certificate'
EXTERNAL_GROUP = 'ExternalGroup'
EXTERNAL_USER = 'ExternalUser'
SQL_LOGIN = 'SqlLogin'
WINDOWS_GROUP = 'WindowsGroup'
WINDOWS_USER = 'WindowsUser'
class azure.mgmt.datamigration.models.MiSqlConnectionInfo(*, managed_instance_resource_id: str, user_name: Optional[str] = None, password: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ConnectionInfo

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

All required parameters must be populated in order to send to Azure.

Variables

  • type (str) – Type of connection info. Required.

  • user_name (str) – User name.

  • password (str) – Password credential.

  • managed_instance_resource_id (str) – Resource id for Azure SQL database Managed instance. Required.

Keyword Arguments

  • user_name (str) – User name.

  • password (str) – Password credential.

  • managed_instance_resource_id (str) – Resource id for Azure SQL database Managed instance. Required.

class azure.mgmt.datamigration.models.MigrateMISyncCompleteCommandInput(*, source_database_name: str, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

source_database_name (str) – Name of managed instance database. Required.

Keyword Arguments

source_database_name (str) – Name of managed instance database. Required.

class azure.mgmt.datamigration.models.MigrateMISyncCompleteCommandOutput(*, errors: Optional[List[_models.ReportableException]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables

errors (list[ReportableException]) – List of errors that happened during the command execution.

Keyword Arguments

errors (list[ReportableException]) – List of errors that happened during the command execution.

class azure.mgmt.datamigration.models.MigrateMISyncCompleteCommandProperties(*, input: Optional[_models.MigrateMISyncCompleteCommandInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.CommandProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • command_type (str or CommandType) – Command type. Required. Known values are: “Migrate.Sync.Complete.Database”, “Migrate.SqlServer.AzureDbSqlMi.Complete”, “cancel”, “finish”, and “restart”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or CommandState) – The state of the command. This is ignored if submitted. Known values are: “Unknown”, “Accepted”, “Running”, “Succeeded”, and “Failed”.

  • input (MigrateMISyncCompleteCommandInput) – Command input.

  • output (MigrateMISyncCompleteCommandOutput) – Command output. This is ignored if submitted.

Keyword Arguments

input (MigrateMISyncCompleteCommandInput) – Command input.

class azure.mgmt.datamigration.models.MigrateMongoDbTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MongoDbMigrationSettings] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

Properties for the task that migrates data between MongoDB data sources.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MongoDbMigrationSettings) – Describes how a MongoDB data migration should be performed.

  • output (list[MongoDbProgress]) –

Keyword Arguments

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MongoDbMigrationSettings) – Describes how a MongoDB data migration should be performed.

class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlOfflineDatabaseInput(*, name: Optional[str] = None, target_database_name: Optional[str] = None, table_map: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables

  • name (str) – Name of the database.

  • target_database_name (str) – Name of target database. Note: Target database will be truncated before starting migration.

  • table_map (dict[str, str]) – Mapping of source to target tables.

Keyword Arguments

  • name (str) – Name of the database.

  • target_database_name (str) – Name of target database. Note: Target database will be truncated before starting migration.

  • table_map (dict[str, str]) – Mapping of source to target tables.

class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlOfflineTaskInput(*, source_connection_info: _models.MySqlConnectionInfo, target_connection_info: _models.MySqlConnectionInfo, selected_databases: List[_models.MigrateMySqlAzureDbForMySqlOfflineDatabaseInput], make_source_server_read_only: bool = False, started_on: Optional[datetime.datetime] = None, optional_agent_settings: Optional[Dict[str, str]] = None, encrypted_key_for_secure_fields: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • source_connection_info (MySqlConnectionInfo) – Connection information for source MySQL. Required.

  • target_connection_info (MySqlConnectionInfo) – Connection information for target Azure Database for MySQL. Required.

  • selected_databases (list[MigrateMySqlAzureDbForMySqlOfflineDatabaseInput]) – Databases to migrate. Required.

  • make_source_server_read_only (bool) – Setting to set the source server read only.

  • started_on (datetime) – Parameter to specify when the migration started.

  • optional_agent_settings (dict[str, str]) – Optional parameters for fine tuning the data transfer rate during migration.

  • encrypted_key_for_secure_fields (str) – encrypted key for secure fields.

Keyword Arguments

  • source_connection_info (MySqlConnectionInfo) – Connection information for source MySQL. Required.

  • target_connection_info (MySqlConnectionInfo) – Connection information for target Azure Database for MySQL. Required.

  • selected_databases (list[MigrateMySqlAzureDbForMySqlOfflineDatabaseInput]) – Databases to migrate. Required.

  • make_source_server_read_only (bool) – Setting to set the source server read only.

  • started_on (datetime) – Parameter to specify when the migration started.

  • optional_agent_settings (dict[str, str]) – Optional parameters for fine tuning the data transfer rate during migration.

  • encrypted_key_for_secure_fields (str) – encrypted key for secure fields.

class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlOfflineTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel, MigrateMySqlAzureDbForMySqlOfflineTaskOutputError, MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel, MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateMySqlAzureDbForMySqlOfflineTaskOutput

MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • database_name (str) – Name of the database.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • state (str or MigrationState) – Current state of migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • stage (str or DatabaseMigrationStage) – Migration stage that this database is in. Known values are: “None”, “Initialize”, “Backup”, “FileCopy”, “Restore”, and “Completed”.

  • status_message (str) – Status message.

  • message (str) – Migration progress message.

  • number_of_objects (int) – Number of objects.

  • number_of_objects_completed (int) – Number of successfully completed objects.

  • error_count (int) – Number of database/object errors.

  • error_prefix (str) – Wildcard string prefix to use for querying all errors of the item.

  • result_prefix (str) – Wildcard string prefix to use for querying all sub-tem results of the item.

  • exceptions_and_warnings (list[ReportableException]) – Migration exceptions and warnings.

  • last_storage_update (datetime) – Last time the storage was updated.

  • object_summary (str) – Summary of object results in the migration.

class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlOfflineTaskOutputError(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateMySqlAzureDbForMySqlOfflineTaskOutput

MigrateMySqlAzureDbForMySqlOfflineTaskOutputError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel(*, databases: Optional[str] = None, migration_report_result: Optional[_models.MigrationReportResult] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateMySqlAzureDbForMySqlOfflineTaskOutput

MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • duration_in_seconds (int) – Duration of task execution in seconds.

  • status (str or MigrationStatus) – Current status of migration. Known values are: “Default”, “Connecting”, “SourceAndTargetSelected”, “SelectLogins”, “Configured”, “Running”, “Error”, “Stopped”, “Completed”, and “CompletedWithWarnings”.

  • status_message (str) – Migration status message.

  • message (str) – Migration progress message.

  • databases (str) – Selected databases as a map from database name to database id.

  • database_summary (str) – Summary of database results in the migration.

  • migration_report_result (MigrationReportResult) – Migration Report Result, provides unique url for downloading your migration report.

  • source_server_version (str) – Source server version.

  • source_server_brand_version (str) – Source server brand version.

  • target_server_version (str) – Target server version.

  • target_server_brand_version (str) – Target server brand version.

  • exceptions_and_warnings (list[ReportableException]) – Migration exceptions and warnings.

  • last_storage_update (datetime) – Last time the storage was updated.

Keyword Arguments

  • databases (str) – Selected databases as a map from database name to database id.

  • migration_report_result (MigrationReportResult) – Migration Report Result, provides unique url for downloading your migration report.

class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateMySqlAzureDbForMySqlOfflineTaskOutput

MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • object_name (str) – Name of the item.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • state (str or MigrationState) – Current state of migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • status_message (str) – Status message.

  • items_count (int) – Number of items.

  • items_completed_count (int) – Number of successfully completed items.

  • error_prefix (str) – Wildcard string prefix to use for querying all errors of the item.

  • result_prefix (str) – Wildcard string prefix to use for querying all sub-tem results of the item.

  • last_storage_update (datetime) – Last time the storage was updated.

class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlOfflineTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MigrateMySqlAzureDbForMySqlOfflineTaskInput] = None, is_cloneable: Optional[bool] = None, task_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateMySqlAzureDbForMySqlOfflineTaskInput) – Task input.

  • output (list[MigrateMySqlAzureDbForMySqlOfflineTaskOutput]) – Task output. This is ignored if submitted.

  • is_cloneable (bool) – whether the task can be cloned or not.

  • task_id (str) – Task id.

Keyword Arguments
class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlSyncDatabaseInput(*, name: Optional[str] = None, target_database_name: Optional[str] = None, migration_setting: Optional[Dict[str, str]] = None, source_setting: Optional[Dict[str, str]] = None, target_setting: Optional[Dict[str, str]] = None, table_map: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables

  • name (str) – Name of the database.

  • target_database_name (str) – Name of target database. Note: Target database will be truncated before starting migration.

  • migration_setting (dict[str, str]) – Migration settings which tune the migration behavior.

  • source_setting (dict[str, str]) – Source settings to tune source endpoint migration behavior.

  • target_setting (dict[str, str]) – Target settings to tune target endpoint migration behavior.

  • table_map (dict[str, str]) – Mapping of source to target tables.

Keyword Arguments

  • name (str) – Name of the database.

  • target_database_name (str) – Name of target database. Note: Target database will be truncated before starting migration.

  • migration_setting (dict[str, str]) – Migration settings which tune the migration behavior.

  • source_setting (dict[str, str]) – Source settings to tune source endpoint migration behavior.

  • target_setting (dict[str, str]) – Target settings to tune target endpoint migration behavior.

  • table_map (dict[str, str]) – Mapping of source to target tables.

class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlSyncTaskInput(*, source_connection_info: _models.MySqlConnectionInfo, target_connection_info: _models.MySqlConnectionInfo, selected_databases: List[_models.MigrateMySqlAzureDbForMySqlSyncDatabaseInput], **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlSyncTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError, MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel, MigrateMySqlAzureDbForMySqlSyncTaskOutputError, MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel, MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError(*, error_message: Optional[str] = None, events: Optional[List[_models.SyncMigrationDatabaseErrorEvent]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateMySqlAzureDbForMySqlSyncTaskOutput

MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateMySqlAzureDbForMySqlSyncTaskOutput

MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • database_name (str) – Name of the database.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • migration_state (str or SyncDatabaseMigrationReportingState) – Migration state that this database is in. Known values are: “UNDEFINED”, “CONFIGURING”, “INITIALIAZING”, “STARTING”, “RUNNING”, “READY_TO_COMPLETE”, “COMPLETING”, “COMPLETE”, “CANCELLING”, “CANCELLED”, “FAILED”, “VALIDATING”, “VALIDATION_COMPLETE”, “VALIDATION_FAILED”, “RESTORE_IN_PROGRESS”, “RESTORE_COMPLETED”, “BACKUP_IN_PROGRESS”, and “BACKUP_COMPLETED”.

  • incoming_changes (int) – Number of incoming changes.

  • applied_changes (int) – Number of applied changes.

  • cdc_insert_counter (int) – Number of cdc inserts.

  • cdc_delete_counter (int) – Number of cdc deletes.

  • cdc_update_counter (int) – Number of cdc updates.

  • full_load_completed_tables (int) – Number of tables completed in full load.

  • full_load_loading_tables (int) – Number of tables loading in full load.

  • full_load_queued_tables (int) – Number of tables queued in full load.

  • full_load_errored_tables (int) – Number of tables errored in full load.

  • initialization_completed (bool) – Indicates if initial load (full load) has been completed.

  • latency (int) – CDC apply latency.

class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlSyncTaskOutputError(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateMySqlAzureDbForMySqlSyncTaskOutput

MigrateMySqlAzureDbForMySqlSyncTaskOutputError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateMySqlAzureDbForMySqlSyncTaskOutput

MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • source_server_version (str) – Source server version.

  • source_server (str) – Source server name.

  • target_server_version (str) – Target server version.

  • target_server (str) – Target server name.

class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateMySqlAzureDbForMySqlSyncTaskOutput

MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • table_name (str) – Name of the table.

  • database_name (str) – Name of the database.

  • cdc_insert_counter (str) – Number of applied inserts.

  • cdc_update_counter (str) – Number of applied updates.

  • cdc_delete_counter (str) – Number of applied deletes.

  • full_load_est_finish_time (datetime) – Estimate to finish full load.

  • full_load_started_on (datetime) – Full load start time.

  • full_load_ended_on (datetime) – Full load end time.

  • full_load_total_rows (int) – Number of rows applied in full load.

  • state (str or SyncTableMigrationState) – Current state of the table migration. Known values are: “BEFORE_LOAD”, “FULL_LOAD”, “COMPLETED”, “CANCELED”, “ERROR”, and “FAILED”.

  • total_changes_applied (int) – Total number of applied changes.

  • data_errors_counter (int) – Number of data errors occurred.

  • last_modified_time (datetime) – Last modified time on target.

class azure.mgmt.datamigration.models.MigrateMySqlAzureDbForMySqlSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MigrateMySqlAzureDbForMySqlSyncTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateMySqlAzureDbForMySqlSyncTaskInput) – Task input.

  • output (list[MigrateMySqlAzureDbForMySqlSyncTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.MigrateOracleAzureDbForPostgreSqlSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MigrateOracleAzureDbPostgreSqlSyncTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateOracleAzureDbPostgreSqlSyncTaskInput) – Task input.

  • output (list[MigrateOracleAzureDbPostgreSqlSyncTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.MigrateOracleAzureDbPostgreSqlSyncDatabaseInput(*, case_manipulation: Optional[str] = None, name: Optional[str] = None, schema_name: Optional[str] = None, table_map: Optional[Dict[str, str]] = None, target_database_name: Optional[str] = None, migration_setting: Optional[Dict[str, str]] = None, source_setting: Optional[Dict[str, str]] = None, target_setting: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables

  • case_manipulation (str) – How to handle object name casing: either Preserve or ToLower.

  • name (str) – Name of the migration pipeline.

  • schema_name (str) – Name of the source schema.

  • table_map (dict[str, str]) – Mapping of source to target tables.

  • target_database_name (str) – Name of target database. Note: Target database will be truncated before starting migration.

  • migration_setting (dict[str, str]) – Migration settings which tune the migration behavior.

  • source_setting (dict[str, str]) – Source settings to tune source endpoint migration behavior.

  • target_setting (dict[str, str]) – Target settings to tune target endpoint migration behavior.

Keyword Arguments

  • case_manipulation (str) – How to handle object name casing: either Preserve or ToLower.

  • name (str) – Name of the migration pipeline.

  • schema_name (str) – Name of the source schema.

  • table_map (dict[str, str]) – Mapping of source to target tables.

  • target_database_name (str) – Name of target database. Note: Target database will be truncated before starting migration.

  • migration_setting (dict[str, str]) – Migration settings which tune the migration behavior.

  • source_setting (dict[str, str]) – Source settings to tune source endpoint migration behavior.

  • target_setting (dict[str, str]) – Target settings to tune target endpoint migration behavior.

class azure.mgmt.datamigration.models.MigrateOracleAzureDbPostgreSqlSyncTaskInput(*, selected_databases: List[_models.MigrateOracleAzureDbPostgreSqlSyncDatabaseInput], target_connection_info: _models.PostgreSqlConnectionInfo, source_connection_info: _models.OracleConnectionInfo, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.MigrateOracleAzureDbPostgreSqlSyncTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError, MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel, MigrateOracleAzureDbPostgreSqlSyncTaskOutputError, MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel, MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

class azure.mgmt.datamigration.models.MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError(*, error_message: Optional[str] = None, events: Optional[List[_models.SyncMigrationDatabaseErrorEvent]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateOracleAzureDbPostgreSqlSyncTaskOutput

MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateOracleAzureDbPostgreSqlSyncTaskOutput

MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • database_name (str) – Name of the database.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • migration_state (str or SyncDatabaseMigrationReportingState) – Migration state that this database is in. Known values are: “UNDEFINED”, “CONFIGURING”, “INITIALIAZING”, “STARTING”, “RUNNING”, “READY_TO_COMPLETE”, “COMPLETING”, “COMPLETE”, “CANCELLING”, “CANCELLED”, “FAILED”, “VALIDATING”, “VALIDATION_COMPLETE”, “VALIDATION_FAILED”, “RESTORE_IN_PROGRESS”, “RESTORE_COMPLETED”, “BACKUP_IN_PROGRESS”, and “BACKUP_COMPLETED”.

  • incoming_changes (int) – Number of incoming changes.

  • applied_changes (int) – Number of applied changes.

  • cdc_insert_counter (int) – Number of cdc inserts.

  • cdc_delete_counter (int) – Number of cdc deletes.

  • cdc_update_counter (int) – Number of cdc updates.

  • full_load_completed_tables (int) – Number of tables completed in full load.

  • full_load_loading_tables (int) – Number of tables loading in full load.

  • full_load_queued_tables (int) – Number of tables queued in full load.

  • full_load_errored_tables (int) – Number of tables errored in full load.

  • initialization_completed (bool) – Indicates if initial load (full load) has been completed.

  • latency (int) – CDC apply latency.

class azure.mgmt.datamigration.models.MigrateOracleAzureDbPostgreSqlSyncTaskOutputError(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateOracleAzureDbPostgreSqlSyncTaskOutput

MigrateOracleAzureDbPostgreSqlSyncTaskOutputError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
class azure.mgmt.datamigration.models.MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateOracleAzureDbPostgreSqlSyncTaskOutput

MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • source_server_version (str) – Source server version.

  • source_server (str) – Source server name.

  • target_server_version (str) – Target server version.

  • target_server (str) – Target server name.

class azure.mgmt.datamigration.models.MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateOracleAzureDbPostgreSqlSyncTaskOutput

MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • table_name (str) – Name of the table.

  • database_name (str) – Name of the database.

  • cdc_insert_counter (int) – Number of applied inserts.

  • cdc_update_counter (int) – Number of applied updates.

  • cdc_delete_counter (int) – Number of applied deletes.

  • full_load_est_finish_time (datetime) – Estimate to finish full load.

  • full_load_started_on (datetime) – Full load start time.

  • full_load_ended_on (datetime) – Full load end time.

  • full_load_total_rows (int) – Number of rows applied in full load.

  • state (str or SyncTableMigrationState) – Current state of the table migration. Known values are: “BEFORE_LOAD”, “FULL_LOAD”, “COMPLETED”, “CANCELED”, “ERROR”, and “FAILED”.

  • total_changes_applied (int) – Total number of applied changes.

  • data_errors_counter (int) – Number of data errors occurred.

  • last_modified_time (datetime) – Last modified time on target.

class azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput(*, name: Optional[str] = None, target_database_name: Optional[str] = None, migration_setting: Optional[Dict[str, Any]] = None, source_setting: Optional[Dict[str, str]] = None, target_setting: Optional[Dict[str, str]] = None, selected_tables: Optional[List[_models.MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name (str) – Name of the database.

  • id (str) – Result identifier.

  • target_database_name (str) – Name of target database. Note: Target database will be truncated before starting migration.

  • migration_setting (dict[str, any]) – Migration settings which tune the migration behavior.

  • source_setting (dict[str, str]) – Source settings to tune source endpoint migration behavior.

  • target_setting (dict[str, str]) – Target settings to tune target endpoint migration behavior.

  • selected_tables (list[MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput]) – Tables selected for migration.

Keyword Arguments

  • name (str) – Name of the database.

  • target_database_name (str) – Name of target database. Note: Target database will be truncated before starting migration.

  • migration_setting (dict[str, any]) – Migration settings which tune the migration behavior.

  • source_setting (dict[str, str]) – Source settings to tune source endpoint migration behavior.

  • target_setting (dict[str, str]) – Target settings to tune target endpoint migration behavior.

  • selected_tables (list[MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput]) – Tables selected for migration.

class azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput(*, name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Selected tables for the migration.

Variables

name (str) – Name of the table to migrate.

Keyword Arguments

name (str) – Name of the table to migrate.

class azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput(*, selected_databases: List[_models.MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput], target_connection_info: _models.PostgreSqlConnectionInfo, source_connection_info: _models.PostgreSqlConnectionInfo, encrypted_key_for_secure_fields: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError, MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel, MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError, MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel, MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

class azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError(*, error_message: Optional[str] = None, events: Optional[List[_models.SyncMigrationDatabaseErrorEvent]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • database_name (str) – Name of the database.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • migration_state (str or SyncDatabaseMigrationReportingState) – Migration state that this database is in. Known values are: “UNDEFINED”, “CONFIGURING”, “INITIALIAZING”, “STARTING”, “RUNNING”, “READY_TO_COMPLETE”, “COMPLETING”, “COMPLETE”, “CANCELLING”, “CANCELLED”, “FAILED”, “VALIDATING”, “VALIDATION_COMPLETE”, “VALIDATION_FAILED”, “RESTORE_IN_PROGRESS”, “RESTORE_COMPLETED”, “BACKUP_IN_PROGRESS”, and “BACKUP_COMPLETED”.

  • incoming_changes (int) – Number of incoming changes.

  • applied_changes (int) – Number of applied changes.

  • cdc_insert_counter (int) – Number of cdc inserts.

  • cdc_delete_counter (int) – Number of cdc deletes.

  • cdc_update_counter (int) – Number of cdc updates.

  • full_load_completed_tables (int) – Number of tables completed in full load.

  • full_load_loading_tables (int) – Number of tables loading in full load.

  • full_load_queued_tables (int) – Number of tables queued in full load.

  • full_load_errored_tables (int) – Number of tables errored in full load.

  • initialization_completed (bool) – Indicates if initial load (full load) has been completed.

  • latency (int) – CDC apply latency.

class azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError(*, events: Optional[List[_models.SyncMigrationDatabaseErrorEvent]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments

events (list[SyncMigrationDatabaseErrorEvent]) – List of error events.

class azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel(*, database_count: Optional[float] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • source_server_version (str) – Source server version.

  • source_server (str) – Source server name.

  • target_server_version (str) – Target server version.

  • target_server (str) – Target server name.

  • source_server_type (str or ScenarioSource) – Source server type. Known values are: “Access”, “DB2”, “MySQL”, “Oracle”, “SQL”, “Sybase”, “PostgreSQL”, “MongoDB”, “SQLRDS”, “MySQLRDS”, and “PostgreSQLRDS”.

  • target_server_type (str or ScenarioTarget) – Target server type. Known values are: “SQLServer”, “SQLDB”, “SQLDW”, “SQLMI”, “AzureDBForMySql”, “AzureDBForPostgresSQL”, and “MongoDB”.

  • state (str or ReplicateMigrationState) – Migration status. Known values are: “UNDEFINED”, “VALIDATING”, “PENDING”, “COMPLETE”, “ACTION_REQUIRED”, and “FAILED”.

  • database_count (float) – Number of databases to include.

Keyword Arguments

database_count (float) – Number of databases to include.

class azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • table_name (str) – Name of the table.

  • database_name (str) – Name of the database.

  • cdc_insert_counter (int) – Number of applied inserts.

  • cdc_update_counter (int) – Number of applied updates.

  • cdc_delete_counter (int) – Number of applied deletes.

  • full_load_est_finish_time (datetime) – Estimate to finish full load.

  • full_load_started_on (datetime) – Full load start time.

  • full_load_ended_on (datetime) – Full load end time.

  • full_load_total_rows (int) – Number of rows applied in full load.

  • state (str or SyncTableMigrationState) – Current state of the table migration. Known values are: “BEFORE_LOAD”, “FULL_LOAD”, “COMPLETED”, “CANCELED”, “ERROR”, and “FAILED”.

  • total_changes_applied (int) – Total number of applied changes.

  • data_errors_counter (int) – Number of data errors occurred.

  • last_modified_time (datetime) – Last modified time on target.

class azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput] = None, task_id: Optional[str] = None, created_on: Optional[str] = None, is_cloneable: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput) – Task input.

  • output (list[MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput]) – Task output. This is ignored if submitted.

  • task_id (str) – task id.

  • created_on (str) – DateTime in UTC when the task was created.

  • is_cloneable (bool) – whether the task can be cloned or not.

Keyword Arguments
class azure.mgmt.datamigration.models.MigrateSchemaSqlServerSqlDbDatabaseInput(*, name: Optional[str] = None, id: Optional[str] = None, target_database_name: Optional[str] = None, schema_setting: Optional[_models.SchemaMigrationSetting] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Database input for migrate schema Sql Server to Azure SQL Server scenario.

Variables

  • name (str) – Name of source database.

  • id (str) – Id of the source database.

  • target_database_name (str) – Name of target database.

  • schema_setting (SchemaMigrationSetting) – Database schema migration settings.

Keyword Arguments

  • name (str) – Name of source database.

  • id (str) – Id of the source database.

  • target_database_name (str) – Name of target database.

  • schema_setting (SchemaMigrationSetting) – Database schema migration settings.

class azure.mgmt.datamigration.models.MigrateSchemaSqlServerSqlDbTaskInput(*, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.SqlConnectionInfo, selected_databases: List[_models.MigrateSchemaSqlServerSqlDbDatabaseInput], encrypted_key_for_secure_fields: Optional[str] = None, started_on: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.SqlMigrationTaskInput

Input for task that migrates Schema for SQL Server databases to Azure SQL databases.

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.MigrateSchemaSqlServerSqlDbTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Output for the task that migrates Schema for SQL Server databases to Azure SQL databases.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel, MigrateSchemaSqlTaskOutputError, MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel, MigrateSchemaSqlServerSqlDbTaskOutputError

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

class azure.mgmt.datamigration.models.MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSchemaSqlServerSqlDbTaskOutput

MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • database_name (str) – The name of the database.

  • state (str or MigrationState) – State of the schema migration for this database. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • stage (str or SchemaMigrationStage) – Schema migration stage for this database. Known values are: “NotStarted”, “ValidatingInputs”, “CollectingObjects”, “DownloadingScript”, “GeneratingScript”, “UploadingScript”, “DeployingSchema”, “Completed”, “CompletedWithWarnings”, and “Failed”.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • database_error_result_prefix (str) – Prefix string to use for querying errors for this database.

  • schema_error_result_prefix (str) – Prefix string to use for querying schema errors for this database.

  • number_of_successful_operations (int) – Number of successful operations for this database.

  • number_of_failed_operations (int) – Number of failed operations for this database.

  • file_id (str) – Identifier for the file resource containing the schema of this database.

class azure.mgmt.datamigration.models.MigrateSchemaSqlServerSqlDbTaskOutputError(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSchemaSqlServerSqlDbTaskOutput

MigrateSchemaSqlServerSqlDbTaskOutputError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • command_text (str) – Schema command which failed.

  • error_text (str) – Reason of failure.

class azure.mgmt.datamigration.models.MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSchemaSqlServerSqlDbTaskOutput

MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • state (str or MigrationState) – Overall state of the schema migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • source_server_version (str) – Source server version.

  • source_server_brand_version (str) – Source server brand version.

  • target_server_version (str) – Target server version.

  • target_server_brand_version (str) – Target server brand version.

class azure.mgmt.datamigration.models.MigrateSchemaSqlServerSqlDbTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MigrateSchemaSqlServerSqlDbTaskInput] = None, created_on: Optional[str] = None, task_id: Optional[str] = None, is_cloneable: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

Properties for task that migrates Schema for SQL Server databases to Azure SQL databases.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateSchemaSqlServerSqlDbTaskInput) – Task input.

  • output (list[MigrateSchemaSqlServerSqlDbTaskOutput]) – Task output. This is ignored if submitted.

  • created_on (str) – DateTime in UTC when the task was created.

  • task_id (str) – Task id.

  • is_cloneable (bool) – whether the task can be cloned or not.

Keyword Arguments

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateSchemaSqlServerSqlDbTaskInput) – Task input.

  • created_on (str) – DateTime in UTC when the task was created.

  • task_id (str) – Task id.

  • is_cloneable (bool) – whether the task can be cloned or not.

class azure.mgmt.datamigration.models.MigrateSchemaSqlTaskOutputError(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSchemaSqlServerSqlDbTaskOutput

MigrateSchemaSqlTaskOutputError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
class azure.mgmt.datamigration.models.MigrateSqlServerDatabaseInput(*, name: Optional[str] = None, restore_database_name: Optional[str] = None, backup_and_restore_folder: Optional[str] = None, database_files: Optional[List[_models.DatabaseFileInput]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Database specific information for SQL to SQL migration task inputs.

Variables

  • name (str) – Name of the database.

  • restore_database_name (str) – Name of the database at destination.

  • backup_and_restore_folder (str) – The backup and restore folder.

  • database_files (list[DatabaseFileInput]) – The list of database files.

Keyword Arguments

  • name (str) – Name of the database.

  • restore_database_name (str) – Name of the database at destination.

  • backup_and_restore_folder (str) – The backup and restore folder.

  • database_files (list[DatabaseFileInput]) – The list of database files.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbDatabaseInput(*, name: Optional[str] = None, target_database_name: Optional[str] = None, make_source_db_read_only: Optional[bool] = None, table_map: Optional[Dict[str, str]] = None, schema_setting: Optional[collections.abc.MutableMapping[str, Any]] = None, id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables

  • name (str) – Name of the database.

  • target_database_name (str) – Name of target database. Note: Target database will be truncated before starting migration.

  • make_source_db_read_only (bool) – Whether to set database read only before migration.

  • table_map (dict[str, str]) – Mapping of source to target tables.

  • schema_setting (JSON) – Settings selected for DB schema migration.

  • id (str) – id of the database.

Keyword Arguments

  • name (str) – Name of the database.

  • target_database_name (str) – Name of target database. Note: Target database will be truncated before starting migration.

  • make_source_db_read_only (bool) – Whether to set database read only before migration.

  • table_map (dict[str, str]) – Mapping of source to target tables.

  • schema_setting (JSON) – Settings selected for DB schema migration.

  • id (str) – id of the database.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbSyncDatabaseInput(*, id: Optional[str] = None, name: Optional[str] = None, target_database_name: Optional[str] = None, schema_name: Optional[str] = None, table_map: Optional[Dict[str, str]] = None, migration_setting: Optional[Dict[str, str]] = None, source_setting: Optional[Dict[str, str]] = None, target_setting: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables

  • id (str) – Unique identifier for database.

  • name (str) – Name of database.

  • target_database_name (str) – Target database name.

  • schema_name (str) – Schema name to be migrated.

  • table_map (dict[str, str]) – Mapping of source to target tables.

  • migration_setting (dict[str, str]) – Migration settings which tune the migration behavior.

  • source_setting (dict[str, str]) – Source settings to tune source endpoint migration behavior.

  • target_setting (dict[str, str]) – Target settings to tune target endpoint migration behavior.

Keyword Arguments

  • id (str) – Unique identifier for database.

  • name (str) – Name of database.

  • target_database_name (str) – Target database name.

  • schema_name (str) – Schema name to be migrated.

  • table_map (dict[str, str]) – Mapping of source to target tables.

  • migration_setting (dict[str, str]) – Migration settings which tune the migration behavior.

  • source_setting (dict[str, str]) – Source settings to tune source endpoint migration behavior.

  • target_setting (dict[str, str]) – Target settings to tune target endpoint migration behavior.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbSyncTaskInput(*, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.SqlConnectionInfo, selected_databases: List[_models.MigrateSqlServerSqlDbSyncDatabaseInput], validation_options: Optional[_models.MigrationValidationOptions] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.SqlMigrationTaskInput

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

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbSyncTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MigrateSqlServerSqlDbSyncTaskOutputDatabaseError, MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel, MigrateSqlServerSqlDbSyncTaskOutputError, MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel, MigrateSqlServerSqlDbSyncTaskOutputTableLevel

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbSyncTaskOutputDatabaseError(*, error_message: Optional[str] = None, events: Optional[List[_models.SyncMigrationDatabaseErrorEvent]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlDbSyncTaskOutput

MigrateSqlServerSqlDbSyncTaskOutputDatabaseError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlDbSyncTaskOutput

MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • database_name (str) – Name of the database.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • migration_state (str or SyncDatabaseMigrationReportingState) – Migration state that this database is in. Known values are: “UNDEFINED”, “CONFIGURING”, “INITIALIAZING”, “STARTING”, “RUNNING”, “READY_TO_COMPLETE”, “COMPLETING”, “COMPLETE”, “CANCELLING”, “CANCELLED”, “FAILED”, “VALIDATING”, “VALIDATION_COMPLETE”, “VALIDATION_FAILED”, “RESTORE_IN_PROGRESS”, “RESTORE_COMPLETED”, “BACKUP_IN_PROGRESS”, and “BACKUP_COMPLETED”.

  • incoming_changes (int) – Number of incoming changes.

  • applied_changes (int) – Number of applied changes.

  • cdc_insert_counter (int) – Number of cdc inserts.

  • cdc_delete_counter (int) – Number of cdc deletes.

  • cdc_update_counter (int) – Number of cdc updates.

  • full_load_completed_tables (int) – Number of tables completed in full load.

  • full_load_loading_tables (int) – Number of tables loading in full load.

  • full_load_queued_tables (int) – Number of tables queued in full load.

  • full_load_errored_tables (int) – Number of tables errored in full load.

  • initialization_completed (bool) – Indicates if initial load (full load) has been completed.

  • latency (int) – CDC apply latency.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbSyncTaskOutputError(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlDbSyncTaskOutput

MigrateSqlServerSqlDbSyncTaskOutputError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlDbSyncTaskOutput

MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • source_server_version (str) – Source server version.

  • source_server (str) – Source server name.

  • target_server_version (str) – Target server version.

  • target_server (str) – Target server name.

  • database_count (int) – Count of databases.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbSyncTaskOutputTableLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlDbSyncTaskOutput

MigrateSqlServerSqlDbSyncTaskOutputTableLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • table_name (str) – Name of the table.

  • database_name (str) – Name of the database.

  • cdc_insert_counter (int) – Number of applied inserts.

  • cdc_update_counter (int) – Number of applied updates.

  • cdc_delete_counter (int) – Number of applied deletes.

  • full_load_est_finish_time (datetime) – Estimate to finish full load.

  • full_load_started_on (datetime) – Full load start time.

  • full_load_ended_on (datetime) – Full load end time.

  • full_load_total_rows (int) – Number of rows applied in full load.

  • state (str or SyncTableMigrationState) – Current state of the table migration. Known values are: “BEFORE_LOAD”, “FULL_LOAD”, “COMPLETED”, “CANCELED”, “ERROR”, and “FAILED”.

  • total_changes_applied (int) – Total number of applied changes.

  • data_errors_counter (int) – Number of data errors occurred.

  • last_modified_time (datetime) – Last modified time on target.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MigrateSqlServerSqlDbSyncTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateSqlServerSqlDbSyncTaskInput) – Task input.

  • output (list[MigrateSqlServerSqlDbSyncTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbTaskInput(*, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.SqlConnectionInfo, selected_databases: List[_models.MigrateSqlServerSqlDbDatabaseInput], validation_options: Optional[_models.MigrationValidationOptions] = None, started_on: Optional[str] = None, encrypted_key_for_secure_fields: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.SqlMigrationTaskInput

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

All required parameters must be populated in order to send to Azure.

Variables

  • source_connection_info (SqlConnectionInfo) – Information for connecting to source. Required.

  • target_connection_info (SqlConnectionInfo) – Information for connecting to target. Required.

  • selected_databases (list[MigrateSqlServerSqlDbDatabaseInput]) – Databases to migrate. Required.

  • validation_options (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.

  • started_on (str) – Date and time relative to UTC when the migration was started on.

  • encrypted_key_for_secure_fields (str) – encrypted key for secure fields.

Keyword Arguments

  • source_connection_info (SqlConnectionInfo) – Information for connecting to source. Required.

  • target_connection_info (SqlConnectionInfo) – Information for connecting to target. Required.

  • selected_databases (list[MigrateSqlServerSqlDbDatabaseInput]) – Databases to migrate. Required.

  • validation_options (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.

  • started_on (str) – Date and time relative to UTC when the migration was started on.

  • encrypted_key_for_secure_fields (str) – encrypted key for secure fields.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MigrateSqlServerSqlDbTaskOutputDatabaseLevel, MigrateSqlServerSqlDbTaskOutputError, MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult, MigrateSqlServerSqlDbTaskOutputMigrationLevel, MigrateSqlServerSqlDbTaskOutputValidationResult, MigrateSqlServerSqlDbTaskOutputTableLevel

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbTaskOutputDatabaseLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlDbTaskOutput

MigrateSqlServerSqlDbTaskOutputDatabaseLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • database_name (str) – Name of the item.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • state (str or MigrationState) – Current state of migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • stage (str or DatabaseMigrationStage) – Migration stage that this database is in. Known values are: “None”, “Initialize”, “Backup”, “FileCopy”, “Restore”, and “Completed”.

  • status_message (str) – Status message.

  • message (str) – Migration progress message.

  • number_of_objects (int) – Number of objects.

  • number_of_objects_completed (int) – Number of successfully completed objects.

  • error_count (int) – Number of database/object errors.

  • error_prefix (str) – Wildcard string prefix to use for querying all errors of the item.

  • result_prefix (str) – Wildcard string prefix to use for querying all sub-tem results of the item.

  • exceptions_and_warnings (list[ReportableException]) – Migration exceptions and warnings.

  • object_summary (str) – Summary of object results in the migration.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlDbTaskOutput, azure.mgmt.datamigration.models._models_py3.MigrationValidationDatabaseLevelResult

MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • migration_id (str) – Migration Identifier.

  • source_database_name (str) – Name of the source database.

  • target_database_name (str) – Name of the target database.

  • started_on (datetime) – Validation start time.

  • ended_on (datetime) – Validation end time.

  • data_integrity_validation_result (DataIntegrityValidationResult) – Provides data integrity validation result between the source and target tables that are migrated.

  • schema_validation_result (SchemaComparisonValidationResult) – Provides schema comparison result between source and target database.

  • query_analysis_validation_result (QueryAnalysisValidationResult) – Results of some of the query execution result between source and target database.

  • status (str or ValidationStatus) – Current status of validation at the database level. Known values are: “Default”, “NotStarted”, “Initialized”, “InProgress”, “Completed”, “CompletedWithIssues”, “Stopped”, and “Failed”.

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbTaskOutputError(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlDbTaskOutput

MigrateSqlServerSqlDbTaskOutputError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbTaskOutputMigrationLevel(*, migration_validation_result: Optional[_models.MigrationValidationResult] = None, migration_report_result: Optional[_models.MigrationReportResult] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlDbTaskOutput

MigrateSqlServerSqlDbTaskOutputMigrationLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • duration_in_seconds (int) – Duration of task execution in seconds.

  • status (str or MigrationStatus) – Current status of migration. Known values are: “Default”, “Connecting”, “SourceAndTargetSelected”, “SelectLogins”, “Configured”, “Running”, “Error”, “Stopped”, “Completed”, and “CompletedWithWarnings”.

  • status_message (str) – Migration status message.

  • message (str) – Migration progress message.

  • databases (str) – Selected databases as a map from database name to database id.

  • database_summary (str) – Summary of database results in the migration.

  • migration_validation_result (MigrationValidationResult) – Migration Validation Results.

  • migration_report_result (MigrationReportResult) – Migration Report Result, provides unique url for downloading your migration report.

  • source_server_version (str) – Source server version.

  • source_server_brand_version (str) – Source server brand version.

  • target_server_version (str) – Target server version.

  • target_server_brand_version (str) – Target server brand version.

  • exceptions_and_warnings (list[ReportableException]) – Migration exceptions and warnings.

Keyword Arguments
class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbTaskOutputTableLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlDbTaskOutput

MigrateSqlServerSqlDbTaskOutputTableLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • object_name (str) – Name of the item.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • state (str or MigrationState) – Current state of migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • status_message (str) – Status message.

  • items_count (int) – Number of items.

  • items_completed_count (int) – Number of successfully completed items.

  • error_prefix (str) – Wildcard string prefix to use for querying all errors of the item.

  • result_prefix (str) – Wildcard string prefix to use for querying all sub-tem results of the item.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbTaskOutputValidationResult(*, summary_results: Optional[Dict[str, _models.MigrationValidationDatabaseSummaryResult]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlDbTaskOutput, azure.mgmt.datamigration.models._models_py3.MigrationValidationResult

MigrateSqlServerSqlDbTaskOutputValidationResult.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • migration_id (str) – Migration Identifier.

  • summary_results (dict[str, MigrationValidationDatabaseSummaryResult]) – Validation summary results for each database.

  • status (str or ValidationStatus) – Current status of validation at the migration level. Status from the database validation result status will be aggregated here. Known values are: “Default”, “NotStarted”, “Initialized”, “InProgress”, “Completed”, “CompletedWithIssues”, “Stopped”, and “Failed”.

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

Keyword Arguments

summary_results (dict[str, MigrationValidationDatabaseSummaryResult]) – Validation summary results for each database.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlDbTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MigrateSqlServerSqlDbTaskInput] = None, task_id: Optional[str] = None, is_cloneable: Optional[bool] = None, created_on: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateSqlServerSqlDbTaskInput) – Task input.

  • output (list[MigrateSqlServerSqlDbTaskOutput]) – Task output. This is ignored if submitted.

  • task_id (str) – task id.

  • is_cloneable (bool) – whether the task can be cloned or not.

  • created_on (str) – DateTime in UTC when the task was created.

Keyword Arguments

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateSqlServerSqlDbTaskInput) – Task input.

  • task_id (str) – task id.

  • is_cloneable (bool) – whether the task can be cloned or not.

  • created_on (str) – DateTime in UTC when the task was created.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlMIDatabaseInput(*, name: str, restore_database_name: str, backup_file_share: Optional[_models.FileShare] = None, backup_file_paths: Optional[List[str]] = None, id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • name (str) – Name of the database. Required.

  • restore_database_name (str) – Name of the database at destination. Required.

  • backup_file_share (FileShare) – Backup file share information for backing up this database.

  • backup_file_paths (list[str]) – The list of backup files to be used in case of existing backups.

  • id (str) – id of the database.

Keyword Arguments

  • name (str) – Name of the database. Required.

  • restore_database_name (str) – Name of the database at destination. Required.

  • backup_file_share (FileShare) – Backup file share information for backing up this database.

  • backup_file_paths (list[str]) – The list of backup files to be used in case of existing backups.

  • id (str) – id of the database.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlMISyncTaskInput(*, selected_databases: List[_models.MigrateSqlServerSqlMIDatabaseInput], storage_resource_id: str, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.MiSqlConnectionInfo, azure_app: _models.AzureActiveDirectoryApp, backup_file_share: Optional[_models.FileShare] = None, number_of_parallel_database_migrations: Optional[float] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.SqlServerSqlMISyncTaskInput

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

All required parameters must be populated in order to send to Azure.

Variables

  • selected_databases (list[MigrateSqlServerSqlMIDatabaseInput]) – Databases to migrate. Required.

  • backup_file_share (FileShare) – Backup file share information for all selected databases.

  • storage_resource_id (str) – Fully qualified resourceId of storage. Required.

  • source_connection_info (SqlConnectionInfo) – Connection information for source SQL Server. Required.

  • target_connection_info (MiSqlConnectionInfo) – Connection information for Azure SQL Database Managed Instance. Required.

  • azure_app (AzureActiveDirectoryApp) – Azure Active Directory Application the DMS instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account. Required.

  • number_of_parallel_database_migrations (float) – Number of database migrations to start in parallel.

Keyword Arguments

  • selected_databases (list[MigrateSqlServerSqlMIDatabaseInput]) – Databases to migrate. Required.

  • backup_file_share (FileShare) – Backup file share information for all selected databases.

  • storage_resource_id (str) – Fully qualified resourceId of storage. Required.

  • source_connection_info (SqlConnectionInfo) – Connection information for source SQL Server. Required.

  • target_connection_info (MiSqlConnectionInfo) – Connection information for Azure SQL Database Managed Instance. Required.

  • azure_app (AzureActiveDirectoryApp) – Azure Active Directory Application the DMS instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account. Required.

  • number_of_parallel_database_migrations (float) – Number of database migrations to start in parallel.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlMISyncTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Output for task that migrates SQL Server databases to Azure SQL Database Managed Instance using Log Replay Service.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel, MigrateSqlServerSqlMISyncTaskOutputError, MigrateSqlServerSqlMISyncTaskOutputMigrationLevel

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlMISyncTaskOutput

MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • source_database_name (str) – Name of the database.

  • migration_state (str or DatabaseMigrationState) – Current state of database. Known values are: “UNDEFINED”, “INITIAL”, “FULL_BACKUP_UPLOAD_START”, “LOG_SHIPPING_START”, “UPLOAD_LOG_FILES_START”, “CUTOVER_START”, “POST_CUTOVER_COMPLETE”, “COMPLETED”, “CANCELLED”, and “FAILED”.

  • started_on (datetime) – Database migration start time.

  • ended_on (datetime) – Database migration end time.

  • full_backup_set_info (BackupSetInfo) – Details of full backup set.

  • last_restored_backup_set_info (BackupSetInfo) – Last applied backup set information.

  • active_backup_sets (list[BackupSetInfo]) – Backup sets that are currently active (Either being uploaded or getting restored).

  • container_name (str) – Name of container created in the Azure Storage account where backups are copied to.

  • error_prefix (str) – prefix string to use for querying errors for this database.

  • is_full_backup_restored (bool) – Whether full backup has been applied to the target database or not.

  • exceptions_and_warnings (list[ReportableException]) – Migration exceptions and warnings.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlMISyncTaskOutputError(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlMISyncTaskOutput

MigrateSqlServerSqlMISyncTaskOutputError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
class azure.mgmt.datamigration.models.MigrateSqlServerSqlMISyncTaskOutputMigrationLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlMISyncTaskOutput

MigrateSqlServerSqlMISyncTaskOutputMigrationLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • database_count (int) – Count of databases.

  • state (str or MigrationState) – Current state of migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • source_server_name (str) – Source server name.

  • source_server_version (str) – Source server version.

  • source_server_brand_version (str) – Source server brand version.

  • target_server_name (str) – Target server name.

  • target_server_version (str) – Target server version.

  • target_server_brand_version (str) – Target server brand version.

  • database_error_count (int) – Number of database level errors.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlMISyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MigrateSqlServerSqlMISyncTaskInput] = None, created_on: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateSqlServerSqlMISyncTaskInput) – Task input.

  • output (list[MigrateSqlServerSqlMISyncTaskOutput]) – Task output. This is ignored if submitted.

  • created_on (str) – DateTime in UTC when the task was created.

Keyword Arguments
class azure.mgmt.datamigration.models.MigrateSqlServerSqlMITaskInput(*, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.SqlConnectionInfo, selected_databases: List[_models.MigrateSqlServerSqlMIDatabaseInput], backup_blob_share: _models.BlobShare, started_on: Optional[str] = None, selected_logins: Optional[List[str]] = None, selected_agent_jobs: Optional[List[str]] = None, backup_file_share: Optional[_models.FileShare] = None, backup_mode: Optional[Union[str, _models.BackupMode]] = None, aad_domain_name: Optional[str] = None, encrypted_key_for_secure_fields: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.SqlMigrationTaskInput

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

All required parameters must be populated in order to send to Azure.

Variables

  • source_connection_info (SqlConnectionInfo) – Information for connecting to source. Required.

  • target_connection_info (SqlConnectionInfo) – Information for connecting to target. Required.

  • selected_databases (list[MigrateSqlServerSqlMIDatabaseInput]) – Databases to migrate. Required.

  • started_on (str) – Date and time relative to UTC when the migration was started on.

  • selected_logins (list[str]) – Logins to migrate.

  • selected_agent_jobs (list[str]) – Agent Jobs to migrate.

  • backup_file_share (FileShare) – Backup file share information for all selected databases.

  • backup_blob_share (BlobShare) – SAS URI of Azure Storage Account Container to be used for storing backup files. Required.

  • backup_mode (str or 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. Known values are: “CreateBackup” and “ExistingBackup”.

  • aad_domain_name (str) – 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.

  • encrypted_key_for_secure_fields (str) – encrypted key for secure fields.

Keyword Arguments

  • source_connection_info (SqlConnectionInfo) – Information for connecting to source. Required.

  • target_connection_info (SqlConnectionInfo) – Information for connecting to target. Required.

  • selected_databases (list[MigrateSqlServerSqlMIDatabaseInput]) – Databases to migrate. Required.

  • started_on (str) – Date and time relative to UTC when the migration was started on.

  • selected_logins (list[str]) – Logins to migrate.

  • selected_agent_jobs (list[str]) – Agent Jobs to migrate.

  • backup_file_share (FileShare) – Backup file share information for all selected databases.

  • backup_blob_share (BlobShare) – SAS URI of Azure Storage Account Container to be used for storing backup files. Required.

  • backup_mode (str or 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. Known values are: “CreateBackup” and “ExistingBackup”.

  • aad_domain_name (str) – 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.

  • encrypted_key_for_secure_fields (str) – encrypted key for secure fields.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlMITaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MigrateSqlServerSqlMITaskOutputAgentJobLevel, MigrateSqlServerSqlMITaskOutputDatabaseLevel, MigrateSqlServerSqlMITaskOutputError, MigrateSqlServerSqlMITaskOutputLoginLevel, MigrateSqlServerSqlMITaskOutputMigrationLevel

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlMITaskOutputAgentJobLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlMITaskOutput

MigrateSqlServerSqlMITaskOutputAgentJobLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • name (str) – Agent Job name.

  • is_enabled (bool) – The state of the original Agent Job.

  • state (str or MigrationState) – Current state of migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • message (str) – Migration progress message.

  • exceptions_and_warnings (list[ReportableException]) – Migration errors and warnings per job.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlMITaskOutputDatabaseLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlMITaskOutput

MigrateSqlServerSqlMITaskOutputDatabaseLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • database_name (str) – Name of the database.

  • size_mb (float) – Size of the database in megabytes.

  • state (str or MigrationState) – Current state of migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • stage (str or DatabaseMigrationStage) – Current stage of migration. Known values are: “None”, “Initialize”, “Backup”, “FileCopy”, “Restore”, and “Completed”.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • message (str) – Migration progress message.

  • exceptions_and_warnings (list[ReportableException]) – Migration exceptions and warnings.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlMITaskOutputError(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlMITaskOutput

MigrateSqlServerSqlMITaskOutputError.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
class azure.mgmt.datamigration.models.MigrateSqlServerSqlMITaskOutputLoginLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlMITaskOutput

MigrateSqlServerSqlMITaskOutputLoginLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • login_name (str) – Login name.

  • state (str or MigrationState) – Current state of login. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • stage (str or LoginMigrationStage) – Current stage of login. Known values are: “None”, “Initialize”, “LoginMigration”, “EstablishUserMapping”, “AssignRoleMembership”, “AssignRoleOwnership”, “EstablishServerPermissions”, “EstablishObjectPermissions”, and “Completed”.

  • started_on (datetime) – Login migration start time.

  • ended_on (datetime) – Login migration end time.

  • message (str) – Login migration progress message.

  • exceptions_and_warnings (list[ReportableException]) – Login migration errors and warnings per login.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlMITaskOutputMigrationLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSqlServerSqlMITaskOutput

MigrateSqlServerSqlMITaskOutputMigrationLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • status (str or MigrationStatus) – Current status of migration. Known values are: “Default”, “Connecting”, “SourceAndTargetSelected”, “SelectLogins”, “Configured”, “Running”, “Error”, “Stopped”, “Completed”, and “CompletedWithWarnings”.

  • state (str or MigrationState) – Current state of migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • agent_jobs (str) – Selected agent jobs as a map from name to id.

  • logins (str) – Selected logins as a map from name to id.

  • message (str) – Migration progress message.

  • server_role_results (str) – Map of server role migration results.

  • orphaned_users_info (list[OrphanedUserInfo]) – List of orphaned users.

  • databases (str) – Selected databases as a map from database name to database id.

  • source_server_version (str) – Source server version.

  • source_server_brand_version (str) – Source server brand version.

  • target_server_version (str) – Target server version.

  • target_server_brand_version (str) – Target server brand version.

  • exceptions_and_warnings (list[ReportableException]) – Migration exceptions and warnings.

class azure.mgmt.datamigration.models.MigrateSqlServerSqlMITaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MigrateSqlServerSqlMITaskInput] = None, task_id: Optional[str] = None, created_on: Optional[str] = None, parent_task_id: Optional[str] = None, is_cloneable: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateSqlServerSqlMITaskInput) – Task input.

  • output (list[MigrateSqlServerSqlMITaskOutput]) – Task output. This is ignored if submitted.

  • task_id (str) – task id.

  • created_on (str) – DateTime in UTC when the task was created.

  • parent_task_id (str) – parent task id.

  • is_cloneable (bool) – whether the task can be cloned or not.

Keyword Arguments

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateSqlServerSqlMITaskInput) – Task input.

  • task_id (str) – task id.

  • created_on (str) – DateTime in UTC when the task was created.

  • parent_task_id (str) – parent task id.

  • is_cloneable (bool) – whether the task can be cloned or not.

class azure.mgmt.datamigration.models.MigrateSsisTaskInput(*, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.SqlConnectionInfo, ssis_migration_info: _models.SsisMigrationInfo, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.SqlMigrationTaskInput

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

All required parameters must be populated in order to send to Azure.

Variables

  • source_connection_info (SqlConnectionInfo) – Information for connecting to source. Required.

  • target_connection_info (SqlConnectionInfo) – Information for connecting to target. Required.

  • ssis_migration_info (SsisMigrationInfo) – SSIS package migration information. Required.

Keyword Arguments

  • source_connection_info (SqlConnectionInfo) – Information for connecting to source. Required.

  • target_connection_info (SqlConnectionInfo) – Information for connecting to target. Required.

  • ssis_migration_info (SsisMigrationInfo) – SSIS package migration information. Required.

class azure.mgmt.datamigration.models.MigrateSsisTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MigrateSsisTaskOutputMigrationLevel, MigrateSsisTaskOutputProjectLevel

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

class azure.mgmt.datamigration.models.MigrateSsisTaskOutputMigrationLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSsisTaskOutput

MigrateSsisTaskOutputMigrationLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • status (str or MigrationStatus) – Current status of migration. Known values are: “Default”, “Connecting”, “SourceAndTargetSelected”, “SelectLogins”, “Configured”, “Running”, “Error”, “Stopped”, “Completed”, and “CompletedWithWarnings”.

  • message (str) – Migration progress message.

  • source_server_version (str) – Source server version.

  • source_server_brand_version (str) – Source server brand version.

  • target_server_version (str) – Target server version.

  • target_server_brand_version (str) – Target server brand version.

  • exceptions_and_warnings (list[ReportableException]) – Migration exceptions and warnings.

  • stage (str or SsisMigrationStage) – Stage of SSIS migration. Known values are: “None”, “Initialize”, “InProgress”, and “Completed”.

class azure.mgmt.datamigration.models.MigrateSsisTaskOutputProjectLevel(**kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MigrateSsisTaskOutput

MigrateSsisTaskOutputProjectLevel.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Result identifier.

  • result_type (str) – Result type. Required.

  • folder_name (str) – Name of the folder.

  • project_name (str) – Name of the project.

  • state (str or MigrationState) – Current state of migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • stage (str or SsisMigrationStage) – Stage of SSIS migration. Known values are: “None”, “Initialize”, “InProgress”, and “Completed”.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • message (str) – Migration progress message.

  • exceptions_and_warnings (list[ReportableException]) – Migration exceptions and warnings.

class azure.mgmt.datamigration.models.MigrateSsisTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MigrateSsisTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateSsisTaskInput) – Task input.

  • output (list[MigrateSsisTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateSsisTaskInput) – Task input.

class azure.mgmt.datamigration.models.MigrateSyncCompleteCommandInput(*, database_name: str, commit_time_stamp: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Input for command that completes sync migration for a database.

All required parameters must be populated in order to send to Azure.

Variables

  • database_name (str) – Name of database. Required.

  • commit_time_stamp (datetime) – Time stamp to complete.

Keyword Arguments

  • database_name (str) – Name of database. Required.

  • commit_time_stamp (datetime) – Time stamp to complete.

class azure.mgmt.datamigration.models.MigrateSyncCompleteCommandOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Output for command that completes sync migration for a database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.datamigration.models.MigrateSyncCompleteCommandProperties(*, input: Optional[_models.MigrateSyncCompleteCommandInput] = None, command_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.CommandProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • command_type (str or CommandType) – Command type. Required. Known values are: “Migrate.Sync.Complete.Database”, “Migrate.SqlServer.AzureDbSqlMi.Complete”, “cancel”, “finish”, and “restart”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or CommandState) – The state of the command. This is ignored if submitted. Known values are: “Unknown”, “Accepted”, “Running”, “Succeeded”, and “Failed”.

  • input (MigrateSyncCompleteCommandInput) – Command input.

  • output (MigrateSyncCompleteCommandOutput) – Command output. This is ignored if submitted.

  • command_id (str) – Command id.

Keyword Arguments
class azure.mgmt.datamigration.models.MigrationEligibilityInfo(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Information about migration eligibility of a server object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • is_eligible_for_migration (bool) – Whether object is eligible for migration or not.

  • validation_messages (list[str]) – Information about eligibility failure for the server object.

class azure.mgmt.datamigration.models.MigrationOperationInput(*, migration_operation_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Migration Operation Input.

Variables

migration_operation_id (str) – ID tracking migration operation.

Keyword Arguments

migration_operation_id (str) – ID tracking migration operation.

class azure.mgmt.datamigration.models.MigrationReportResult(*, id: Optional[str] = None, report_url: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables

  • id (str) – Migration validation result identifier.

  • report_url (str) – The url of the report.

Keyword Arguments

  • id (str) – Migration validation result identifier.

  • report_url (str) – The url of the report.

class azure.mgmt.datamigration.models.MigrationState(value)[source]

Bases: str, enum.Enum

Current state of migration.

COMPLETED = 'Completed'
FAILED = 'Failed'
IN_PROGRESS = 'InProgress'
NONE = 'None'
SKIPPED = 'Skipped'
STOPPED = 'Stopped'
WARNING = 'Warning'
class azure.mgmt.datamigration.models.MigrationStatus(value)[source]

Bases: str, enum.Enum

Current status of migration.

COMPLETED = 'Completed'
COMPLETED_WITH_WARNINGS = 'CompletedWithWarnings'
CONFIGURED = 'Configured'
CONNECTING = 'Connecting'
DEFAULT = 'Default'
ERROR = 'Error'
RUNNING = 'Running'
SELECT_LOGINS = 'SelectLogins'
SOURCE_AND_TARGET_SELECTED = 'SourceAndTargetSelected'
STOPPED = 'Stopped'
class azure.mgmt.datamigration.models.MigrationStatusDetails(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Detailed status of current migration.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • migration_state (str) – Current State of Migration.

  • full_backup_set_info (SqlBackupSetInfo) – Details of full backup set.

  • last_restored_backup_set_info (SqlBackupSetInfo) – Last applied backup set information.

  • active_backup_sets (list[SqlBackupSetInfo]) – Backup sets that are currently active.

  • invalid_files (list[str]) – Files that are not valid backup files.

  • blob_container_name (str) – Name of blob container.

  • is_full_backup_restored (bool) – Whether full backup has been applied to the target database or not.

  • restore_blocking_reason (str) – Restore blocking reason, if any.

  • complete_restore_error_message (str) – Complete restore error message, if any.

  • file_upload_blocking_errors (list[str]) – File upload blocking errors, if any.

  • current_restoring_filename (str) – File name that is currently being restored.

  • last_restored_filename (str) – Last restored file name.

  • pending_log_backups_count (int) – Total pending log backups.

class azure.mgmt.datamigration.models.MigrationTableMetadata(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Metadata for tables selected in migration project.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • source_table_name (str) – Source table name.

  • target_table_name (str) – Target table name.

class azure.mgmt.datamigration.models.MigrationValidationDatabaseLevelResult(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Database level validation results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Result identifier.

  • migration_id (str) – Migration Identifier.

  • source_database_name (str) – Name of the source database.

  • target_database_name (str) – Name of the target database.

  • started_on (datetime) – Validation start time.

  • ended_on (datetime) – Validation end time.

  • data_integrity_validation_result (DataIntegrityValidationResult) – Provides data integrity validation result between the source and target tables that are migrated.

  • schema_validation_result (SchemaComparisonValidationResult) – Provides schema comparison result between source and target database.

  • query_analysis_validation_result (QueryAnalysisValidationResult) – Results of some of the query execution result between source and target database.

  • status (str or ValidationStatus) – Current status of validation at the database level. Known values are: “Default”, “NotStarted”, “Initialized”, “InProgress”, “Completed”, “CompletedWithIssues”, “Stopped”, and “Failed”.

class azure.mgmt.datamigration.models.MigrationValidationDatabaseSummaryResult(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Migration Validation Database level summary result.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Result identifier.

  • migration_id (str) – Migration Identifier.

  • source_database_name (str) – Name of the source database.

  • target_database_name (str) – Name of the target database.

  • started_on (datetime) – Validation start time.

  • ended_on (datetime) – Validation end time.

  • status (str or ValidationStatus) – Current status of validation at the database level. Known values are: “Default”, “NotStarted”, “Initialized”, “InProgress”, “Completed”, “CompletedWithIssues”, “Stopped”, and “Failed”.

class azure.mgmt.datamigration.models.MigrationValidationOptions(*, enable_schema_validation: Optional[bool] = None, enable_data_integrity_validation: Optional[bool] = None, enable_query_analysis_validation: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Types of validations to run after the migration.

Variables

  • enable_schema_validation (bool) – Allows to compare the schema information between source and target.

  • enable_data_integrity_validation (bool) – Allows to perform a checksum based data integrity validation between source and target for the selected database / tables .

  • enable_query_analysis_validation (bool) – 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.

Keyword Arguments

  • enable_schema_validation (bool) – Allows to compare the schema information between source and target.

  • enable_data_integrity_validation (bool) – Allows to perform a checksum based data integrity validation between source and target for the selected database / tables .

  • enable_query_analysis_validation (bool) – 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.

class azure.mgmt.datamigration.models.MigrationValidationResult(*, summary_results: Optional[Dict[str, _models.MigrationValidationDatabaseSummaryResult]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Migration Validation Result.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Migration validation result identifier.

  • migration_id (str) – Migration Identifier.

  • summary_results (dict[str, MigrationValidationDatabaseSummaryResult]) – Validation summary results for each database.

  • status (str or ValidationStatus) – Current status of validation at the migration level. Status from the database validation result status will be aggregated here. Known values are: “Default”, “NotStarted”, “Initialized”, “InProgress”, “Completed”, “CompletedWithIssues”, “Stopped”, and “Failed”.

Keyword Arguments

summary_results (dict[str, MigrationValidationDatabaseSummaryResult]) – Validation summary results for each database.

class azure.mgmt.datamigration.models.MongoDbCancelCommand(*, input: Optional[_models.MongoDbCommandInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.CommandProperties

Properties for the command that cancels a migration in whole or in part.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • command_type (str or CommandType) – Command type. Required. Known values are: “Migrate.Sync.Complete.Database”, “Migrate.SqlServer.AzureDbSqlMi.Complete”, “cancel”, “finish”, and “restart”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or CommandState) – The state of the command. This is ignored if submitted. Known values are: “Unknown”, “Accepted”, “Running”, “Succeeded”, and “Failed”.

  • input (MongoDbCommandInput) – Command input.

Keyword Arguments

input (MongoDbCommandInput) – Command input.

class azure.mgmt.datamigration.models.MongoDbClusterInfo(*, databases: List[_models.MongoDbDatabaseInfo], supports_sharding: bool, type: Union[str, _models.MongoDbClusterType], version: str, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes a MongoDB data source.

All required parameters must be populated in order to send to Azure.

Variables

  • databases (list[MongoDbDatabaseInfo]) – A list of non-system databases in the cluster. Required.

  • supports_sharding (bool) – Whether the cluster supports sharded collections. Required.

  • type (str or MongoDbClusterType) – The type of data source. Required. Known values are: “BlobContainer”, “CosmosDb”, and “MongoDb”.

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

Keyword Arguments

  • databases (list[MongoDbDatabaseInfo]) – A list of non-system databases in the cluster. Required.

  • supports_sharding (bool) – Whether the cluster supports sharded collections. Required.

  • type (str or MongoDbClusterType) – The type of data source. Required. Known values are: “BlobContainer”, “CosmosDb”, and “MongoDb”.

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

class azure.mgmt.datamigration.models.MongoDbClusterType(value)[source]

Bases: str, enum.Enum

The type of data source.

BLOB_CONTAINER = 'BlobContainer'
COSMOS_DB = 'CosmosDb'
MONGO_DB = 'MongoDb'
class azure.mgmt.datamigration.models.MongoDbCollectionInfo(*, average_document_size: int, data_size: int, document_count: int, name: str, qualified_name: str, database_name: str, is_capped: bool, is_system_collection: bool, is_view: bool, supports_sharding: bool, shard_key: Optional[_models.MongoDbShardKeyInfo] = None, view_of: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MongoDbObjectInfo

Describes a supported collection within a MongoDB database.

All required parameters must be populated in order to send to Azure.

Variables

  • average_document_size (int) – The average document size, or -1 if the average size is unknown. Required.

  • data_size (int) – The estimated total data size, in bytes, or -1 if the size is unknown. Required.

  • document_count (int) – The estimated total number of documents, or -1 if the document count is unknown. Required.

  • name (str) – The unqualified name of the database or collection. Required.

  • qualified_name (str) – The qualified name of the database or collection. For a collection, this is the database-qualified name. Required.

  • database_name (str) – The name of the database containing the collection. Required.

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

  • is_system_collection (bool) – Whether the collection is system collection. Required.

  • is_view (bool) – Whether the collection is a view of another collection. Required.

  • shard_key (MongoDbShardKeyInfo) – The shard key on the collection, or null if the collection is not sharded.

  • supports_sharding (bool) – Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. Required.

  • view_of (str) – The name of the collection that this is a view of, if IsView is true.

Keyword Arguments

  • average_document_size (int) – The average document size, or -1 if the average size is unknown. Required.

  • data_size (int) – The estimated total data size, in bytes, or -1 if the size is unknown. Required.

  • document_count (int) – The estimated total number of documents, or -1 if the document count is unknown. Required.

  • name (str) – The unqualified name of the database or collection. Required.

  • qualified_name (str) – The qualified name of the database or collection. For a collection, this is the database-qualified name. Required.

  • database_name (str) – The name of the database containing the collection. Required.

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

  • is_system_collection (bool) – Whether the collection is system collection. Required.

  • is_view (bool) – Whether the collection is a view of another collection. Required.

  • shard_key (MongoDbShardKeyInfo) – The shard key on the collection, or null if the collection is not sharded.

  • supports_sharding (bool) – Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. Required.

  • view_of (str) – The name of the collection that this is a view of, if IsView is true.

class azure.mgmt.datamigration.models.MongoDbCollectionProgress(*, bytes_copied: int, documents_copied: int, elapsed_time: str, errors: Dict[str, _models.MongoDbError], events_pending: int, events_replayed: int, state: Union[str, _models.MongoDbMigrationState], total_bytes: int, total_documents: int, last_event_time: Optional[datetime.datetime] = None, last_replay_time: Optional[datetime.datetime] = None, name: Optional[str] = None, qualified_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MongoDbProgress

Describes the progress of a collection.

All required parameters must be populated in order to send to Azure.

Variables

  • bytes_copied (int) – The number of document bytes copied during the Copying stage. Required.

  • documents_copied (int) – The number of documents copied during the Copying stage. Required.

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

  • errors (dict[str, MongoDbError]) – The errors and warnings that have occurred for the current object. The keys are the error codes. Required.

  • events_pending (int) – The number of oplog events awaiting replay. Required.

  • events_replayed (int) – The number of oplog events replayed so far. Required.

  • last_event_time (datetime) – The timestamp of the last oplog event received, or null if no oplog event has been received yet.

  • last_replay_time (datetime) – The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet.

  • name (str) – 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.

  • qualified_name (str) – 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.

  • result_type (str or MongoDbProgressResultType) – The type of progress object. Required. Known values are: “Migration”, “Database”, and “Collection”.

  • state (str or MongoDbMigrationState) – Required. Known values are: “NotStarted”, “ValidatingInput”, “Initializing”, “Restarting”, “Copying”, “InitialReplay”, “Replaying”, “Finalizing”, “Complete”, “Canceled”, and “Failed”.

  • total_bytes (int) – The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown. Required.

  • total_documents (int) – The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown. Required.

Keyword Arguments

  • bytes_copied (int) – The number of document bytes copied during the Copying stage. Required.

  • documents_copied (int) – The number of documents copied during the Copying stage. Required.

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

  • errors (dict[str, MongoDbError]) – The errors and warnings that have occurred for the current object. The keys are the error codes. Required.

  • events_pending (int) – The number of oplog events awaiting replay. Required.

  • events_replayed (int) – The number of oplog events replayed so far. Required.

  • last_event_time (datetime) – The timestamp of the last oplog event received, or null if no oplog event has been received yet.

  • last_replay_time (datetime) – The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet.

  • name (str) – 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.

  • qualified_name (str) – 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.

  • state (str or MongoDbMigrationState) – Required. Known values are: “NotStarted”, “ValidatingInput”, “Initializing”, “Restarting”, “Copying”, “InitialReplay”, “Replaying”, “Finalizing”, “Complete”, “Canceled”, and “Failed”.

  • total_bytes (int) – The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown. Required.

  • total_documents (int) – The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown. Required.

class azure.mgmt.datamigration.models.MongoDbCollectionSettings(*, can_delete: Optional[bool] = None, shard_key: Optional[_models.MongoDbShardKeySetting] = None, target_r_us: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes how an individual MongoDB collection should be migrated.

Variables

  • can_delete (bool) – Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true.

  • shard_key (MongoDbShardKeySetting) – Describes a MongoDB shard key.

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

Keyword Arguments

  • can_delete (bool) – Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true.

  • shard_key (MongoDbShardKeySetting) – Describes a MongoDB shard key.

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

class azure.mgmt.datamigration.models.MongoDbCommandInput(*, object_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes the input to the ‘cancel’ and ‘restart’ MongoDB migration commands.

Variables

object_name (str) – The qualified name of a database or collection to act upon, or null to act upon the entire migration.

Keyword Arguments

object_name (str) – The qualified name of a database or collection to act upon, or null to act upon the entire migration.

class azure.mgmt.datamigration.models.MongoDbConnectionInfo(*, connection_string: str, user_name: Optional[str] = None, password: Optional[str] = None, data_source: Optional[str] = None, encrypt_connection: Optional[bool] = None, server_brand_version: Optional[str] = None, server_version: Optional[str] = None, server_name: Optional[str] = None, trust_server_certificate: bool = False, enforce_ssl: Optional[bool] = None, port: Optional[int] = None, additional_settings: Optional[str] = None, authentication: Optional[Union[str, _models.AuthenticationType]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ConnectionInfo

Describes a connection to a MongoDB data source.

All required parameters must be populated in order to send to Azure.

Variables

  • type (str) – Type of connection info. Required.

  • user_name (str) – User name.

  • password (str) – Password credential.

  • connection_string (str) – A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties. Required.

  • data_source (str) – Data source.

  • encrypt_connection (bool) – Whether to encrypt the connection.

  • server_brand_version (str) – server brand version.

  • server_version (str) – server version.

  • server_name (str) – name of the server.

  • trust_server_certificate (bool) – Whether to trust the server certificate.

  • enforce_ssl (bool) –

  • port (int) – port for server.

  • additional_settings (str) – Additional connection settings.

  • authentication (str or AuthenticationType) – Authentication type to use for connection. Known values are: “None”, “WindowsAuthentication”, “SqlAuthentication”, “ActiveDirectoryIntegrated”, and “ActiveDirectoryPassword”.

Keyword Arguments

  • user_name (str) – User name.

  • password (str) – Password credential.

  • connection_string (str) – A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties. Required.

  • data_source (str) – Data source.

  • encrypt_connection (bool) – Whether to encrypt the connection.

  • server_brand_version (str) – server brand version.

  • server_version (str) – server version.

  • server_name (str) – name of the server.

  • trust_server_certificate (bool) – Whether to trust the server certificate.

  • enforce_ssl (bool) –

  • port (int) – port for server.

  • additional_settings (str) – Additional connection settings.

  • authentication (str or AuthenticationType) – Authentication type to use for connection. Known values are: “None”, “WindowsAuthentication”, “SqlAuthentication”, “ActiveDirectoryIntegrated”, and “ActiveDirectoryPassword”.

class azure.mgmt.datamigration.models.MongoDbDatabaseInfo(*, average_document_size: int, data_size: int, document_count: int, name: str, qualified_name: str, collections: List[_models.MongoDbCollectionInfo], supports_sharding: bool, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MongoDbObjectInfo

Describes a database within a MongoDB data source.

All required parameters must be populated in order to send to Azure.

Variables

  • average_document_size (int) – The average document size, or -1 if the average size is unknown. Required.

  • data_size (int) – The estimated total data size, in bytes, or -1 if the size is unknown. Required.

  • document_count (int) – The estimated total number of documents, or -1 if the document count is unknown. Required.

  • name (str) – The unqualified name of the database or collection. Required.

  • qualified_name (str) – The qualified name of the database or collection. For a collection, this is the database-qualified name. Required.

  • collections (list[MongoDbCollectionInfo]) – A list of supported collections in a MongoDB database. Required.

  • supports_sharding (bool) – Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. Required.

Keyword Arguments

  • average_document_size (int) – The average document size, or -1 if the average size is unknown. Required.

  • data_size (int) – The estimated total data size, in bytes, or -1 if the size is unknown. Required.

  • document_count (int) – The estimated total number of documents, or -1 if the document count is unknown. Required.

  • name (str) – The unqualified name of the database or collection. Required.

  • qualified_name (str) – The qualified name of the database or collection. For a collection, this is the database-qualified name. Required.

  • collections (list[MongoDbCollectionInfo]) – A list of supported collections in a MongoDB database. Required.

  • supports_sharding (bool) – Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. Required.

class azure.mgmt.datamigration.models.MongoDbDatabaseProgress(*, bytes_copied: int, documents_copied: int, elapsed_time: str, errors: Dict[str, _models.MongoDbError], events_pending: int, events_replayed: int, state: Union[str, _models.MongoDbMigrationState], total_bytes: int, total_documents: int, last_event_time: Optional[datetime.datetime] = None, last_replay_time: Optional[datetime.datetime] = None, name: Optional[str] = None, qualified_name: Optional[str] = None, collections: Optional[Dict[str, _models.MongoDbCollectionProgress]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MongoDbProgress

Describes the progress of a database.

All required parameters must be populated in order to send to Azure.

Variables

  • bytes_copied (int) – The number of document bytes copied during the Copying stage. Required.

  • documents_copied (int) – The number of documents copied during the Copying stage. Required.

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

  • errors (dict[str, MongoDbError]) – The errors and warnings that have occurred for the current object. The keys are the error codes. Required.

  • events_pending (int) – The number of oplog events awaiting replay. Required.

  • events_replayed (int) – The number of oplog events replayed so far. Required.

  • last_event_time (datetime) – The timestamp of the last oplog event received, or null if no oplog event has been received yet.

  • last_replay_time (datetime) – The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet.

  • name (str) – 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.

  • qualified_name (str) – 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.

  • result_type (str or MongoDbProgressResultType) – The type of progress object. Required. Known values are: “Migration”, “Database”, and “Collection”.

  • state (str or MongoDbMigrationState) – Required. Known values are: “NotStarted”, “ValidatingInput”, “Initializing”, “Restarting”, “Copying”, “InitialReplay”, “Replaying”, “Finalizing”, “Complete”, “Canceled”, and “Failed”.

  • total_bytes (int) – The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown. Required.

  • total_documents (int) – The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown. Required.

  • collections (dict[str, MongoDbCollectionProgress]) – The progress of the collections in the database. The keys are the unqualified names of the collections.

Keyword Arguments

  • bytes_copied (int) – The number of document bytes copied during the Copying stage. Required.

  • documents_copied (int) – The number of documents copied during the Copying stage. Required.

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

  • errors (dict[str, MongoDbError]) – The errors and warnings that have occurred for the current object. The keys are the error codes. Required.

  • events_pending (int) – The number of oplog events awaiting replay. Required.

  • events_replayed (int) – The number of oplog events replayed so far. Required.

  • last_event_time (datetime) – The timestamp of the last oplog event received, or null if no oplog event has been received yet.

  • last_replay_time (datetime) – The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet.

  • name (str) – 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.

  • qualified_name (str) – 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.

  • state (str or MongoDbMigrationState) – Required. Known values are: “NotStarted”, “ValidatingInput”, “Initializing”, “Restarting”, “Copying”, “InitialReplay”, “Replaying”, “Finalizing”, “Complete”, “Canceled”, and “Failed”.

  • total_bytes (int) – The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown. Required.

  • total_documents (int) – The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown. Required.

  • collections (dict[str, MongoDbCollectionProgress]) – The progress of the collections in the database. The keys are the unqualified names of the collections.

class azure.mgmt.datamigration.models.MongoDbDatabaseSettings(*, collections: Dict[str, _models.MongoDbCollectionSettings], target_r_us: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes how an individual MongoDB database should be migrated.

All required parameters must be populated in order to send to Azure.

Variables

  • collections (dict[str, MongoDbCollectionSettings]) – The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. Required.

  • target_r_us (int) – 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.

Keyword Arguments

  • collections (dict[str, MongoDbCollectionSettings]) – The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. Required.

  • target_r_us (int) – 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.

class azure.mgmt.datamigration.models.MongoDbError(*, code: Optional[str] = None, count: Optional[int] = None, message: Optional[str] = None, type: Optional[Union[str, _models.MongoDbErrorType]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes an error or warning that occurred during a MongoDB migration.

Variables

  • code (str) – The non-localized, machine-readable code that describes the error or warning.

  • count (int) – The number of times the error or warning has occurred.

  • message (str) – The localized, human-readable message that describes the error or warning.

  • type (str or MongoDbErrorType) – The type of error or warning. Known values are: “Error”, “ValidationError”, and “Warning”.

Keyword Arguments

  • code (str) – The non-localized, machine-readable code that describes the error or warning.

  • count (int) – The number of times the error or warning has occurred.

  • message (str) – The localized, human-readable message that describes the error or warning.

  • type (str or MongoDbErrorType) – The type of error or warning. Known values are: “Error”, “ValidationError”, and “Warning”.

class azure.mgmt.datamigration.models.MongoDbErrorType(value)[source]

Bases: str, enum.Enum

The type of error or warning.

ERROR = 'Error'
VALIDATION_ERROR = 'ValidationError'
WARNING = 'Warning'
class azure.mgmt.datamigration.models.MongoDbFinishCommand(*, input: Optional[_models.MongoDbFinishCommandInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.CommandProperties

Properties for the command that finishes a migration in whole or in part.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • command_type (str or CommandType) – Command type. Required. Known values are: “Migrate.Sync.Complete.Database”, “Migrate.SqlServer.AzureDbSqlMi.Complete”, “cancel”, “finish”, and “restart”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or CommandState) – The state of the command. This is ignored if submitted. Known values are: “Unknown”, “Accepted”, “Running”, “Succeeded”, and “Failed”.

  • input (MongoDbFinishCommandInput) – Command input.

Keyword Arguments

input (MongoDbFinishCommandInput) – Command input.

class azure.mgmt.datamigration.models.MongoDbFinishCommandInput(*, immediate: bool, object_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MongoDbCommandInput

Describes the input to the ‘finish’ MongoDB migration command.

All required parameters must be populated in order to send to Azure.

Variables

  • object_name (str) – The qualified name of a database or collection to act upon, or null to act upon the entire migration.

  • immediate (bool) – If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication. Required.

Keyword Arguments

  • object_name (str) – The qualified name of a database or collection to act upon, or null to act upon the entire migration.

  • immediate (bool) – If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication. Required.

class azure.mgmt.datamigration.models.MongoDbMigrationProgress(*, bytes_copied: int, documents_copied: int, elapsed_time: str, errors: Dict[str, _models.MongoDbError], events_pending: int, events_replayed: int, state: Union[str, _models.MongoDbMigrationState], total_bytes: int, total_documents: int, last_event_time: Optional[datetime.datetime] = None, last_replay_time: Optional[datetime.datetime] = None, name: Optional[str] = None, qualified_name: Optional[str] = None, databases: Optional[Dict[str, _models.MongoDbDatabaseProgress]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.MongoDbProgress

Describes the progress of the overall migration.

All required parameters must be populated in order to send to Azure.

Variables

  • bytes_copied (int) – The number of document bytes copied during the Copying stage. Required.

  • documents_copied (int) – The number of documents copied during the Copying stage. Required.

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

  • errors (dict[str, MongoDbError]) – The errors and warnings that have occurred for the current object. The keys are the error codes. Required.

  • events_pending (int) – The number of oplog events awaiting replay. Required.

  • events_replayed (int) – The number of oplog events replayed so far. Required.

  • last_event_time (datetime) – The timestamp of the last oplog event received, or null if no oplog event has been received yet.

  • last_replay_time (datetime) – The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet.

  • name (str) – 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.

  • qualified_name (str) – 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.

  • result_type (str or MongoDbProgressResultType) – The type of progress object. Required. Known values are: “Migration”, “Database”, and “Collection”.

  • state (str or MongoDbMigrationState) – Required. Known values are: “NotStarted”, “ValidatingInput”, “Initializing”, “Restarting”, “Copying”, “InitialReplay”, “Replaying”, “Finalizing”, “Complete”, “Canceled”, and “Failed”.

  • total_bytes (int) – The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown. Required.

  • total_documents (int) – The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown. Required.

  • databases (dict[str, MongoDbDatabaseProgress]) – The progress of the databases in the migration. The keys are the names of the databases.

Keyword Arguments

  • bytes_copied (int) – The number of document bytes copied during the Copying stage. Required.

  • documents_copied (int) – The number of documents copied during the Copying stage. Required.

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

  • errors (dict[str, MongoDbError]) – The errors and warnings that have occurred for the current object. The keys are the error codes. Required.

  • events_pending (int) – The number of oplog events awaiting replay. Required.

  • events_replayed (int) – The number of oplog events replayed so far. Required.

  • last_event_time (datetime) – The timestamp of the last oplog event received, or null if no oplog event has been received yet.

  • last_replay_time (datetime) – The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet.

  • name (str) – 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.

  • qualified_name (str) – 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.

  • state (str or MongoDbMigrationState) – Required. Known values are: “NotStarted”, “ValidatingInput”, “Initializing”, “Restarting”, “Copying”, “InitialReplay”, “Replaying”, “Finalizing”, “Complete”, “Canceled”, and “Failed”.

  • total_bytes (int) – The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown. Required.

  • total_documents (int) – The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown. Required.

  • databases (dict[str, MongoDbDatabaseProgress]) – The progress of the databases in the migration. The keys are the names of the databases.

class azure.mgmt.datamigration.models.MongoDbMigrationSettings(*, databases: Dict[str, _models.MongoDbDatabaseSettings], source: _models.MongoDbConnectionInfo, target: _models.MongoDbConnectionInfo, boost_r_us: Optional[int] = None, replication: Optional[Union[str, _models.MongoDbReplication]] = None, throttling: Optional[_models.MongoDbThrottlingSettings] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes how a MongoDB data migration should be performed.

All required parameters must be populated in order to send to Azure.

Variables

  • boost_r_us (int) – 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 (dict[str, MongoDbDatabaseSettings]) – The databases on the source cluster to migrate to the target. The keys are the names of the databases. Required.

  • replication (str or MongoDbReplication) – Describes how changes will be replicated from the source to the target. The default is OneTime. Known values are: “Disabled”, “OneTime”, and “Continuous”.

  • source (MongoDbConnectionInfo) – Settings used to connect to the source cluster. Required.

  • target (MongoDbConnectionInfo) – Settings used to connect to the target cluster. Required.

  • throttling (MongoDbThrottlingSettings) – Settings used to limit the resource usage of the migration.

Keyword Arguments

  • boost_r_us (int) – 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 (dict[str, MongoDbDatabaseSettings]) – The databases on the source cluster to migrate to the target. The keys are the names of the databases. Required.

  • replication (str or MongoDbReplication) – Describes how changes will be replicated from the source to the target. The default is OneTime. Known values are: “Disabled”, “OneTime”, and “Continuous”.

  • source (MongoDbConnectionInfo) – Settings used to connect to the source cluster. Required.

  • target (MongoDbConnectionInfo) – Settings used to connect to the target cluster. Required.

  • throttling (MongoDbThrottlingSettings) – Settings used to limit the resource usage of the migration.

class azure.mgmt.datamigration.models.MongoDbMigrationState(value)[source]

Bases: str, enum.Enum

MongoDbMigrationState.

CANCELED = 'Canceled'
COMPLETE = 'Complete'
COPYING = 'Copying'
FAILED = 'Failed'
FINALIZING = 'Finalizing'
INITIALIZING = 'Initializing'
INITIAL_REPLAY = 'InitialReplay'
NOT_STARTED = 'NotStarted'
REPLAYING = 'Replaying'
RESTARTING = 'Restarting'
VALIDATING_INPUT = 'ValidatingInput'
class azure.mgmt.datamigration.models.MongoDbObjectInfo(*, average_document_size: int, data_size: int, document_count: int, name: str, qualified_name: str, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes a database or collection within a MongoDB data source.

All required parameters must be populated in order to send to Azure.

Variables

  • average_document_size (int) – The average document size, or -1 if the average size is unknown. Required.

  • data_size (int) – The estimated total data size, in bytes, or -1 if the size is unknown. Required.

  • document_count (int) – The estimated total number of documents, or -1 if the document count is unknown. Required.

  • name (str) – The unqualified name of the database or collection. Required.

  • qualified_name (str) – The qualified name of the database or collection. For a collection, this is the database-qualified name. Required.

Keyword Arguments

  • average_document_size (int) – The average document size, or -1 if the average size is unknown. Required.

  • data_size (int) – The estimated total data size, in bytes, or -1 if the size is unknown. Required.

  • document_count (int) – The estimated total number of documents, or -1 if the document count is unknown. Required.

  • name (str) – The unqualified name of the database or collection. Required.

  • qualified_name (str) – The qualified name of the database or collection. For a collection, this is the database-qualified name. Required.

class azure.mgmt.datamigration.models.MongoDbProgress(*, bytes_copied: int, documents_copied: int, elapsed_time: str, errors: Dict[str, _models.MongoDbError], events_pending: int, events_replayed: int, state: Union[str, _models.MongoDbMigrationState], total_bytes: int, total_documents: int, last_event_time: Optional[datetime.datetime] = None, last_replay_time: Optional[datetime.datetime] = None, name: Optional[str] = None, qualified_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Base class for MongoDB migration outputs.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MongoDbCollectionProgress, MongoDbDatabaseProgress, MongoDbMigrationProgress

All required parameters must be populated in order to send to Azure.

Variables

  • bytes_copied (int) – The number of document bytes copied during the Copying stage. Required.

  • documents_copied (int) – The number of documents copied during the Copying stage. Required.

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

  • errors (dict[str, MongoDbError]) – The errors and warnings that have occurred for the current object. The keys are the error codes. Required.

  • events_pending (int) – The number of oplog events awaiting replay. Required.

  • events_replayed (int) – The number of oplog events replayed so far. Required.

  • last_event_time (datetime) – The timestamp of the last oplog event received, or null if no oplog event has been received yet.

  • last_replay_time (datetime) – The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet.

  • name (str) – 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.

  • qualified_name (str) – 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.

  • result_type (str or MongoDbProgressResultType) – The type of progress object. Required. Known values are: “Migration”, “Database”, and “Collection”.

  • state (str or MongoDbMigrationState) – Required. Known values are: “NotStarted”, “ValidatingInput”, “Initializing”, “Restarting”, “Copying”, “InitialReplay”, “Replaying”, “Finalizing”, “Complete”, “Canceled”, and “Failed”.

  • total_bytes (int) – The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown. Required.

  • total_documents (int) – The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown. Required.

Keyword Arguments

  • bytes_copied (int) – The number of document bytes copied during the Copying stage. Required.

  • documents_copied (int) – The number of documents copied during the Copying stage. Required.

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

  • errors (dict[str, MongoDbError]) – The errors and warnings that have occurred for the current object. The keys are the error codes. Required.

  • events_pending (int) – The number of oplog events awaiting replay. Required.

  • events_replayed (int) – The number of oplog events replayed so far. Required.

  • last_event_time (datetime) – The timestamp of the last oplog event received, or null if no oplog event has been received yet.

  • last_replay_time (datetime) – The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet.

  • name (str) – 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.

  • qualified_name (str) – 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.

  • state (str or MongoDbMigrationState) – Required. Known values are: “NotStarted”, “ValidatingInput”, “Initializing”, “Restarting”, “Copying”, “InitialReplay”, “Replaying”, “Finalizing”, “Complete”, “Canceled”, and “Failed”.

  • total_bytes (int) – The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown. Required.

  • total_documents (int) – The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown. Required.

class azure.mgmt.datamigration.models.MongoDbProgressResultType(value)[source]

Bases: str, enum.Enum

The type of progress object.

COLLECTION = 'Collection'
DATABASE = 'Database'
MIGRATION = 'Migration'
class azure.mgmt.datamigration.models.MongoDbReplication(value)[source]

Bases: str, enum.Enum

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

CONTINUOUS = 'Continuous'
DISABLED = 'Disabled'
ONE_TIME = 'OneTime'
class azure.mgmt.datamigration.models.MongoDbRestartCommand(*, input: Optional[_models.MongoDbCommandInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.CommandProperties

Properties for the command that restarts a migration in whole or in part.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • command_type (str or CommandType) – Command type. Required. Known values are: “Migrate.Sync.Complete.Database”, “Migrate.SqlServer.AzureDbSqlMi.Complete”, “cancel”, “finish”, and “restart”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or CommandState) – The state of the command. This is ignored if submitted. Known values are: “Unknown”, “Accepted”, “Running”, “Succeeded”, and “Failed”.

  • input (MongoDbCommandInput) – Command input.

Keyword Arguments

input (MongoDbCommandInput) – Command input.

class azure.mgmt.datamigration.models.MongoDbShardKeyField(*, name: str, order: Union[str, _models.MongoDbShardKeyOrder], **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes a field reference within a MongoDB shard key.

All required parameters must be populated in order to send to Azure.

Variables

  • name (str) – The name of the field. Required.

  • order (str or MongoDbShardKeyOrder) – The field ordering. Required. Known values are: “Forward”, “Reverse”, and “Hashed”.

Keyword Arguments

  • name (str) – The name of the field. Required.

  • order (str or MongoDbShardKeyOrder) – The field ordering. Required. Known values are: “Forward”, “Reverse”, and “Hashed”.

class azure.mgmt.datamigration.models.MongoDbShardKeyInfo(*, fields: List[_models.MongoDbShardKeyField], is_unique: bool, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes a MongoDB shard key.

All required parameters must be populated in order to send to Azure.

Variables

  • fields (list[MongoDbShardKeyField]) – The fields within the shard key. Required.

  • is_unique (bool) – Whether the shard key is unique. Required.

Keyword Arguments

  • fields (list[MongoDbShardKeyField]) – The fields within the shard key. Required.

  • is_unique (bool) – Whether the shard key is unique. Required.

class azure.mgmt.datamigration.models.MongoDbShardKeyOrder(value)[source]

Bases: str, enum.Enum

The field ordering.

FORWARD = 'Forward'
HASHED = 'Hashed'
REVERSE = 'Reverse'
class azure.mgmt.datamigration.models.MongoDbShardKeySetting(*, fields: List[_models.MongoDbShardKeyField], is_unique: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes a MongoDB shard key.

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.MongoDbThrottlingSettings(*, min_free_cpu: Optional[int] = None, min_free_memory_mb: Optional[int] = None, max_parallelism: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Specifies resource limits for the migration.

Variables

  • min_free_cpu (int) – The percentage of CPU time that the migrator will try to avoid using, from 0 to 100.

  • min_free_memory_mb (int) – The number of megabytes of RAM that the migrator will try to avoid using.

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

Keyword Arguments

  • min_free_cpu (int) – The percentage of CPU time that the migrator will try to avoid using, from 0 to 100.

  • min_free_memory_mb (int) – The number of megabytes of RAM that the migrator will try to avoid using.

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

class azure.mgmt.datamigration.models.MySqlConnectionInfo(*, server_name: str, port: int, user_name: Optional[str] = None, password: Optional[str] = None, data_source: Optional[str] = None, encrypt_connection: bool = True, authentication: Optional[Union[str, _models.AuthenticationType]] = None, additional_settings: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ConnectionInfo

Information for connecting to MySQL server.

All required parameters must be populated in order to send to Azure.

Variables

  • type (str) – Type of connection info. Required.

  • user_name (str) – User name.

  • password (str) – Password credential.

  • server_name (str) – Name of the server. Required.

  • data_source (str) – Data source.

  • port (int) – Port for Server. Required.

  • encrypt_connection (bool) – Whether to encrypt the connection.

  • authentication (str or AuthenticationType) – Authentication type to use for connection. Known values are: “None”, “WindowsAuthentication”, “SqlAuthentication”, “ActiveDirectoryIntegrated”, and “ActiveDirectoryPassword”.

  • additional_settings (str) – Additional connection settings.

Keyword Arguments

  • user_name (str) – User name.

  • password (str) – Password credential.

  • server_name (str) – Name of the server. Required.

  • data_source (str) – Data source.

  • port (int) – Port for Server. Required.

  • encrypt_connection (bool) – Whether to encrypt the connection.

  • authentication (str or AuthenticationType) – Authentication type to use for connection. Known values are: “None”, “WindowsAuthentication”, “SqlAuthentication”, “ActiveDirectoryIntegrated”, and “ActiveDirectoryPassword”.

  • additional_settings (str) – Additional connection settings.

class azure.mgmt.datamigration.models.MySqlTargetPlatformType(value)[source]

Bases: str, enum.Enum

An enumeration of possible target types when migrating from MySQL.

AZURE_DB_FOR_MY_SQL = 'AzureDbForMySQL'
SQL_SERVER = 'SqlServer'
class azure.mgmt.datamigration.models.NameAvailabilityRequest(*, name: Optional[str] = None, type: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

A resource type and proposed name.

Variables

  • name (str) – The proposed resource name.

  • type (str) – The resource type chain (e.g. virtualMachines/extensions).

Keyword Arguments

  • name (str) – The proposed resource name.

  • type (str) – The resource type chain (e.g. virtualMachines/extensions).

class azure.mgmt.datamigration.models.NameAvailabilityResponse(*, name_available: Optional[bool] = None, reason: Optional[Union[str, _models.NameCheckFailureReason]] = None, message: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Indicates whether a proposed resource name is available.

Variables

  • name_available (bool) – If true, the name is valid and available. If false, ‘reason’ describes why not.

  • reason (str or NameCheckFailureReason) – The reason why the name is not available, if nameAvailable is false. Known values are: “AlreadyExists” and “Invalid”.

  • message (str) – The localized reason why the name is not available, if nameAvailable is false.

Keyword Arguments

  • name_available (bool) – If true, the name is valid and available. If false, ‘reason’ describes why not.

  • reason (str or NameCheckFailureReason) – The reason why the name is not available, if nameAvailable is false. Known values are: “AlreadyExists” and “Invalid”.

  • message (str) – The localized reason why the name is not available, if nameAvailable is false.

class azure.mgmt.datamigration.models.NameCheckFailureReason(value)[source]

Bases: str, enum.Enum

The reason why the name is not available, if nameAvailable is false.

ALREADY_EXISTS = 'AlreadyExists'
INVALID = 'Invalid'
class azure.mgmt.datamigration.models.NodeMonitoringData(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

NodeMonitoringData.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • additional_properties (dict[str, JSON]) – Unmatched properties from the message are deserialized in this collection.

  • node_name (str) – Name of the integration runtime node.

  • available_memory_in_mb (int) – Available memory (MB) on the integration runtime node.

  • cpu_utilization (int) – CPU percentage on the integration runtime node.

  • concurrent_jobs_limit (int) – Maximum concurrent jobs on the integration runtime node.

  • concurrent_jobs_running (int) – The number of jobs currently running on the integration runtime node.

  • max_concurrent_jobs (int) – The maximum concurrent jobs in this integration runtime.

  • sent_bytes (float) – Sent bytes on the integration runtime node.

  • received_bytes (float) – Received bytes on the integration runtime node.

class azure.mgmt.datamigration.models.NonSqlDataMigrationTable(*, source_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Defines metadata for table to be migrated.

Variables

source_name (str) – Source table name.

Keyword Arguments

source_name (str) – Source table name.

class azure.mgmt.datamigration.models.NonSqlDataMigrationTableResult(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Object used to report the data migration results of a table.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • result_code (str or DataMigrationResultCode) – Result code of the data migration. Known values are: “Initial”, “Completed”, “ObjectNotExistsInSource”, “ObjectNotExistsInTarget”, “TargetObjectIsInaccessible”, and “FatalError”.

  • source_name (str) – Name of the source table.

  • target_name (str) – Name of the target table.

  • source_row_count (int) – Number of rows in the source table.

  • target_row_count (int) – Number of rows in the target table.

  • elapsed_time_in_miliseconds (float) – Time taken to migrate the data.

  • errors (list[DataMigrationError]) – List of errors, if any, during migration.

class azure.mgmt.datamigration.models.NonSqlMigrationTaskInput(*, target_connection_info: _models.SqlConnectionInfo, target_database_name: str, project_name: str, project_location: str, selected_tables: List[_models.NonSqlDataMigrationTable], **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Base class for non sql migration task input.

All required parameters must be populated in order to send to Azure.

Variables

  • target_connection_info (SqlConnectionInfo) – Information for connecting to target. Required.

  • target_database_name (str) – Target database name. Required.

  • project_name (str) – Name of the migration project. Required.

  • project_location (str) – A URL that points to the drop location to access project artifacts. Required.

  • selected_tables (list[NonSqlDataMigrationTable]) – Metadata of the tables selected for migration. Required.

Keyword Arguments

  • target_connection_info (SqlConnectionInfo) – Information for connecting to target. Required.

  • target_database_name (str) – Target database name. Required.

  • project_name (str) – Name of the migration project. Required.

  • project_location (str) – A URL that points to the drop location to access project artifacts. Required.

  • selected_tables (list[NonSqlDataMigrationTable]) – Metadata of the tables selected for migration. Required.

class azure.mgmt.datamigration.models.NonSqlMigrationTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Base class for non sql migration task output.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Result identifier.

  • started_on (datetime) – Migration start time.

  • ended_on (datetime) – Migration end time.

  • status (str or MigrationStatus) – Current state of migration. Known values are: “Default”, “Connecting”, “SourceAndTargetSelected”, “SelectLogins”, “Configured”, “Running”, “Error”, “Stopped”, “Completed”, and “CompletedWithWarnings”.

  • data_migration_table_results (str) – Results of the migration. The key contains the table name and the value the table result object.

  • progress_message (str) – Message about the progress of the migration.

  • source_server_name (str) – Name of source server.

  • target_server_name (str) – Name of target server.

class azure.mgmt.datamigration.models.ODataError(*, code: Optional[str] = None, message: Optional[str] = None, details: Optional[List[_models.ODataError]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Error information in OData format.

Variables

  • code (str) – The machine-readable description of the error, such as ‘InvalidRequest’ or ‘InternalServerError’.

  • message (str) – The human-readable description of the error.

  • details (list[ODataError]) – Inner errors that caused this error.

Keyword Arguments

  • code (str) – The machine-readable description of the error, such as ‘InvalidRequest’ or ‘InternalServerError’.

  • message (str) – The human-readable description of the error.

  • details (list[ODataError]) – Inner errors that caused this error.

class azure.mgmt.datamigration.models.ObjectType(value)[source]

Bases: str, enum.Enum

An enumeration of type of objects.

FUNCTION = 'Function'
STORED_PROCEDURES = 'StoredProcedures'
TABLE = 'Table'
USER = 'User'
VIEW = 'View'
class azure.mgmt.datamigration.models.OfflineConfiguration(*, offline: Optional[bool] = None, last_backup_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Offline configuration.

Variables

  • offline (bool) – Offline migration.

  • last_backup_name (str) – Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share.

Keyword Arguments

  • offline (bool) – Offline migration.

  • last_backup_name (str) – Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share.

class azure.mgmt.datamigration.models.OperationListResult(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Result of the request to list SQL operations.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.datamigration.models.OperationOrigin(value)[source]

Bases: str, enum.Enum

OperationOrigin.

SYSTEM = 'system'
USER = 'user'
class azure.mgmt.datamigration.models.OperationsDefinition(*, is_data_action: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

OperationsDefinition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
Keyword Arguments

is_data_action (bool) – Indicates whether the operation is a data action.

class azure.mgmt.datamigration.models.OperationsDisplayDefinition(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

OperationsDisplayDefinition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.datamigration.models.OracleConnectionInfo(*, data_source: str, user_name: Optional[str] = None, password: Optional[str] = None, server_name: Optional[str] = None, server_version: Optional[str] = None, port: Optional[int] = None, authentication: Optional[Union[str, _models.AuthenticationType]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ConnectionInfo

Information for connecting to Oracle server.

All required parameters must be populated in order to send to Azure.

Variables

  • type (str) – Type of connection info. Required.

  • user_name (str) – User name.

  • password (str) – Password credential.

  • data_source (str) – EZConnect or TNSName connection string. Required.

  • server_name (str) – name of the server.

  • server_version (str) – server version.

  • port (int) – port for server.

  • authentication (str or AuthenticationType) – Authentication type to use for connection. Known values are: “None”, “WindowsAuthentication”, “SqlAuthentication”, “ActiveDirectoryIntegrated”, and “ActiveDirectoryPassword”.

Keyword Arguments

  • user_name (str) – User name.

  • password (str) – Password credential.

  • data_source (str) – EZConnect or TNSName connection string. Required.

  • server_name (str) – name of the server.

  • server_version (str) – server version.

  • port (int) – port for server.

  • authentication (str or AuthenticationType) – Authentication type to use for connection. Known values are: “None”, “WindowsAuthentication”, “SqlAuthentication”, “ActiveDirectoryIntegrated”, and “ActiveDirectoryPassword”.

class azure.mgmt.datamigration.models.OracleOCIDriverInfo(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Information about an Oracle OCI driver.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • driver_name (str) – The name of the driver package.

  • driver_size (str) – The size in bytes of the driver package.

  • archive_checksum (str) – The MD5 Base64 encoded checksum for the driver package.

  • oracle_checksum (str) – The checksum for the driver package provided by Oracle.

  • assembly_version (str) – Version listed in the OCI assembly ‘oci.dll’.

  • supported_oracle_versions (list[str]) – List of Oracle database versions supported by this driver. Only major minor of the version is listed.

class azure.mgmt.datamigration.models.OrphanedUserInfo(*, name: Optional[str] = None, database_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Information of orphaned users on the SQL server database.

Variables

  • name (str) – Name of the orphaned user.

  • database_name (str) – Parent database of the user.

Keyword Arguments

  • name (str) – Name of the orphaned user.

  • database_name (str) – Parent database of the user.

class azure.mgmt.datamigration.models.PostgreSqlConnectionInfo(*, server_name: str, port: int, user_name: Optional[str] = None, password: Optional[str] = None, data_source: Optional[str] = None, server_version: Optional[str] = None, database_name: Optional[str] = None, encrypt_connection: bool = True, trust_server_certificate: bool = False, additional_settings: Optional[str] = None, server_brand_version: Optional[str] = None, authentication: Optional[Union[str, _models.AuthenticationType]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ConnectionInfo

Information for connecting to PostgreSQL server.

All required parameters must be populated in order to send to Azure.

Variables

  • type (str) – Type of connection info. Required.

  • user_name (str) – User name.

  • password (str) – Password credential.

  • server_name (str) – Name of the server. Required.

  • data_source (str) – Data source.

  • server_version (str) – server version.

  • database_name (str) – Name of the database.

  • port (int) – Port for Server. Required.

  • encrypt_connection (bool) – Whether to encrypt the connection.

  • trust_server_certificate (bool) – Whether to trust the server certificate.

  • additional_settings (str) – Additional connection settings.

  • server_brand_version (str) – server brand version.

  • authentication (str or AuthenticationType) – Authentication type to use for connection. Known values are: “None”, “WindowsAuthentication”, “SqlAuthentication”, “ActiveDirectoryIntegrated”, and “ActiveDirectoryPassword”.

Keyword Arguments

  • user_name (str) – User name.

  • password (str) – Password credential.

  • server_name (str) – Name of the server. Required.

  • data_source (str) – Data source.

  • server_version (str) – server version.

  • database_name (str) – Name of the database.

  • port (int) – Port for Server. Required.

  • encrypt_connection (bool) – Whether to encrypt the connection.

  • trust_server_certificate (bool) – Whether to trust the server certificate.

  • additional_settings (str) – Additional connection settings.

  • server_brand_version (str) – server brand version.

  • authentication (str or AuthenticationType) – Authentication type to use for connection. Known values are: “None”, “WindowsAuthentication”, “SqlAuthentication”, “ActiveDirectoryIntegrated”, and “ActiveDirectoryPassword”.

class azure.mgmt.datamigration.models.Project(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, source_platform: Optional[Union[str, _models.ProjectSourcePlatform]] = None, azure_authentication_info: Optional[_models.AzureActiveDirectoryApp] = None, target_platform: Optional[Union[str, _models.ProjectTargetPlatform]] = None, source_connection_info: Optional[_models.ConnectionInfo] = None, target_connection_info: Optional[_models.ConnectionInfo] = None, databases_info: Optional[List[_models.DatabaseInfo]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.TrackedResource

A project resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • location (str) –

  • tags (dict[str, str]) – Dictionary of <string>.

  • id (str) –

  • name (str) –

  • type (str) –

  • system_data (SystemData) –

  • etag (str) – HTTP strong entity tag value. This is ignored if submitted.

  • source_platform (str or ProjectSourcePlatform) – Source platform for the project. Known values are: “SQL”, “MySQL”, “PostgreSql”, “MongoDb”, and “Unknown”.

  • azure_authentication_info (AzureActiveDirectoryApp) – Field that defines the Azure active directory application info, used to connect to the target Azure resource.

  • target_platform (str or ProjectTargetPlatform) – Target platform for the project. Known values are: “SQLDB”, “SQLMI”, “AzureDbForMySql”, “AzureDbForPostgreSql”, “MongoDb”, and “Unknown”.

  • creation_time (datetime) – UTC Date and time when project was created.

  • source_connection_info (ConnectionInfo) – Information for connecting to source.

  • target_connection_info (ConnectionInfo) – Information for connecting to target.

  • databases_info (list[DatabaseInfo]) – List of DatabaseInfo.

  • provisioning_state (str or ProjectProvisioningState) – The project’s provisioning state. Known values are: “Deleting” and “Succeeded”.

Keyword Arguments

  • location (str) –

  • tags (dict[str, str]) – Dictionary of <string>.

  • etag (str) – HTTP strong entity tag value. This is ignored if submitted.

  • source_platform (str or ProjectSourcePlatform) – Source platform for the project. Known values are: “SQL”, “MySQL”, “PostgreSql”, “MongoDb”, and “Unknown”.

  • azure_authentication_info (AzureActiveDirectoryApp) – Field that defines the Azure active directory application info, used to connect to the target Azure resource.

  • target_platform (str or ProjectTargetPlatform) – Target platform for the project. Known values are: “SQLDB”, “SQLMI”, “AzureDbForMySql”, “AzureDbForPostgreSql”, “MongoDb”, and “Unknown”.

  • source_connection_info (ConnectionInfo) – Information for connecting to source.

  • target_connection_info (ConnectionInfo) – Information for connecting to target.

  • databases_info (list[DatabaseInfo]) – List of DatabaseInfo.

class azure.mgmt.datamigration.models.ProjectFile(*, etag: Optional[str] = None, properties: Optional[_models.ProjectFileProperties] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.Resource

A file resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

  • etag (str) – HTTP strong entity tag value. This is ignored if submitted.

  • properties (ProjectFileProperties) – Custom file properties.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments

  • etag (str) – HTTP strong entity tag value. This is ignored if submitted.

  • properties (ProjectFileProperties) – Custom file properties.

class azure.mgmt.datamigration.models.ProjectFileProperties(*, extension: Optional[str] = None, file_path: Optional[str] = None, media_type: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Base class for file properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • extension (str) – Optional File extension. If submitted it should not have a leading period and must match the extension from filePath.

  • file_path (str) – Relative path of this file resource. This property can be set when creating or updating the file resource.

  • last_modified (datetime) – Modification DateTime.

  • media_type (str) – File content type. This property can be modified to reflect the file content type.

  • size (int) – File size.

Keyword Arguments

  • extension (str) – Optional File extension. If submitted it should not have a leading period and must match the extension from filePath.

  • file_path (str) – Relative path of this file resource. This property can be set when creating or updating the file resource.

  • media_type (str) – File content type. This property can be modified to reflect the file content type.

class azure.mgmt.datamigration.models.ProjectList(*, value: Optional[List[_models.Project]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

OData page of project resources.

Variables

  • value (list[Project]) – List of projects.

  • next_link (str) – URL to load the next page of projects.

Keyword Arguments

  • value (list[Project]) – List of projects.

  • next_link (str) – URL to load the next page of projects.

class azure.mgmt.datamigration.models.ProjectProvisioningState(value)[source]

Bases: str, enum.Enum

The project’s provisioning state.

DELETING = 'Deleting'
SUCCEEDED = 'Succeeded'
class azure.mgmt.datamigration.models.ProjectSourcePlatform(value)[source]

Bases: str, enum.Enum

Source platform of the project.

MONGO_DB = 'MongoDb'
MY_SQL = 'MySQL'
POSTGRE_SQL = 'PostgreSql'
SQL = 'SQL'
UNKNOWN = 'Unknown'
class azure.mgmt.datamigration.models.ProjectTargetPlatform(value)[source]

Bases: str, enum.Enum

Target platform of the project.

AZURE_DB_FOR_MY_SQL = 'AzureDbForMySql'
AZURE_DB_FOR_POSTGRE_SQL = 'AzureDbForPostgreSql'
MONGO_DB = 'MongoDb'
SQLDB = 'SQLDB'
SQLMI = 'SQLMI'
UNKNOWN = 'Unknown'
class azure.mgmt.datamigration.models.ProjectTask(*, etag: Optional[str] = None, properties: Optional[_models.ProjectTaskProperties] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.Resource

A task resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

  • etag (str) – HTTP strong entity tag value. This is ignored if submitted.

  • properties (ProjectTaskProperties) – Custom task properties.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments

  • etag (str) – HTTP strong entity tag value. This is ignored if submitted.

  • properties (ProjectTaskProperties) – Custom task properties.

class azure.mgmt.datamigration.models.ProjectTaskProperties(*, client_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Base class for all types of DMS task properties. If task is not supported by current client, this object is returned.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ConnectToMongoDbTaskProperties, ConnectToSourceMySqlTaskProperties, ConnectToSourceOracleSyncTaskProperties, ConnectToSourcePostgreSqlSyncTaskProperties, ConnectToSourceSqlServerTaskProperties, ConnectToSourceSqlServerSyncTaskProperties, ConnectToTargetAzureDbForMySqlTaskProperties, ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties, ConnectToTargetSqlMITaskProperties, ConnectToTargetSqlMISyncTaskProperties, ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties, ConnectToTargetSqlDbTaskProperties, ConnectToTargetSqlDbSyncTaskProperties, GetTdeCertificatesSqlTaskProperties, GetUserTablesSqlSyncTaskProperties, GetUserTablesSqlTaskProperties, GetUserTablesMySqlTaskProperties, GetUserTablesOracleTaskProperties, GetUserTablesPostgreSqlTaskProperties, MigrateMongoDbTaskProperties, MigrateMySqlAzureDbForMySqlOfflineTaskProperties, MigrateMySqlAzureDbForMySqlSyncTaskProperties, MigrateOracleAzureDbForPostgreSqlSyncTaskProperties, MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties, MigrateSqlServerSqlDbSyncTaskProperties, MigrateSqlServerSqlMITaskProperties, MigrateSqlServerSqlMISyncTaskProperties, MigrateSqlServerSqlDbTaskProperties, MigrateSsisTaskProperties, MigrateSchemaSqlServerSqlDbTaskProperties, CheckOCIDriverTaskProperties, InstallOCIDriverTaskProperties, UploadOCIDriverTaskProperties, ValidateMongoDbTaskProperties, ValidateOracleAzureDbForPostgreSqlSyncTaskProperties, ValidateMigrationInputSqlServerSqlMITaskProperties, ValidateMigrationInputSqlServerSqlMISyncTaskProperties, ValidateMigrationInputSqlServerSqlDbSyncTaskProperties

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

Keyword Arguments

client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

class azure.mgmt.datamigration.models.ProxyResource(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

ProxyResource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.datamigration.models.QueryAnalysisValidationResult(*, query_results: Optional[_models.QueryExecutionResult] = None, validation_errors: Optional[_models.ValidationError] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Results for query analysis comparison between the source and target.

Variables

  • query_results (QueryExecutionResult) – List of queries executed and it’s execution results in source and target.

  • validation_errors (ValidationError) – Errors that are part of the execution.

Keyword Arguments

  • query_results (QueryExecutionResult) – List of queries executed and it’s execution results in source and target.

  • validation_errors (ValidationError) – Errors that are part of the execution.

class azure.mgmt.datamigration.models.QueryExecutionResult(*, query_text: Optional[str] = None, statements_in_batch: Optional[int] = None, source_result: Optional[_models.ExecutionStatistics] = None, target_result: Optional[_models.ExecutionStatistics] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes query analysis results for execution in source and target.

Variables

  • query_text (str) – Query text retrieved from the source server.

  • statements_in_batch (int) – Total no. of statements in the batch.

  • source_result (ExecutionStatistics) – Query analysis result from the source.

  • target_result (ExecutionStatistics) – Query analysis result from the target.

Keyword Arguments

  • query_text (str) – Query text retrieved from the source server.

  • statements_in_batch (int) – Total no. of statements in the batch.

  • source_result (ExecutionStatistics) – Query analysis result from the source.

  • target_result (ExecutionStatistics) – Query analysis result from the target.

class azure.mgmt.datamigration.models.Quota(*, current_value: Optional[float] = None, id: Optional[str] = None, limit: Optional[float] = None, name: Optional[_models.QuotaName] = None, unit: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes a quota for or usage details about a resource.

Variables

  • current_value (float) – The current value of the quota. If null or missing, the current value cannot be determined in the context of the request.

  • id (str) – The resource ID of the quota object.

  • limit (float) – The maximum value of the quota. If null or missing, the quota has no maximum, in which case it merely tracks usage.

  • name (QuotaName) – The name of the quota.

  • unit (str) – The unit for the quota, such as Count, Bytes, BytesPerSecond, etc.

Keyword Arguments

  • current_value (float) – The current value of the quota. If null or missing, the current value cannot be determined in the context of the request.

  • id (str) – The resource ID of the quota object.

  • limit (float) – The maximum value of the quota. If null or missing, the quota has no maximum, in which case it merely tracks usage.

  • name (QuotaName) – The name of the quota.

  • unit (str) – The unit for the quota, such as Count, Bytes, BytesPerSecond, etc.

class azure.mgmt.datamigration.models.QuotaList(*, value: Optional[List[_models.Quota]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

OData page of quota objects.

Variables

  • value (list[Quota]) – List of quotas.

  • next_link (str) – URL to load the next page of quotas, or null or missing if this is the last page.

Keyword Arguments

  • value (list[Quota]) – List of quotas.

  • next_link (str) – URL to load the next page of quotas, or null or missing if this is the last page.

class azure.mgmt.datamigration.models.QuotaName(*, localized_value: Optional[str] = None, value: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

The name of the quota.

Variables

  • localized_value (str) – The localized name of the quota.

  • value (str) – The unlocalized name (or ID) of the quota.

Keyword Arguments

  • localized_value (str) – The localized name of the quota.

  • value (str) – The unlocalized name (or ID) of the quota.

class azure.mgmt.datamigration.models.RegenAuthKeys(*, key_name: Optional[str] = None, auth_key1: Optional[str] = None, auth_key2: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

An authentication key to regenerate.

Variables

  • key_name (str) – The name of authentication key to generate.

  • auth_key1 (str) – The first authentication key.

  • auth_key2 (str) – The second authentication key.

Keyword Arguments

  • key_name (str) – The name of authentication key to generate.

  • auth_key1 (str) – The first authentication key.

  • auth_key2 (str) – The second authentication key.

class azure.mgmt.datamigration.models.ReplicateMigrationState(value)[source]

Bases: str, enum.Enum

Wrapper for replicate reported migration states.

ACTION_REQUIRED = 'ACTION_REQUIRED'
COMPLETE = 'COMPLETE'
FAILED = 'FAILED'
PENDING = 'PENDING'
UNDEFINED = 'UNDEFINED'
VALIDATING = 'VALIDATING'
class azure.mgmt.datamigration.models.ReportableException(*, message: Optional[str] = None, actionable_message: Optional[str] = None, file_path: Optional[str] = None, line_number: Optional[str] = None, h_result: Optional[int] = None, stack_trace: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Exception object for all custom exceptions.

Variables

  • message (str) – Error message.

  • actionable_message (str) – Actionable steps for this exception.

  • file_path (str) – The path to the file where exception occurred.

  • line_number (str) – The line number where exception occurred.

  • h_result (int) – Coded numerical value that is assigned to a specific exception.

  • stack_trace (str) – Stack trace.

Keyword Arguments

  • message (str) – Error message.

  • actionable_message (str) – Actionable steps for this exception.

  • file_path (str) – The path to the file where exception occurred.

  • line_number (str) – The line number where exception occurred.

  • h_result (int) – Coded numerical value that is assigned to a specific exception.

  • stack_trace (str) – Stack trace.

class azure.mgmt.datamigration.models.Resource(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

class azure.mgmt.datamigration.models.ResourceSku(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes an available DMS SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • resource_type (str) – The type of resource the SKU applies to.

  • name (str) – The name of SKU.

  • tier (str) – Specifies the tier of DMS in a scale set.

  • size (str) – The Size of the SKU.

  • family (str) – The Family of this particular SKU.

  • kind (str) – The Kind of resources that are supported in this SKU.

  • capacity (ResourceSkuCapacity) – Not used.

  • locations (list[str]) – The set of locations that the SKU is available.

  • api_versions (list[str]) – The api versions that support this SKU.

  • costs (list[ResourceSkuCosts]) – Metadata for retrieving price info.

  • capabilities (list[ResourceSkuCapabilities]) – A name value pair to describe the capability.

  • restrictions (list[ResourceSkuRestrictions]) – The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.

class azure.mgmt.datamigration.models.ResourceSkuCapabilities(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes The SKU capabilities object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name (str) – An invariant to describe the feature.

  • value (str) – An invariant if the feature is measured by quantity.

class azure.mgmt.datamigration.models.ResourceSkuCapacity(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes scaling information of a SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • minimum (int) – The minimum capacity.

  • maximum (int) – The maximum capacity.

  • default (int) – The default capacity.

  • scale_type (str or ResourceSkuCapacityScaleType) – The scale type applicable to the SKU. Known values are: “Automatic”, “Manual”, and “None”.

class azure.mgmt.datamigration.models.ResourceSkuCapacityScaleType(value)[source]

Bases: str, enum.Enum

The scale type applicable to the SKU.

AUTOMATIC = 'Automatic'
MANUAL = 'Manual'
NONE = 'None'
class azure.mgmt.datamigration.models.ResourceSkuCosts(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes metadata for retrieving price info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • meter_id (str) – Used for querying price from commerce.

  • quantity (int) – The multiplier is needed to extend the base metered cost.

  • extended_unit (str) – An invariant to show the extended unit.

class azure.mgmt.datamigration.models.ResourceSkuRestrictions(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Describes scaling information of a SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • type (str or ResourceSkuRestrictionsType) – The type of restrictions. “location”

  • values (list[str]) – The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.

  • reason_code (str or ResourceSkuRestrictionsReasonCode) – The reason code for restriction. Known values are: “QuotaId” and “NotAvailableForSubscription”.

class azure.mgmt.datamigration.models.ResourceSkuRestrictionsReasonCode(value)[source]

Bases: str, enum.Enum

The reason code for restriction.

NOT_AVAILABLE_FOR_SUBSCRIPTION = 'NotAvailableForSubscription'
QUOTA_ID = 'QuotaId'
class azure.mgmt.datamigration.models.ResourceSkuRestrictionsType(value)[source]

Bases: str, enum.Enum

The type of restrictions.

LOCATION = 'location'
class azure.mgmt.datamigration.models.ResourceSkusResult(*, value: List[_models.ResourceSku], next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

The DMS List SKUs operation response.

All required parameters must be populated in order to send to Azure.

Variables

  • value (list[ResourceSku]) – The list of SKUs available for the subscription. Required.

  • next_link (str) – The uri to fetch the next page of DMS SKUs. Call ListNext() with this to fetch the next page of DMS SKUs.

Keyword Arguments

  • value (list[ResourceSku]) – The list of SKUs available for the subscription. Required.

  • next_link (str) – The uri to fetch the next page of DMS SKUs. Call ListNext() with this to fetch the next page of DMS SKUs.

class azure.mgmt.datamigration.models.ResourceType(value)[source]

Bases: str, enum.Enum

ResourceType.

SQL_DB = 'SqlDb'
SQL_MI = 'SqlMi'
SQL_VM = 'SqlVm'
class azure.mgmt.datamigration.models.ScenarioSource(value)[source]

Bases: str, enum.Enum

An enumeration of source type.

ACCESS = 'Access'
DB2 = 'DB2'
MONGO_DB = 'MongoDB'
MY_SQL = 'MySQL'
MY_SQLRDS = 'MySQLRDS'
ORACLE = 'Oracle'
POSTGRE_SQL = 'PostgreSQL'
POSTGRE_SQLRDS = 'PostgreSQLRDS'
SQL = 'SQL'
SQLRDS = 'SQLRDS'
SYBASE = 'Sybase'
class azure.mgmt.datamigration.models.ScenarioTarget(value)[source]

Bases: str, enum.Enum

An enumeration of target type.

AZURE_DB_FOR_MY_SQL = 'AzureDBForMySql'
AZURE_DB_FOR_POSTGRES_SQL = 'AzureDBForPostgresSQL'
MONGO_DB = 'MongoDB'
SQLDB = 'SQLDB'
SQLDW = 'SQLDW'
SQLMI = 'SQLMI'
SQL_SERVER = 'SQLServer'
class azure.mgmt.datamigration.models.SchemaComparisonValidationResult(*, schema_differences: Optional[_models.SchemaComparisonValidationResultType] = None, validation_errors: Optional[_models.ValidationError] = None, source_database_object_count: Optional[Dict[str, int]] = None, target_database_object_count: Optional[Dict[str, int]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Results for schema comparison between the source and target.

Variables

  • schema_differences (SchemaComparisonValidationResultType) – List of schema differences between the source and target databases.

  • validation_errors (ValidationError) – List of errors that happened while performing schema compare validation.

  • source_database_object_count (dict[str, int]) – Count of source database objects.

  • target_database_object_count (dict[str, int]) – Count of target database objects.

Keyword Arguments

  • schema_differences (SchemaComparisonValidationResultType) – List of schema differences between the source and target databases.

  • validation_errors (ValidationError) – List of errors that happened while performing schema compare validation.

  • source_database_object_count (dict[str, int]) – Count of source database objects.

  • target_database_object_count (dict[str, int]) – Count of target database objects.

class azure.mgmt.datamigration.models.SchemaComparisonValidationResultType(*, object_name: Optional[str] = None, object_type: Optional[Union[str, _models.ObjectType]] = None, update_action: Optional[Union[str, _models.UpdateActionType]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Description about the errors happen while performing migration validation.

Variables

  • object_name (str) – Name of the object that has the difference.

  • object_type (str or ObjectType) – Type of the object that has the difference. e.g (Table/View/StoredProcedure). Known values are: “StoredProcedures”, “Table”, “User”, “View”, and “Function”.

  • update_action (str or UpdateActionType) – Update action type with respect to target. Known values are: “DeletedOnTarget”, “ChangedOnTarget”, and “AddedOnTarget”.

Keyword Arguments

  • object_name (str) – Name of the object that has the difference.

  • object_type (str or ObjectType) – Type of the object that has the difference. e.g (Table/View/StoredProcedure). Known values are: “StoredProcedures”, “Table”, “User”, “View”, and “Function”.

  • update_action (str or UpdateActionType) – Update action type with respect to target. Known values are: “DeletedOnTarget”, “ChangedOnTarget”, and “AddedOnTarget”.

class azure.mgmt.datamigration.models.SchemaMigrationOption(value)[source]

Bases: str, enum.Enum

Option for how schema is extracted and applied to target.

EXTRACT_FROM_SOURCE = 'ExtractFromSource'
NONE = 'None'
USE_STORAGE_FILE = 'UseStorageFile'
class azure.mgmt.datamigration.models.SchemaMigrationSetting(*, schema_option: Optional[Union[str, _models.SchemaMigrationOption]] = None, file_id: Optional[str] = None, file_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Settings for migrating schema from source to target.

Variables

  • schema_option (str or SchemaMigrationOption) – Option on how to migrate the schema. Known values are: “None”, “ExtractFromSource”, and “UseStorageFile”.

  • file_id (str) – Resource Identifier of a file resource containing the uploaded schema file.

  • file_name (str) – Name of the file resource containing the uploaded schema file.

Keyword Arguments

  • schema_option (str or SchemaMigrationOption) – Option on how to migrate the schema. Known values are: “None”, “ExtractFromSource”, and “UseStorageFile”.

  • file_id (str) – Resource Identifier of a file resource containing the uploaded schema file.

  • file_name (str) – Name of the file resource containing the uploaded schema file.

class azure.mgmt.datamigration.models.SchemaMigrationStage(value)[source]

Bases: str, enum.Enum

Current stage of schema migration.

COLLECTING_OBJECTS = 'CollectingObjects'
COMPLETED = 'Completed'
COMPLETED_WITH_WARNINGS = 'CompletedWithWarnings'
DEPLOYING_SCHEMA = 'DeployingSchema'
DOWNLOADING_SCRIPT = 'DownloadingScript'
FAILED = 'Failed'
GENERATING_SCRIPT = 'GeneratingScript'
NOT_STARTED = 'NotStarted'
UPLOADING_SCRIPT = 'UploadingScript'
VALIDATING_INPUTS = 'ValidatingInputs'
class azure.mgmt.datamigration.models.SelectedCertificateInput(*, certificate_name: str, password: str, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Info for certificate to be exported for TDE enabled databases.

All required parameters must be populated in order to send to Azure.

Variables

  • certificate_name (str) – Name of certificate to be exported. Required.

  • password (str) – Password to use for encrypting the exported certificate. Required.

Keyword Arguments

  • certificate_name (str) – Name of certificate to be exported. Required.

  • password (str) – Password to use for encrypting the exported certificate. Required.

class azure.mgmt.datamigration.models.ServerLevelPermissionsGroup(value)[source]

Bases: str, enum.Enum

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.

DEFAULT = 'Default'
MIGRATION_FROM_MY_SQL_TO_AZURE_DB_FOR_MY_SQL = 'MigrationFromMySQLToAzureDBForMySQL'
MIGRATION_FROM_SQL_SERVER_TO_AZURE_DB = 'MigrationFromSqlServerToAzureDB'
MIGRATION_FROM_SQL_SERVER_TO_AZURE_MI = 'MigrationFromSqlServerToAzureMI'
MIGRATION_FROM_SQL_SERVER_TO_AZURE_VM = 'MigrationFromSqlServerToAzureVM'
class azure.mgmt.datamigration.models.ServerProperties(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Server properties for MySQL type source.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • server_platform (str) – Name of the server platform.

  • server_name (str) – Name of the server.

  • server_version (str) – Version of the database server.

  • server_edition (str) – Edition of the database server.

  • server_operating_system_version (str) – Version of the operating system.

  • server_database_count (int) – Number of databases in the server.

class azure.mgmt.datamigration.models.ServiceOperation(*, name: Optional[str] = None, display: Optional[_models.ServiceOperationDisplay] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Description of an action supported by the Database Migration Service.

Variables

  • name (str) – The fully qualified action name, e.g. Microsoft.DataMigration/services/read.

  • display (ServiceOperationDisplay) – Localized display text.

Keyword Arguments

  • name (str) – The fully qualified action name, e.g. Microsoft.DataMigration/services/read.

  • display (ServiceOperationDisplay) – Localized display text.

class azure.mgmt.datamigration.models.ServiceOperationDisplay(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Localized display text.

Variables

  • provider (str) – The localized resource provider name.

  • resource (str) – The localized resource type name.

  • operation (str) – The localized operation name.

  • description (str) – The localized operation description.

Keyword Arguments

  • provider (str) – The localized resource provider name.

  • resource (str) – The localized resource type name.

  • operation (str) – The localized operation name.

  • description (str) – The localized operation description.

class azure.mgmt.datamigration.models.ServiceOperationList(*, value: Optional[List[_models.ServiceOperation]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

OData page of action (operation) objects.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.ServiceProvisioningState(value)[source]

Bases: str, enum.Enum

The resource’s provisioning state.

ACCEPTED = 'Accepted'
DELETING = 'Deleting'
DEPLOYING = 'Deploying'
FAILED = 'Failed'
FAILED_TO_START = 'FailedToStart'
FAILED_TO_STOP = 'FailedToStop'
STARTING = 'Starting'
STOPPED = 'Stopped'
STOPPING = 'Stopping'
SUCCEEDED = 'Succeeded'
class azure.mgmt.datamigration.models.ServiceScalability(value)[source]

Bases: str, enum.Enum

The scalability approach.

AUTOMATIC = 'automatic'
MANUAL = 'manual'
NONE = 'none'
class azure.mgmt.datamigration.models.ServiceSku(*, name: Optional[str] = None, tier: Optional[str] = None, family: Optional[str] = None, size: Optional[str] = None, capacity: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

An Azure SKU instance.

Variables

  • name (str) – The unique name of the SKU, such as ‘P3’.

  • tier (str) – The tier of the SKU, such as ‘Basic’, ‘General Purpose’, or ‘Business Critical’.

  • family (str) – The SKU family, used when the service has multiple performance classes within a tier, such as ‘A’, ‘D’, etc. for virtual machines.

  • size (str) – The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. ‘A1’ for virtual machines.

  • capacity (int) – The capacity of the SKU, if it supports scaling.

Keyword Arguments

  • name (str) – The unique name of the SKU, such as ‘P3’.

  • tier (str) – The tier of the SKU, such as ‘Basic’, ‘General Purpose’, or ‘Business Critical’.

  • family (str) – The SKU family, used when the service has multiple performance classes within a tier, such as ‘A’, ‘D’, etc. for virtual machines.

  • size (str) – The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. ‘A1’ for virtual machines.

  • capacity (int) – The capacity of the SKU, if it supports scaling.

class azure.mgmt.datamigration.models.ServiceSkuList(*, value: Optional[List[_models.AvailableServiceSku]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

OData page of available SKUs.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.Severity(value)[source]

Bases: str, enum.Enum

Severity of the validation error.

ERROR = 'Error'
MESSAGE = 'Message'
WARNING = 'Warning'
class azure.mgmt.datamigration.models.SourceLocation(*, file_share: Optional[_models.SqlFileShare] = None, azure_blob: Optional[_models.AzureBlob] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Source Location details of backups.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • file_share (SqlFileShare) – Source File share.

  • azure_blob (AzureBlob) – Source Azure Blob.

  • file_storage_type (str) – Backup storage Type.

Keyword Arguments
class azure.mgmt.datamigration.models.SqlBackupFileInfo(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Information of backup file.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • file_name (str) – File name.

  • status (str) – Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped).

  • total_size (int) – File size in bytes.

  • data_read (int) – Bytes read.

  • data_written (int) – Bytes written.

  • copy_throughput (float) – Copy throughput in KBps.

  • copy_duration (int) – Copy Duration in seconds.

  • family_sequence_number (int) – Media family sequence number.

class azure.mgmt.datamigration.models.SqlBackupSetInfo(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Information of backup set.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • backup_set_id (str) – Backup set id.

  • first_lsn (str) – First LSN of the backup set.

  • last_lsn (str) – Last LSN of the backup set.

  • backup_type (str) – Backup type.

  • list_of_backup_files (list[SqlBackupFileInfo]) – List of files in the backup set.

  • backup_start_date (datetime) – Backup start date.

  • backup_finish_date (datetime) – Backup end time.

  • is_backup_restored (bool) – Whether this backup set has been restored or not.

  • has_backup_checksums (bool) – Has Backup Checksums.

  • family_count (int) – Media family count.

  • ignore_reasons (list[str]) – The reasons why the backup set is ignored.

class azure.mgmt.datamigration.models.SqlConnectionInfo(*, data_source: str, user_name: Optional[str] = None, password: Optional[str] = None, server_name: Optional[str] = None, port: Optional[int] = None, server_version: Optional[str] = None, server_brand_version: Optional[str] = None, resource_id: Optional[str] = None, authentication: Optional[Union[str, _models.AuthenticationType]] = None, encrypt_connection: bool = True, additional_settings: Optional[str] = None, trust_server_certificate: bool = False, platform: Optional[Union[str, _models.SqlSourcePlatform]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ConnectionInfo

Information for connecting to SQL database server.

All required parameters must be populated in order to send to Azure.

Variables

  • type (str) – Type of connection info. Required.

  • user_name (str) – User name.

  • password (str) – Password credential.

  • data_source (str) – Data source in the format Protocol:MachineNameSQLServerInstanceName,PortNumber. Required.

  • server_name (str) – name of the server.

  • port (int) – Port for Server.

  • server_version (str) – server version.

  • server_brand_version (str) – server brand version.

  • resource_id (str) – Represents the ID of an HTTP resource represented by an Azure resource provider.

  • authentication (str or AuthenticationType) – Authentication type to use for connection. Known values are: “None”, “WindowsAuthentication”, “SqlAuthentication”, “ActiveDirectoryIntegrated”, and “ActiveDirectoryPassword”.

  • encrypt_connection (bool) – Whether to encrypt the connection.

  • additional_settings (str) – Additional connection settings.

  • trust_server_certificate (bool) – Whether to trust the server certificate.

  • platform (str or SqlSourcePlatform) – Server platform type for connection. “SqlOnPrem”

Keyword Arguments

  • user_name (str) – User name.

  • password (str) – Password credential.

  • data_source (str) – Data source in the format Protocol:MachineNameSQLServerInstanceName,PortNumber. Required.

  • server_name (str) – name of the server.

  • port (int) – Port for Server.

  • server_version (str) – server version.

  • server_brand_version (str) – server brand version.

  • resource_id (str) – Represents the ID of an HTTP resource represented by an Azure resource provider.

  • authentication (str or AuthenticationType) – Authentication type to use for connection. Known values are: “None”, “WindowsAuthentication”, “SqlAuthentication”, “ActiveDirectoryIntegrated”, and “ActiveDirectoryPassword”.

  • encrypt_connection (bool) – Whether to encrypt the connection.

  • additional_settings (str) – Additional connection settings.

  • trust_server_certificate (bool) – Whether to trust the server certificate.

  • platform (str or SqlSourcePlatform) – Server platform type for connection. “SqlOnPrem”

class azure.mgmt.datamigration.models.SqlConnectionInformation(*, data_source: Optional[str] = None, authentication: Optional[str] = None, user_name: Optional[str] = None, password: Optional[str] = None, encrypt_connection: Optional[bool] = None, trust_server_certificate: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Source SQL Connection.

Variables

  • data_source (str) – Data source.

  • authentication (str) – Authentication type.

  • user_name (str) – User name to connect to source SQL.

  • password (str) – Password to connect to source SQL.

  • encrypt_connection (bool) – Whether to encrypt connection or not.

  • trust_server_certificate (bool) – Whether to trust server certificate or not.

Keyword Arguments

  • data_source (str) – Data source.

  • authentication (str) – Authentication type.

  • user_name (str) – User name to connect to source SQL.

  • password (str) – Password to connect to source SQL.

  • encrypt_connection (bool) – Whether to encrypt connection or not.

  • trust_server_certificate (bool) – Whether to trust server certificate or not.

class azure.mgmt.datamigration.models.SqlDbMigrationStatusDetails(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Detailed status of current Sql Db migration.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • migration_state (str) – Current State of Migration.

  • sql_data_copy_errors (list[str]) – Sql Data Copy errors, if any.

  • list_of_copy_progress_details (list[CopyProgressDetails]) – Details on progress of ADF copy activities.

class azure.mgmt.datamigration.models.SqlDbOfflineConfiguration(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Offline configuration.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

offline (bool) – Offline migration.

class azure.mgmt.datamigration.models.SqlFileShare(*, path: Optional[str] = None, username: Optional[str] = None, password: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

File share.

Variables

  • path (str) – Location as SMB share or local drive where backups are placed.

  • username (str) – Username to access the file share location for backups.

  • password (str) – Password for username to access file share location.

Keyword Arguments

  • path (str) – Location as SMB share or local drive where backups are placed.

  • username (str) – Username to access the file share location for backups.

  • password (str) – Password for username to access file share location.

class azure.mgmt.datamigration.models.SqlMigrationListResult(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

A list of SQL Migration Service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.datamigration.models.SqlMigrationService(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.TrackedResource

A SQL Migration Service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • location (str) –

  • tags (dict[str, str]) – Dictionary of <string>.

  • id (str) –

  • name (str) –

  • type (str) –

  • system_data (SystemData) –

  • provisioning_state (str) – Provisioning state to track the async operation status.

  • integration_runtime_state (str) – Current state of the Integration runtime.

Keyword Arguments

  • location (str) –

  • tags (dict[str, str]) – Dictionary of <string>.

class azure.mgmt.datamigration.models.SqlMigrationServiceUpdate(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

An update to a SQL Migration Service.

Variables

tags (dict[str, str]) – Dictionary of <string>.

Keyword Arguments

tags (dict[str, str]) – Dictionary of <string>.

class azure.mgmt.datamigration.models.SqlMigrationTaskInput(*, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.SqlConnectionInfo, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Base class for migration task input.

All required parameters must be populated in order to send to Azure.

Variables

  • source_connection_info (SqlConnectionInfo) – Information for connecting to source. Required.

  • target_connection_info (SqlConnectionInfo) – Information for connecting to target. Required.

Keyword Arguments

  • source_connection_info (SqlConnectionInfo) – Information for connecting to source. Required.

  • target_connection_info (SqlConnectionInfo) – Information for connecting to target. Required.

class azure.mgmt.datamigration.models.SqlServerSqlMISyncTaskInput(*, selected_databases: List[_models.MigrateSqlServerSqlMIDatabaseInput], storage_resource_id: str, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.MiSqlConnectionInfo, azure_app: _models.AzureActiveDirectoryApp, backup_file_share: Optional[_models.FileShare] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • selected_databases (list[MigrateSqlServerSqlMIDatabaseInput]) – Databases to migrate. Required.

  • backup_file_share (FileShare) – Backup file share information for all selected databases.

  • storage_resource_id (str) – Fully qualified resourceId of storage. Required.

  • source_connection_info (SqlConnectionInfo) – Connection information for source SQL Server. Required.

  • target_connection_info (MiSqlConnectionInfo) – Connection information for Azure SQL Database Managed Instance. Required.

  • azure_app (AzureActiveDirectoryApp) – Azure Active Directory Application the DMS instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account. Required.

Keyword Arguments

  • selected_databases (list[MigrateSqlServerSqlMIDatabaseInput]) – Databases to migrate. Required.

  • backup_file_share (FileShare) – Backup file share information for all selected databases.

  • storage_resource_id (str) – Fully qualified resourceId of storage. Required.

  • source_connection_info (SqlConnectionInfo) – Connection information for source SQL Server. Required.

  • target_connection_info (MiSqlConnectionInfo) – Connection information for Azure SQL Database Managed Instance. Required.

  • azure_app (AzureActiveDirectoryApp) – Azure Active Directory Application the DMS instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account. Required.

class azure.mgmt.datamigration.models.SqlSourcePlatform(value)[source]

Bases: str, enum.Enum

An enumeration of source platform types.

SQL_ON_PREM = 'SqlOnPrem'
class azure.mgmt.datamigration.models.SsisMigrationInfo(*, ssis_store_type: Optional[Union[str, _models.SsisStoreType]] = None, project_overwrite_option: Optional[Union[str, _models.SsisMigrationOverwriteOption]] = None, environment_overwrite_option: Optional[Union[str, _models.SsisMigrationOverwriteOption]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

SSIS migration info with SSIS store type, overwrite policy.

Variables

  • ssis_store_type (str or SsisStoreType) – The SSIS store type of source, only SSIS catalog is supported now in DMS. “SsisCatalog”

  • project_overwrite_option (str or SsisMigrationOverwriteOption) – The overwrite option for the SSIS project migration. Known values are: “Ignore” and “Overwrite”.

  • environment_overwrite_option (str or SsisMigrationOverwriteOption) – The overwrite option for the SSIS environment migration. Known values are: “Ignore” and “Overwrite”.

Keyword Arguments

  • ssis_store_type (str or SsisStoreType) – The SSIS store type of source, only SSIS catalog is supported now in DMS. “SsisCatalog”

  • project_overwrite_option (str or SsisMigrationOverwriteOption) – The overwrite option for the SSIS project migration. Known values are: “Ignore” and “Overwrite”.

  • environment_overwrite_option (str or SsisMigrationOverwriteOption) – The overwrite option for the SSIS environment migration. Known values are: “Ignore” and “Overwrite”.

class azure.mgmt.datamigration.models.SsisMigrationOverwriteOption(value)[source]

Bases: str, enum.Enum

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

IGNORE = 'Ignore'
OVERWRITE = 'Overwrite'
class azure.mgmt.datamigration.models.SsisMigrationStage(value)[source]

Bases: str, enum.Enum

Current stage of SSIS migration.

COMPLETED = 'Completed'
INITIALIZE = 'Initialize'
IN_PROGRESS = 'InProgress'
NONE = 'None'
class azure.mgmt.datamigration.models.SsisStoreType(value)[source]

Bases: str, enum.Enum

An enumeration of supported source SSIS store type in DMS.

SSIS_CATALOG = 'SsisCatalog'
class azure.mgmt.datamigration.models.StartMigrationScenarioServerRoleResult(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Server role migration result.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name (str) – Name of server role.

  • state (str or MigrationState) – Current state of migration. Known values are: “None”, “InProgress”, “Failed”, “Warning”, “Completed”, “Skipped”, and “Stopped”.

  • exceptions_and_warnings (list[ReportableException]) – Migration exceptions and warnings.

class azure.mgmt.datamigration.models.SyncDatabaseMigrationReportingState(value)[source]

Bases: str, enum.Enum

Enum of the different state of database level online migration.

BACKUP_COMPLETED = 'BACKUP_COMPLETED'
BACKUP_IN_PROGRESS = 'BACKUP_IN_PROGRESS'
CANCELLED = 'CANCELLED'
CANCELLING = 'CANCELLING'
COMPLETE = 'COMPLETE'
COMPLETING = 'COMPLETING'
CONFIGURING = 'CONFIGURING'
FAILED = 'FAILED'
INITIALIAZING = 'INITIALIAZING'
READY_TO_COMPLETE = 'READY_TO_COMPLETE'
RESTORE_COMPLETED = 'RESTORE_COMPLETED'
RESTORE_IN_PROGRESS = 'RESTORE_IN_PROGRESS'
RUNNING = 'RUNNING'
STARTING = 'STARTING'
UNDEFINED = 'UNDEFINED'
VALIDATING = 'VALIDATING'
VALIDATION_COMPLETE = 'VALIDATION_COMPLETE'
VALIDATION_FAILED = 'VALIDATION_FAILED'
class azure.mgmt.datamigration.models.SyncMigrationDatabaseErrorEvent(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Database migration errors for online migration.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • timestamp_string (str) – String value of timestamp.

  • event_type_string (str) – Event type.

  • event_text (str) – Event text.

class azure.mgmt.datamigration.models.SyncTableMigrationState(value)[source]

Bases: str, enum.Enum

Enum of the different state of table level online migration.

BEFORE_LOAD = 'BEFORE_LOAD'
CANCELED = 'CANCELED'
COMPLETED = 'COMPLETED'
ERROR = 'ERROR'
FAILED = 'FAILED'
FULL_LOAD = 'FULL_LOAD'
class azure.mgmt.datamigration.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

SystemData.

Variables

  • created_by (str) –

  • created_by_type (str or CreatedByType) – Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) –

  • last_modified_by (str) –

  • last_modified_by_type (str or CreatedByType) – Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) –

Keyword Arguments

  • created_by (str) –

  • created_by_type (str or CreatedByType) – Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) –

  • last_modified_by (str) –

  • last_modified_by_type (str or CreatedByType) – Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) –

class azure.mgmt.datamigration.models.TargetLocation(*, storage_account_resource_id: Optional[str] = None, account_key: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Target Location details for optional copy of backups.

Variables

  • storage_account_resource_id (str) – Resource Id of the storage account copying backups.

  • account_key (str) – Storage Account Key.

Keyword Arguments

  • storage_account_resource_id (str) – Resource Id of the storage account copying backups.

  • account_key (str) – Storage Account Key.

class azure.mgmt.datamigration.models.TaskList(*, value: Optional[List[_models.ProjectTask]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

OData page of tasks.

Variables

  • value (list[ProjectTask]) – List of tasks.

  • next_link (str) – URL to load the next page of tasks.

Keyword Arguments

  • value (list[ProjectTask]) – List of tasks.

  • next_link (str) – URL to load the next page of tasks.

class azure.mgmt.datamigration.models.TaskState(value)[source]

Bases: str, enum.Enum

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

CANCELED = 'Canceled'
FAILED = 'Failed'
FAILED_INPUT_VALIDATION = 'FailedInputValidation'
FAULTED = 'Faulted'
QUEUED = 'Queued'
RUNNING = 'Running'
SUCCEEDED = 'Succeeded'
UNKNOWN = 'Unknown'
class azure.mgmt.datamigration.models.TaskType(value)[source]

Bases: str, enum.Enum

Task type.

CONNECT_MONGO_DB = 'Connect.MongoDb'
CONNECT_TO_SOURCE_MY_SQL = 'ConnectToSource.MySql'
CONNECT_TO_SOURCE_ORACLE_SYNC = 'ConnectToSource.Oracle.Sync'
CONNECT_TO_SOURCE_POSTGRE_SQL_SYNC = 'ConnectToSource.PostgreSql.Sync'
CONNECT_TO_SOURCE_SQL_SERVER = 'ConnectToSource.SqlServer'
CONNECT_TO_SOURCE_SQL_SERVER_SYNC = 'ConnectToSource.SqlServer.Sync'
CONNECT_TO_TARGET_AZURE_DB_FOR_MY_SQL = 'ConnectToTarget.AzureDbForMySql'
CONNECT_TO_TARGET_AZURE_DB_FOR_POSTGRE_SQL_SYNC = 'ConnectToTarget.AzureDbForPostgreSql.Sync'
CONNECT_TO_TARGET_AZURE_SQL_DB_MI = 'ConnectToTarget.AzureSqlDbMI'
CONNECT_TO_TARGET_AZURE_SQL_DB_MI_SYNC_LRS = 'ConnectToTarget.AzureSqlDbMI.Sync.LRS'
CONNECT_TO_TARGET_ORACLE_AZURE_DB_FOR_POSTGRE_SQL_SYNC = 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync'
CONNECT_TO_TARGET_SQL_DB = 'ConnectToTarget.SqlDb'
CONNECT_TO_TARGET_SQL_DB_SYNC = 'ConnectToTarget.SqlDb.Sync'
GET_TDE_CERTIFICATES_SQL = 'GetTDECertificates.Sql'
GET_USER_TABLES_AZURE_SQL_DB_SYNC = 'GetUserTables.AzureSqlDb.Sync'
GET_USER_TABLES_MY_SQL = 'GetUserTablesMySql'
GET_USER_TABLES_ORACLE = 'GetUserTablesOracle'
GET_USER_TABLES_POSTGRE_SQL = 'GetUserTablesPostgreSql'
GET_USER_TABLES_SQL = 'GetUserTables.Sql'
MIGRATE_MONGO_DB = 'Migrate.MongoDb'
MIGRATE_MY_SQL_AZURE_DB_FOR_MY_SQL = 'Migrate.MySql.AzureDbForMySql'
MIGRATE_MY_SQL_AZURE_DB_FOR_MY_SQL_SYNC = 'Migrate.MySql.AzureDbForMySql.Sync'
MIGRATE_ORACLE_AZURE_DB_FOR_POSTGRE_SQL_SYNC = 'Migrate.Oracle.AzureDbForPostgreSql.Sync'
MIGRATE_POSTGRE_SQL_AZURE_DB_FOR_POSTGRE_SQL_SYNC_V2 = 'Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2'
MIGRATE_SCHEMA_SQL_SERVER_SQL_DB = 'MigrateSchemaSqlServerSqlDb'
MIGRATE_SQL_SERVER_AZURE_SQL_DB_MI = 'Migrate.SqlServer.AzureSqlDbMI'
MIGRATE_SQL_SERVER_AZURE_SQL_DB_MI_SYNC_LRS = 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS'
MIGRATE_SQL_SERVER_AZURE_SQL_DB_SYNC = 'Migrate.SqlServer.AzureSqlDb.Sync'
MIGRATE_SQL_SERVER_SQL_DB = 'Migrate.SqlServer.SqlDb'
MIGRATE_SSIS = 'Migrate.Ssis'
SERVICE_CHECK_OCI = 'Service.Check.OCI'
SERVICE_INSTALL_OCI = 'Service.Install.OCI'
SERVICE_UPLOAD_OCI = 'Service.Upload.OCI'
VALIDATE_MIGRATION_INPUT_SQL_SERVER_AZURE_SQL_DB_MI = 'ValidateMigrationInput.SqlServer.AzureSqlDbMI'
VALIDATE_MIGRATION_INPUT_SQL_SERVER_AZURE_SQL_DB_MI_SYNC_LRS = 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS'
VALIDATE_MIGRATION_INPUT_SQL_SERVER_SQL_DB_SYNC = 'ValidateMigrationInput.SqlServer.SqlDb.Sync'
VALIDATE_MONGO_DB = 'Validate.MongoDb'
VALIDATE_ORACLE_AZURE_DB_POSTGRE_SQL_SYNC = 'Validate.Oracle.AzureDbPostgreSql.Sync'
class azure.mgmt.datamigration.models.TrackedResource(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

TrackedResource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
Keyword Arguments

  • location (str) –

  • tags (dict[str, str]) – Dictionary of <string>.

class azure.mgmt.datamigration.models.UpdateActionType(value)[source]

Bases: str, enum.Enum

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

ADDED_ON_TARGET = 'AddedOnTarget'
CHANGED_ON_TARGET = 'ChangedOnTarget'
DELETED_ON_TARGET = 'DeletedOnTarget'
class azure.mgmt.datamigration.models.UploadOCIDriverTaskInput(*, driver_share: Optional[_models.FileShare] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Input for the service task to upload an OCI driver.

Variables

driver_share (FileShare) – File share information for the OCI driver archive.

Keyword Arguments

driver_share (FileShare) – File share information for the OCI driver archive.

class azure.mgmt.datamigration.models.UploadOCIDriverTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Output for the service task to upload an OCI driver.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • driver_package_name (str) – The name of the driver package that was validated and uploaded.

  • validation_errors (list[ReportableException]) – Validation errors.

class azure.mgmt.datamigration.models.UploadOCIDriverTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.UploadOCIDriverTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

Properties for the task that uploads an OCI driver.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (UploadOCIDriverTaskInput) – Input for the service task to upload an OCI driver.

  • output (list[UploadOCIDriverTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (UploadOCIDriverTaskInput) – Input for the service task to upload an OCI driver.

class azure.mgmt.datamigration.models.ValidateMigrationInputSqlServerSqlDbSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ValidateSyncMigrationInputSqlServerTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ValidateSyncMigrationInputSqlServerTaskInput) – Task input.

  • output (list[ValidateSyncMigrationInputSqlServerTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ValidateMigrationInputSqlServerSqlMISyncTaskInput(*, selected_databases: List[_models.MigrateSqlServerSqlMIDatabaseInput], storage_resource_id: str, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.MiSqlConnectionInfo, azure_app: _models.AzureActiveDirectoryApp, backup_file_share: Optional[_models.FileShare] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.SqlServerSqlMISyncTaskInput

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

All required parameters must be populated in order to send to Azure.

Variables

  • selected_databases (list[MigrateSqlServerSqlMIDatabaseInput]) – Databases to migrate. Required.

  • backup_file_share (FileShare) – Backup file share information for all selected databases.

  • storage_resource_id (str) – Fully qualified resourceId of storage. Required.

  • source_connection_info (SqlConnectionInfo) – Connection information for source SQL Server. Required.

  • target_connection_info (MiSqlConnectionInfo) – Connection information for Azure SQL Database Managed Instance. Required.

  • azure_app (AzureActiveDirectoryApp) – Azure Active Directory Application the DMS instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account. Required.

Keyword Arguments

  • selected_databases (list[MigrateSqlServerSqlMIDatabaseInput]) – Databases to migrate. Required.

  • backup_file_share (FileShare) – Backup file share information for all selected databases.

  • storage_resource_id (str) – Fully qualified resourceId of storage. Required.

  • source_connection_info (SqlConnectionInfo) – Connection information for source SQL Server. Required.

  • target_connection_info (MiSqlConnectionInfo) – Connection information for Azure SQL Database Managed Instance. Required.

  • azure_app (AzureActiveDirectoryApp) – Azure Active Directory Application the DMS instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account. Required.

class azure.mgmt.datamigration.models.ValidateMigrationInputSqlServerSqlMISyncTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Database identifier.

  • name (str) – Name of database.

  • validation_errors (list[ReportableException]) – Errors associated with a selected database object.

class azure.mgmt.datamigration.models.ValidateMigrationInputSqlServerSqlMISyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ValidateMigrationInputSqlServerSqlMISyncTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ValidateMigrationInputSqlServerSqlMISyncTaskInput) – Task input.

  • output (list[ValidateMigrationInputSqlServerSqlMISyncTaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ValidateMigrationInputSqlServerSqlMITaskInput(*, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.SqlConnectionInfo, selected_databases: List[_models.MigrateSqlServerSqlMIDatabaseInput], backup_blob_share: _models.BlobShare, selected_logins: Optional[List[str]] = None, backup_file_share: Optional[_models.FileShare] = None, backup_mode: Optional[Union[str, _models.BackupMode]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

All required parameters must be populated in order to send to Azure.

Variables

  • source_connection_info (SqlConnectionInfo) – Information for connecting to source. Required.

  • target_connection_info (SqlConnectionInfo) – Information for connecting to target. Required.

  • selected_databases (list[MigrateSqlServerSqlMIDatabaseInput]) – Databases to migrate. Required.

  • selected_logins (list[str]) – Logins to migrate.

  • backup_file_share (FileShare) – Backup file share information for all selected databases.

  • backup_blob_share (BlobShare) – SAS URI of Azure Storage Account Container to be used for storing backup files. Required.

  • backup_mode (str or BackupMode) – Backup Mode to specify whether to use existing backup or create new backup. Known values are: “CreateBackup” and “ExistingBackup”.

Keyword Arguments

  • source_connection_info (SqlConnectionInfo) – Information for connecting to source. Required.

  • target_connection_info (SqlConnectionInfo) – Information for connecting to target. Required.

  • selected_databases (list[MigrateSqlServerSqlMIDatabaseInput]) – Databases to migrate. Required.

  • selected_logins (list[str]) – Logins to migrate.

  • backup_file_share (FileShare) – Backup file share information for all selected databases.

  • backup_blob_share (BlobShare) – SAS URI of Azure Storage Account Container to be used for storing backup files. Required.

  • backup_mode (str or BackupMode) – Backup Mode to specify whether to use existing backup or create new backup. Known values are: “CreateBackup” and “ExistingBackup”.

class azure.mgmt.datamigration.models.ValidateMigrationInputSqlServerSqlMITaskOutput(*, database_backup_info: Optional[_models.DatabaseBackupInfo] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Result identifier.

  • name (str) – Name of database.

  • restore_database_name_errors (list[ReportableException]) – Errors associated with the RestoreDatabaseName.

  • backup_folder_errors (list[ReportableException]) – Errors associated with the BackupFolder path.

  • backup_share_credentials_errors (list[ReportableException]) – Errors associated with backup share user name and password credentials.

  • backup_storage_account_errors (list[ReportableException]) – Errors associated with the storage account provided.

  • existing_backup_errors (list[ReportableException]) – Errors associated with existing backup files.

  • database_backup_info (DatabaseBackupInfo) – Information about backup files when existing backup mode is used.

Keyword Arguments

database_backup_info (DatabaseBackupInfo) – Information about backup files when existing backup mode is used.

class azure.mgmt.datamigration.models.ValidateMigrationInputSqlServerSqlMITaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.ValidateMigrationInputSqlServerSqlMITaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (ValidateMigrationInputSqlServerSqlMITaskInput) – Task input.

  • output (list[ValidateMigrationInputSqlServerSqlMITaskOutput]) – Task output. This is ignored if submitted.

Keyword Arguments
class azure.mgmt.datamigration.models.ValidateMongoDbTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MongoDbMigrationSettings] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MongoDbMigrationSettings) – Describes how a MongoDB data migration should be performed.

  • output (list[MongoDbMigrationProgress]) – An array containing a single MongoDbMigrationProgress object.

Keyword Arguments

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MongoDbMigrationSettings) – Describes how a MongoDB data migration should be performed.

class azure.mgmt.datamigration.models.ValidateOracleAzureDbForPostgreSqlSyncTaskProperties(*, client_data: Optional[Dict[str, str]] = None, input: Optional[_models.MigrateOracleAzureDbPostgreSqlSyncTaskInput] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration.models._models_py3.ProjectTaskProperties

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • task_type (str or TaskType) – Task type. Required. Known values are: “Connect.MongoDb”, “ConnectToSource.SqlServer”, “ConnectToSource.SqlServer.Sync”, “ConnectToSource.PostgreSql.Sync”, “ConnectToSource.MySql”, “ConnectToSource.Oracle.Sync”, “ConnectToTarget.SqlDb”, “ConnectToTarget.SqlDb.Sync”, “ConnectToTarget.AzureDbForPostgreSql.Sync”, “ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync”, “ConnectToTarget.AzureSqlDbMI”, “ConnectToTarget.AzureSqlDbMI.Sync.LRS”, “ConnectToTarget.AzureDbForMySql”, “GetUserTables.Sql”, “GetUserTables.AzureSqlDb.Sync”, “GetUserTablesOracle”, “GetUserTablesPostgreSql”, “GetUserTablesMySql”, “Migrate.MongoDb”, “Migrate.SqlServer.AzureSqlDbMI”, “Migrate.SqlServer.AzureSqlDbMI.Sync.LRS”, “Migrate.SqlServer.SqlDb”, “Migrate.SqlServer.AzureSqlDb.Sync”, “Migrate.MySql.AzureDbForMySql.Sync”, “Migrate.MySql.AzureDbForMySql”, “Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2”, “Migrate.Oracle.AzureDbForPostgreSql.Sync”, “ValidateMigrationInput.SqlServer.SqlDb.Sync”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI”, “ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS”, “Validate.MongoDb”, “Validate.Oracle.AzureDbPostgreSql.Sync”, “GetTDECertificates.Sql”, “Migrate.Ssis”, “Service.Check.OCI”, “Service.Upload.OCI”, “Service.Install.OCI”, and “MigrateSchemaSqlServerSqlDb”.

  • errors (list[ODataError]) – Array of errors. This is ignored if submitted.

  • state (str or TaskState) – The state of the task. This is ignored if submitted. Known values are: “Unknown”, “Queued”, “Running”, “Canceled”, “Succeeded”, “Failed”, “FailedInputValidation”, and “Faulted”.

  • commands (list[CommandProperties]) – Array of command properties.

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateOracleAzureDbPostgreSqlSyncTaskInput) – Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations.

  • output (list[ValidateOracleAzureDbPostgreSqlSyncTaskOutput]) – An array containing a single validation error response object.

Keyword Arguments

  • client_data (dict[str, str]) – Key value pairs of client data to attach meta data information to task.

  • input (MigrateOracleAzureDbPostgreSqlSyncTaskInput) – Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations.

class azure.mgmt.datamigration.models.ValidateOracleAzureDbPostgreSqlSyncTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

validation_errors (list[ReportableException]) – Errors associated with a selected database object.

class azure.mgmt.datamigration.models.ValidateSyncMigrationInputSqlServerTaskInput(*, source_connection_info: _models.SqlConnectionInfo, target_connection_info: _models.SqlConnectionInfo, selected_databases: List[_models.MigrateSqlServerSqlDbSyncDatabaseInput], **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Input for task that validates migration input for SQL sync migrations.

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments
class azure.mgmt.datamigration.models.ValidateSyncMigrationInputSqlServerTaskOutput(**kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Output for task that validates migration input for SQL sync migrations.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Database identifier.

  • name (str) – Name of database.

  • validation_errors (list[ReportableException]) – Errors associated with a selected database object.

class azure.mgmt.datamigration.models.ValidationError(*, text: Optional[str] = None, severity: Optional[Union[str, _models.Severity]] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Description about the errors happen while performing migration validation.

Variables

  • text (str) – Error Text.

  • severity (str or Severity) – Severity of the error. Known values are: “Message”, “Warning”, and “Error”.

Keyword Arguments

  • text (str) – Error Text.

  • severity (str or Severity) – Severity of the error. Known values are: “Message”, “Warning”, and “Error”.

class azure.mgmt.datamigration.models.ValidationStatus(value)[source]

Bases: str, enum.Enum

Current status of the validation.

COMPLETED = 'Completed'
COMPLETED_WITH_ISSUES = 'CompletedWithIssues'
DEFAULT = 'Default'
FAILED = 'Failed'
INITIALIZED = 'Initialized'
IN_PROGRESS = 'InProgress'
NOT_STARTED = 'NotStarted'
STOPPED = 'Stopped'
class azure.mgmt.datamigration.models.WaitStatistics(*, wait_type: Optional[str] = None, wait_time_ms: float = 0, wait_count: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.datamigration._serialization.Model

Wait statistics gathered during query batch execution.

Variables

  • wait_type (str) – Type of the Wait.

  • wait_time_ms (float) – Total wait time in millisecond(s).

  • wait_count (int) – Total no. of waits.

Keyword Arguments

  • wait_type (str) – Type of the Wait.

  • wait_time_ms (float) – Total wait time in millisecond(s).

  • wait_count (int) – Total no. of waits.