# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------
from msrest.serialization import Model
from msrest.exceptions import HttpOperationError
[docs]class ApiError(Model):
"""Error information.
:param error: Error information in OData format
:type error: ~azure.mgmt.datamigration.models.ODataError
"""
_attribute_map = {
'error': {'key': 'error', 'type': 'ODataError'},
}
def __init__(self, *, error=None, **kwargs) -> None:
super(ApiError, self).__init__(**kwargs)
self.error = error
[docs]class ApiErrorException(HttpOperationError):
"""Server responsed with exception of type: 'ApiError'.
:param deserialize: A deserializer
:param response: Server response to be deserialized.
"""
def __init__(self, deserialize, response, *args):
super(ApiErrorException, self).__init__(deserialize, response, 'ApiError', *args)
[docs]class AvailableServiceSku(Model):
"""Describes the available service SKU.
:param resource_type: The resource type, including the provider namespace
:type resource_type: str
:param sku: SKU name, tier, etc.
:type sku: ~azure.mgmt.datamigration.models.AvailableServiceSkuSku
:param capacity: A description of the scaling capacities of the SKU
:type capacity:
~azure.mgmt.datamigration.models.AvailableServiceSkuCapacity
"""
_attribute_map = {
'resource_type': {'key': 'resourceType', 'type': 'str'},
'sku': {'key': 'sku', 'type': 'AvailableServiceSkuSku'},
'capacity': {'key': 'capacity', 'type': 'AvailableServiceSkuCapacity'},
}
def __init__(self, *, resource_type: str=None, sku=None, capacity=None, **kwargs) -> None:
super(AvailableServiceSku, self).__init__(**kwargs)
self.resource_type = resource_type
self.sku = sku
self.capacity = capacity
[docs]class AvailableServiceSkuCapacity(Model):
"""A description of the scaling capacities of the SKU.
:param minimum: The minimum capacity, usually 0 or 1.
:type minimum: int
:param maximum: The maximum capacity
:type maximum: int
:param default: The default capacity
:type default: int
:param scale_type: The scalability approach. Possible values include:
'none', 'manual', 'automatic'
:type scale_type: str or
~azure.mgmt.datamigration.models.ServiceScalability
"""
_attribute_map = {
'minimum': {'key': 'minimum', 'type': 'int'},
'maximum': {'key': 'maximum', 'type': 'int'},
'default': {'key': 'default', 'type': 'int'},
'scale_type': {'key': 'scaleType', 'type': 'str'},
}
def __init__(self, *, minimum: int=None, maximum: int=None, default: int=None, scale_type=None, **kwargs) -> None:
super(AvailableServiceSkuCapacity, self).__init__(**kwargs)
self.minimum = minimum
self.maximum = maximum
self.default = default
self.scale_type = scale_type
[docs]class AvailableServiceSkuSku(Model):
"""SKU name, tier, etc.
:param name: The name of the SKU
:type name: str
:param family: SKU family
:type family: str
:param size: SKU size
:type size: str
:param tier: The tier of the SKU, such as "Basic", "General Purpose", or
"Business Critical"
:type tier: str
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'family': {'key': 'family', 'type': 'str'},
'size': {'key': 'size', 'type': 'str'},
'tier': {'key': 'tier', 'type': 'str'},
}
def __init__(self, *, name: str=None, family: str=None, size: str=None, tier: str=None, **kwargs) -> None:
super(AvailableServiceSkuSku, self).__init__(**kwargs)
self.name = name
self.family = family
self.size = size
self.tier = tier
[docs]class AzureActiveDirectoryApp(Model):
"""Azure Active Directory Application.
All required parameters must be populated in order to send to Azure.
:param application_id: Required. Application ID of the Azure Active
Directory Application
:type application_id: str
:param app_key: Required. Key used to authenticate to the Azure Active
Directory Application
:type app_key: str
:param tenant_id: Required. Tenant id of the customer
:type tenant_id: str
"""
_validation = {
'application_id': {'required': True},
'app_key': {'required': True},
'tenant_id': {'required': True},
}
_attribute_map = {
'application_id': {'key': 'applicationId', 'type': 'str'},
'app_key': {'key': 'appKey', 'type': 'str'},
'tenant_id': {'key': 'tenantId', 'type': 'str'},
}
def __init__(self, *, application_id: str, app_key: str, tenant_id: str, **kwargs) -> None:
super(AzureActiveDirectoryApp, self).__init__(**kwargs)
self.application_id = application_id
self.app_key = app_key
self.tenant_id = tenant_id
[docs]class BackupFileInfo(Model):
"""Information of the backup file.
:param file_location: Location of the backup file in shared folder
:type file_location: str
:param family_sequence_number: Sequence number of the backup file in the
backup set
:type family_sequence_number: int
:param status: Status of the backup file during migration. Possible values
include: 'Arrived', 'Queued', 'Uploading', 'Uploaded', 'Restoring',
'Restored', 'Cancelled'
:type status: str or ~azure.mgmt.datamigration.models.BackupFileStatus
"""
_attribute_map = {
'file_location': {'key': 'fileLocation', 'type': 'str'},
'family_sequence_number': {'key': 'familySequenceNumber', 'type': 'int'},
'status': {'key': 'status', 'type': 'str'},
}
def __init__(self, *, file_location: str=None, family_sequence_number: int=None, status=None, **kwargs) -> None:
super(BackupFileInfo, self).__init__(**kwargs)
self.file_location = file_location
self.family_sequence_number = family_sequence_number
self.status = status
[docs]class BackupSetInfo(Model):
"""Information of backup set.
:param backup_set_id: Id for the set of backup files
:type backup_set_id: str
:param first_lsn: First log sequence number of the backup file
:type first_lsn: str
:param last_lsn: Last log sequence number of the backup file
:type last_lsn: str
:param last_modified_time: Last modified time of the backup file in share
location
:type last_modified_time: datetime
:param backup_type: Enum of the different backup types. Possible values
include: 'Database', 'TransactionLog', 'File', 'DifferentialDatabase',
'DifferentialFile', 'Partial', 'DifferentialPartial'
:type backup_type: str or ~azure.mgmt.datamigration.models.BackupType
:param list_of_backup_files: List of files in the backup set
:type list_of_backup_files:
list[~azure.mgmt.datamigration.models.BackupFileInfo]
:param database_name: Name of the database to which the backup set belongs
:type database_name: str
:param backup_start_date: Date and time that the backup operation began
:type backup_start_date: datetime
:param backup_finished_date: Date and time that the backup operation
finished
:type backup_finished_date: datetime
:param is_backup_restored: Whether the backup set is restored or not
:type is_backup_restored: bool
"""
_attribute_map = {
'backup_set_id': {'key': 'backupSetId', 'type': 'str'},
'first_lsn': {'key': 'firstLsn', 'type': 'str'},
'last_lsn': {'key': 'lastLsn', 'type': 'str'},
'last_modified_time': {'key': 'lastModifiedTime', 'type': 'iso-8601'},
'backup_type': {'key': 'backupType', 'type': 'str'},
'list_of_backup_files': {'key': 'listOfBackupFiles', 'type': '[BackupFileInfo]'},
'database_name': {'key': 'databaseName', 'type': 'str'},
'backup_start_date': {'key': 'backupStartDate', 'type': 'iso-8601'},
'backup_finished_date': {'key': 'backupFinishedDate', 'type': 'iso-8601'},
'is_backup_restored': {'key': 'isBackupRestored', 'type': 'bool'},
}
def __init__(self, *, backup_set_id: str=None, first_lsn: str=None, last_lsn: str=None, last_modified_time=None, backup_type=None, list_of_backup_files=None, database_name: str=None, backup_start_date=None, backup_finished_date=None, is_backup_restored: bool=None, **kwargs) -> None:
super(BackupSetInfo, self).__init__(**kwargs)
self.backup_set_id = backup_set_id
self.first_lsn = first_lsn
self.last_lsn = last_lsn
self.last_modified_time = last_modified_time
self.backup_type = backup_type
self.list_of_backup_files = list_of_backup_files
self.database_name = database_name
self.backup_start_date = backup_start_date
self.backup_finished_date = backup_finished_date
self.is_backup_restored = is_backup_restored
[docs]class BlobShare(Model):
"""Blob container storage information.
All required parameters must be populated in order to send to Azure.
:param sas_uri: Required. SAS URI of Azure Storage Account Container.
:type sas_uri: str
"""
_validation = {
'sas_uri': {'required': True},
}
_attribute_map = {
'sas_uri': {'key': 'sasUri', 'type': 'str'},
}
def __init__(self, *, sas_uri: str, **kwargs) -> None:
super(BlobShare, self).__init__(**kwargs)
self.sas_uri = sas_uri
[docs]class CheckOCIDriverTaskOutput(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.
:param installed_driver: Information about the installed driver if found
and valid.
:type installed_driver:
~azure.mgmt.datamigration.models.OracleOCIDriverInfo
:ivar validation_errors: Validation errors
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'validation_errors': {'readonly': True},
}
_attribute_map = {
'installed_driver': {'key': 'installedDriver', 'type': 'OracleOCIDriverInfo'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, *, installed_driver=None, **kwargs) -> None:
super(CheckOCIDriverTaskOutput, self).__init__(**kwargs)
self.installed_driver = installed_driver
self.validation_errors = None
[docs]class ProjectTaskProperties(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: MigrateSsisTaskProperties,
GetTdeCertificatesSqlTaskProperties,
ValidateOracleAzureDbForPostgreSqlSyncTaskProperties,
ValidateMongoDbTaskProperties,
ValidateMigrationInputSqlServerSqlMISyncTaskProperties,
ValidateMigrationInputSqlServerSqlMITaskProperties,
ValidateMigrationInputSqlServerSqlDbSyncTaskProperties,
MigrateOracleAzureDbForPostgreSqlSyncTaskProperties,
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties,
MigrateMySqlAzureDbForMySqlSyncTaskProperties,
MigrateSqlServerSqlDbSyncTaskProperties,
MigrateSqlServerSqlDbTaskProperties,
MigrateSqlServerSqlMISyncTaskProperties,
MigrateSqlServerSqlMITaskProperties, MigrateMongoDbTaskProperties,
ConnectToTargetAzureDbForMySqlTaskProperties,
ConnectToTargetSqlMISyncTaskProperties, ConnectToTargetSqlMITaskProperties,
GetUserTablesPostgreSqlTaskProperties, GetUserTablesOracleTaskProperties,
GetUserTablesSqlSyncTaskProperties, GetUserTablesSqlTaskProperties,
ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties,
ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties,
ConnectToTargetSqlSqlDbSyncTaskProperties,
ConnectToTargetSqlDbTaskProperties,
ConnectToSourceOracleSyncTaskProperties,
ConnectToSourcePostgreSqlSyncTaskProperties,
ConnectToSourceSqlServerSyncTaskProperties,
ConnectToSourceSqlServerTaskProperties, ConnectToMongoDbTaskProperties,
ConnectToSourceMySqlTaskProperties,
MigrateSchemaSqlServerSqlDbTaskProperties, CheckOCIDriverTaskProperties,
UploadOCIDriverTaskProperties, InstallOCIDriverTaskProperties
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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
}
_subtype_map = {
'task_type': {'Migrate.Ssis': 'MigrateSsisTaskProperties', 'GetTDECertificates.Sql': 'GetTdeCertificatesSqlTaskProperties', 'Validate.Oracle.AzureDbPostgreSql.Sync': 'ValidateOracleAzureDbForPostgreSqlSyncTaskProperties', 'Validate.MongoDb': 'ValidateMongoDbTaskProperties', 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS': 'ValidateMigrationInputSqlServerSqlMISyncTaskProperties', 'ValidateMigrationInput.SqlServer.AzureSqlDbMI': 'ValidateMigrationInputSqlServerSqlMITaskProperties', 'ValidateMigrationInput.SqlServer.SqlDb.Sync': 'ValidateMigrationInputSqlServerSqlDbSyncTaskProperties', 'Migrate.Oracle.AzureDbForPostgreSql.Sync': 'MigrateOracleAzureDbForPostgreSqlSyncTaskProperties', 'Migrate.PostgreSql.AzureDbForPostgreSql.Sync': 'MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties', 'Migrate.MySql.AzureDbForMySql.Sync': 'MigrateMySqlAzureDbForMySqlSyncTaskProperties', 'Migrate.SqlServer.AzureSqlDb.Sync': 'MigrateSqlServerSqlDbSyncTaskProperties', 'Migrate.SqlServer.SqlDb': 'MigrateSqlServerSqlDbTaskProperties', 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS': 'MigrateSqlServerSqlMISyncTaskProperties', 'Migrate.SqlServer.AzureSqlDbMI': 'MigrateSqlServerSqlMITaskProperties', 'Migrate.MongoDb': 'MigrateMongoDbTaskProperties', 'ConnectToTarget.AzureDbForMySql': 'ConnectToTargetAzureDbForMySqlTaskProperties', 'ConnectToTarget.AzureSqlDbMI.Sync.LRS': 'ConnectToTargetSqlMISyncTaskProperties', 'ConnectToTarget.AzureSqlDbMI': 'ConnectToTargetSqlMITaskProperties', 'GetUserTablesPostgreSql': 'GetUserTablesPostgreSqlTaskProperties', 'GetUserTablesOracle': 'GetUserTablesOracleTaskProperties', 'GetUserTables.AzureSqlDb.Sync': 'GetUserTablesSqlSyncTaskProperties', 'GetUserTables.Sql': 'GetUserTablesSqlTaskProperties', 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync': 'ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties', 'ConnectToTarget.AzureDbForPostgreSql.Sync': 'ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties', 'ConnectToTarget.SqlDb.Sync': 'ConnectToTargetSqlSqlDbSyncTaskProperties', 'ConnectToTarget.SqlDb': 'ConnectToTargetSqlDbTaskProperties', 'ConnectToSource.Oracle.Sync': 'ConnectToSourceOracleSyncTaskProperties', 'ConnectToSource.PostgreSql.Sync': 'ConnectToSourcePostgreSqlSyncTaskProperties', 'ConnectToSource.SqlServer.Sync': 'ConnectToSourceSqlServerSyncTaskProperties', 'ConnectToSource.SqlServer': 'ConnectToSourceSqlServerTaskProperties', 'Connect.MongoDb': 'ConnectToMongoDbTaskProperties', 'ConnectToSource.MySql': 'ConnectToSourceMySqlTaskProperties', 'MigrateSchemaSqlServerSqlDb': 'MigrateSchemaSqlServerSqlDbTaskProperties', 'Service.Check.OCI': 'CheckOCIDriverTaskProperties', 'Service.Upload.OCI': 'UploadOCIDriverTaskProperties', 'Service.Install.OCI': 'InstallOCIDriverTaskProperties'}
}
def __init__(self, *, client_data=None, **kwargs) -> None:
super(ProjectTaskProperties, self).__init__(**kwargs)
self.errors = None
self.state = None
self.commands = None
self.client_data = client_data
self.task_type = None
[docs]class CheckOCIDriverTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input:
:type input: ~azure.mgmt.datamigration.models.CheckOCIDriverTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.CheckOCIDriverTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'CheckOCIDriverTaskInput'},
'output': {'key': 'output', 'type': '[CheckOCIDriverTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(CheckOCIDriverTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Service.Check.OCI'
class CloudError(Model):
"""CloudError.
"""
_attribute_map = {
}
[docs]class CommandProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the command. This is ignored if submitted.
Possible values include: 'Unknown', 'Accepted', 'Running', 'Succeeded',
'Failed'
:vartype state: str or ~azure.mgmt.datamigration.models.CommandState
:param command_type: Required. Constant filled by server.
:type command_type: str
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'command_type': {'required': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'command_type': {'key': 'commandType', 'type': 'str'},
}
_subtype_map = {
'command_type': {'Migrate.SqlServer.AzureDbSqlMi.Complete': 'MigrateMISyncCompleteCommandProperties', 'Migrate.Sync.Complete.Database': 'MigrateSyncCompleteCommandProperties', 'cancel': 'MongoDbCancelCommand', 'finish': 'MongoDbFinishCommand', 'restart': 'MongoDbRestartCommand'}
}
def __init__(self, **kwargs) -> None:
super(CommandProperties, self).__init__(**kwargs)
self.errors = None
self.state = None
self.command_type = None
[docs]class ConnectionInfo(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, PostgreSqlConnectionInfo,
OracleConnectionInfo, MySqlConnectionInfo, MongoDbConnectionInfo,
SqlConnectionInfo
All required parameters must be populated in order to send to Azure.
:param user_name: User name
:type user_name: str
:param password: Password credential.
:type password: str
:param type: Required. Constant filled by server.
:type type: str
"""
_validation = {
'type': {'required': True},
}
_attribute_map = {
'user_name': {'key': 'userName', 'type': 'str'},
'password': {'key': 'password', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
_subtype_map = {
'type': {'MiSqlConnectionInfo': 'MiSqlConnectionInfo', 'PostgreSqlConnectionInfo': 'PostgreSqlConnectionInfo', 'OracleConnectionInfo': 'OracleConnectionInfo', 'MySqlConnectionInfo': 'MySqlConnectionInfo', 'MongoDbConnectionInfo': 'MongoDbConnectionInfo', 'SqlConnectionInfo': 'SqlConnectionInfo'}
}
def __init__(self, *, user_name: str=None, password: str=None, **kwargs) -> None:
super(ConnectionInfo, self).__init__(**kwargs)
self.user_name = user_name
self.password = password
self.type = None
[docs]class ConnectToMongoDbTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input:
:type input: ~azure.mgmt.datamigration.models.MongoDbConnectionInfo
:ivar output: An array containing a single MongoDbClusterInfo object
:vartype output: list[~azure.mgmt.datamigration.models.MongoDbClusterInfo]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MongoDbConnectionInfo'},
'output': {'key': 'output', 'type': '[MongoDbClusterInfo]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ConnectToMongoDbTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Connect.MongoDb'
[docs]class ConnectToSourceMySqlTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.ConnectToSourceMySqlTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.ConnectToSourceNonSqlTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'ConnectToSourceMySqlTaskInput'},
'output': {'key': 'output', 'type': '[ConnectToSourceNonSqlTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ConnectToSourceMySqlTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'ConnectToSource.MySql'
[docs]class ConnectToSourceNonSqlTaskOutput(Model):
"""Output for connect to MySQL type source.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Result identifier
:vartype id: str
:ivar source_server_brand_version: Server brand version
:vartype source_server_brand_version: str
:ivar server_properties: Server properties
:vartype server_properties:
~azure.mgmt.datamigration.models.ServerProperties
:ivar databases: List of databases on the server
:vartype databases: list[str]
:ivar validation_errors: Validation errors associated with the task
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'source_server_brand_version': {'readonly': True},
'server_properties': {'readonly': True},
'databases': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'source_server_brand_version': {'key': 'sourceServerBrandVersion', 'type': 'str'},
'server_properties': {'key': 'serverProperties', 'type': 'ServerProperties'},
'databases': {'key': 'databases', 'type': '[str]'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(ConnectToSourceNonSqlTaskOutput, self).__init__(**kwargs)
self.id = None
self.source_server_brand_version = None
self.server_properties = None
self.databases = None
self.validation_errors = None
[docs]class ConnectToSourceOracleSyncTaskOutput(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.
:ivar source_server_version: Version of the source server
:vartype source_server_version: str
:ivar databases: List of schemas on source server
:vartype databases: list[str]
:ivar source_server_brand_version: Source server brand version
:vartype source_server_brand_version: str
:ivar validation_errors: Validation errors associated with the task
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'source_server_version': {'readonly': True},
'databases': {'readonly': True},
'source_server_brand_version': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'source_server_version': {'key': 'sourceServerVersion', 'type': 'str'},
'databases': {'key': 'databases', 'type': '[str]'},
'source_server_brand_version': {'key': 'sourceServerBrandVersion', 'type': 'str'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(ConnectToSourceOracleSyncTaskOutput, self).__init__(**kwargs)
self.source_server_version = None
self.databases = None
self.source_server_brand_version = None
self.validation_errors = None
[docs]class ConnectToSourceOracleSyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.ConnectToSourceOracleSyncTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.ConnectToSourceOracleSyncTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'ConnectToSourceOracleSyncTaskInput'},
'output': {'key': 'output', 'type': '[ConnectToSourceOracleSyncTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ConnectToSourceOracleSyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'ConnectToSource.Oracle.Sync'
[docs]class ConnectToSourcePostgreSqlSyncTaskInput(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.
:param source_connection_info: Required. Connection information for source
PostgreSQL server
:type source_connection_info:
~azure.mgmt.datamigration.models.PostgreSqlConnectionInfo
"""
_validation = {
'source_connection_info': {'required': True},
}
_attribute_map = {
'source_connection_info': {'key': 'sourceConnectionInfo', 'type': 'PostgreSqlConnectionInfo'},
}
def __init__(self, *, source_connection_info, **kwargs) -> None:
super(ConnectToSourcePostgreSqlSyncTaskInput, self).__init__(**kwargs)
self.source_connection_info = source_connection_info
[docs]class ConnectToSourcePostgreSqlSyncTaskOutput(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.
:ivar id: Result identifier
:vartype id: str
:ivar source_server_version: Version of the source server
:vartype source_server_version: str
:ivar databases: List of databases on source server
:vartype databases: list[str]
:ivar source_server_brand_version: Source server brand version
:vartype source_server_brand_version: str
:ivar validation_errors: Validation errors associated with the task
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'source_server_version': {'readonly': True},
'databases': {'readonly': True},
'source_server_brand_version': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'source_server_version': {'key': 'sourceServerVersion', 'type': 'str'},
'databases': {'key': 'databases', 'type': '[str]'},
'source_server_brand_version': {'key': 'sourceServerBrandVersion', 'type': 'str'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(ConnectToSourcePostgreSqlSyncTaskOutput, self).__init__(**kwargs)
self.id = None
self.source_server_version = None
self.databases = None
self.source_server_brand_version = None
self.validation_errors = None
[docs]class ConnectToSourcePostgreSqlSyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.ConnectToSourcePostgreSqlSyncTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.ConnectToSourcePostgreSqlSyncTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'ConnectToSourcePostgreSqlSyncTaskInput'},
'output': {'key': 'output', 'type': '[ConnectToSourcePostgreSqlSyncTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ConnectToSourcePostgreSqlSyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'ConnectToSource.PostgreSql.Sync'
[docs]class ConnectToSourceSqlServerSyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.ConnectToSourceSqlServerTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.ConnectToSourceSqlServerTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'ConnectToSourceSqlServerTaskInput'},
'output': {'key': 'output', 'type': '[ConnectToSourceSqlServerTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ConnectToSourceSqlServerSyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'ConnectToSource.SqlServer.Sync'
[docs]class ConnectToSourceSqlServerTaskOutput(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,
ConnectToSourceSqlServerTaskOutputLoginLevel,
ConnectToSourceSqlServerTaskOutputDatabaseLevel,
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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
}
_subtype_map = {
'result_type': {'AgentJobLevelOutput': 'ConnectToSourceSqlServerTaskOutputAgentJobLevel', 'LoginLevelOutput': 'ConnectToSourceSqlServerTaskOutputLoginLevel', 'DatabaseLevelOutput': 'ConnectToSourceSqlServerTaskOutputDatabaseLevel', 'TaskLevelOutput': 'ConnectToSourceSqlServerTaskOutputTaskLevel'}
}
def __init__(self, **kwargs) -> None:
super(ConnectToSourceSqlServerTaskOutput, self).__init__(**kwargs)
self.id = None
self.result_type = None
[docs]class ConnectToSourceSqlServerTaskOutputAgentJobLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar name: Agent Job name
:vartype name: str
:ivar job_category: The type of Agent Job.
:vartype job_category: str
:ivar is_enabled: The state of the original Agent Job.
:vartype is_enabled: bool
:ivar job_owner: The owner of the Agent Job
:vartype job_owner: str
:ivar last_executed_on: UTC Date and time when the Agent Job was last
executed.
:vartype last_executed_on: datetime
:ivar validation_errors: Validation errors
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
:ivar migration_eligibility: Information about eligibility of agent job
for migration.
:vartype migration_eligibility:
~azure.mgmt.datamigration.models.MigrationEligibilityInfo
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'name': {'readonly': True},
'job_category': {'readonly': True},
'is_enabled': {'readonly': True},
'job_owner': {'readonly': True},
'last_executed_on': {'readonly': True},
'validation_errors': {'readonly': True},
'migration_eligibility': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'job_category': {'key': 'jobCategory', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
'job_owner': {'key': 'jobOwner', 'type': 'str'},
'last_executed_on': {'key': 'lastExecutedOn', 'type': 'iso-8601'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
'migration_eligibility': {'key': 'migrationEligibility', 'type': 'MigrationEligibilityInfo'},
}
def __init__(self, **kwargs) -> None:
super(ConnectToSourceSqlServerTaskOutputAgentJobLevel, self).__init__(**kwargs)
self.name = None
self.job_category = None
self.is_enabled = None
self.job_owner = None
self.last_executed_on = None
self.validation_errors = None
self.migration_eligibility = None
self.result_type = 'AgentJobLevelOutput'
[docs]class ConnectToSourceSqlServerTaskOutputDatabaseLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar name: Database name
:vartype name: str
:ivar size_mb: Size of the file in megabytes
:vartype size_mb: float
:ivar database_files: The list of database files
:vartype database_files:
list[~azure.mgmt.datamigration.models.DatabaseFileInfo]
:ivar compatibility_level: SQL Server compatibility level of database.
Possible values include: 'CompatLevel80', 'CompatLevel90',
'CompatLevel100', 'CompatLevel110', 'CompatLevel120', 'CompatLevel130',
'CompatLevel140'
:vartype compatibility_level: str or
~azure.mgmt.datamigration.models.DatabaseCompatLevel
:ivar database_state: State of the database. Possible values include:
'Online', 'Restoring', 'Recovering', 'RecoveryPending', 'Suspect',
'Emergency', 'Offline', 'Copying', 'OfflineSecondary'
:vartype database_state: str or
~azure.mgmt.datamigration.models.DatabaseState
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'name': {'readonly': True},
'size_mb': {'readonly': True},
'database_files': {'readonly': True},
'compatibility_level': {'readonly': True},
'database_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'size_mb': {'key': 'sizeMB', 'type': 'float'},
'database_files': {'key': 'databaseFiles', 'type': '[DatabaseFileInfo]'},
'compatibility_level': {'key': 'compatibilityLevel', 'type': 'str'},
'database_state': {'key': 'databaseState', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ConnectToSourceSqlServerTaskOutputDatabaseLevel, self).__init__(**kwargs)
self.name = None
self.size_mb = None
self.database_files = None
self.compatibility_level = None
self.database_state = None
self.result_type = 'DatabaseLevelOutput'
[docs]class ConnectToSourceSqlServerTaskOutputLoginLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar name: Login name.
:vartype name: str
:ivar login_type: The type of login. Possible values include:
'WindowsUser', 'WindowsGroup', 'SqlLogin', 'Certificate', 'AsymmetricKey',
'ExternalUser', 'ExternalGroup'
:vartype login_type: str or ~azure.mgmt.datamigration.models.LoginType
:ivar default_database: The default database for the login.
:vartype default_database: str
:ivar is_enabled: The state of the login.
:vartype is_enabled: bool
:ivar migration_eligibility: Information about eligibility of login for
migration.
:vartype migration_eligibility:
~azure.mgmt.datamigration.models.MigrationEligibilityInfo
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'name': {'readonly': True},
'login_type': {'readonly': True},
'default_database': {'readonly': True},
'is_enabled': {'readonly': True},
'migration_eligibility': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'login_type': {'key': 'loginType', 'type': 'str'},
'default_database': {'key': 'defaultDatabase', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
'migration_eligibility': {'key': 'migrationEligibility', 'type': 'MigrationEligibilityInfo'},
}
def __init__(self, **kwargs) -> None:
super(ConnectToSourceSqlServerTaskOutputLoginLevel, self).__init__(**kwargs)
self.name = None
self.login_type = None
self.default_database = None
self.is_enabled = None
self.migration_eligibility = None
self.result_type = 'LoginLevelOutput'
[docs]class ConnectToSourceSqlServerTaskOutputTaskLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar databases: Source databases as a map from database name to database
id
:vartype databases: dict[str, str]
:ivar logins: Source logins as a map from login name to login id.
:vartype logins: dict[str, str]
:ivar agent_jobs: Source agent jobs as a map from agent job name to id.
:vartype agent_jobs: dict[str, str]
:ivar database_tde_certificate_mapping: Mapping from database name to TDE
certificate name, if applicable
:vartype database_tde_certificate_mapping: dict[str, str]
:ivar source_server_version: Source server version
:vartype source_server_version: str
:ivar source_server_brand_version: Source server brand version
:vartype source_server_brand_version: str
:ivar validation_errors: Validation errors
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'databases': {'readonly': True},
'logins': {'readonly': True},
'agent_jobs': {'readonly': True},
'database_tde_certificate_mapping': {'readonly': True},
'source_server_version': {'readonly': True},
'source_server_brand_version': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'databases': {'key': 'databases', 'type': '{str}'},
'logins': {'key': 'logins', 'type': '{str}'},
'agent_jobs': {'key': 'agentJobs', 'type': '{str}'},
'database_tde_certificate_mapping': {'key': 'databaseTdeCertificateMapping', 'type': '{str}'},
'source_server_version': {'key': 'sourceServerVersion', 'type': 'str'},
'source_server_brand_version': {'key': 'sourceServerBrandVersion', 'type': 'str'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(ConnectToSourceSqlServerTaskOutputTaskLevel, self).__init__(**kwargs)
self.databases = None
self.logins = None
self.agent_jobs = None
self.database_tde_certificate_mapping = None
self.source_server_version = None
self.source_server_brand_version = None
self.validation_errors = None
self.result_type = 'TaskLevelOutput'
[docs]class ConnectToSourceSqlServerTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.ConnectToSourceSqlServerTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.ConnectToSourceSqlServerTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'ConnectToSourceSqlServerTaskInput'},
'output': {'key': 'output', 'type': '[ConnectToSourceSqlServerTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ConnectToSourceSqlServerTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'ConnectToSource.SqlServer'
[docs]class ConnectToTargetAzureDbForPostgreSqlSyncTaskInput(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.
:param source_connection_info: Required. Connection information for source
PostgreSQL server
:type source_connection_info:
~azure.mgmt.datamigration.models.PostgreSqlConnectionInfo
:param target_connection_info: Required. Connection information for target
Azure Database for PostgreSQL server
:type target_connection_info:
~azure.mgmt.datamigration.models.PostgreSqlConnectionInfo
"""
_validation = {
'source_connection_info': {'required': True},
'target_connection_info': {'required': True},
}
_attribute_map = {
'source_connection_info': {'key': 'sourceConnectionInfo', 'type': 'PostgreSqlConnectionInfo'},
'target_connection_info': {'key': 'targetConnectionInfo', 'type': 'PostgreSqlConnectionInfo'},
}
def __init__(self, *, source_connection_info, target_connection_info, **kwargs) -> None:
super(ConnectToTargetAzureDbForPostgreSqlSyncTaskInput, self).__init__(**kwargs)
self.source_connection_info = source_connection_info
self.target_connection_info = target_connection_info
[docs]class ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput(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.
:ivar id: Result identifier
:vartype id: str
:ivar target_server_version: Version of the target server
:vartype target_server_version: str
:ivar databases: List of databases on target server
:vartype databases: list[str]
:ivar target_server_brand_version: Target server brand version
:vartype target_server_brand_version: str
:ivar validation_errors: Validation errors associated with the task
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'target_server_version': {'readonly': True},
'databases': {'readonly': True},
'target_server_brand_version': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'databases': {'key': 'databases', 'type': '[str]'},
'target_server_brand_version': {'key': 'targetServerBrandVersion', 'type': 'str'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput, self).__init__(**kwargs)
self.id = None
self.target_server_version = None
self.databases = None
self.target_server_brand_version = None
self.validation_errors = None
[docs]class ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.ConnectToTargetAzureDbForPostgreSqlSyncTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'ConnectToTargetAzureDbForPostgreSqlSyncTaskInput'},
'output': {'key': 'output', 'type': '[ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'ConnectToTarget.AzureDbForPostgreSql.Sync'
[docs]class ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput(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.
:param target_connection_info: Required. Connection information for target
Azure Database for PostgreSQL server
:type target_connection_info:
~azure.mgmt.datamigration.models.PostgreSqlConnectionInfo
"""
_validation = {
'target_connection_info': {'required': True},
}
_attribute_map = {
'target_connection_info': {'key': 'targetConnectionInfo', 'type': 'PostgreSqlConnectionInfo'},
}
def __init__(self, *, target_connection_info, **kwargs) -> None:
super(ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput, self).__init__(**kwargs)
self.target_connection_info = target_connection_info
[docs]class ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput(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.
:ivar target_server_version: Version of the target server
:vartype target_server_version: str
:ivar databases: List of databases on target server
:vartype databases: list[str]
:ivar target_server_brand_version: Target server brand version
:vartype target_server_brand_version: str
:ivar validation_errors: Validation errors associated with the task
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
:param database_schema_map: Mapping of schemas per database
:type database_schema_map:
list[~azure.mgmt.datamigration.models.ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem]
"""
_validation = {
'target_server_version': {'readonly': True},
'databases': {'readonly': True},
'target_server_brand_version': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'databases': {'key': 'databases', 'type': '[str]'},
'target_server_brand_version': {'key': 'targetServerBrandVersion', 'type': 'str'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
'database_schema_map': {'key': 'databaseSchemaMap', 'type': '[ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem]'},
}
def __init__(self, *, database_schema_map=None, **kwargs) -> None:
super(ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput, self).__init__(**kwargs)
self.target_server_version = None
self.databases = None
self.target_server_brand_version = None
self.validation_errors = None
self.database_schema_map = database_schema_map
[docs]class ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem(Model):
"""ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem.
:param database:
:type database: str
:param schemas:
:type schemas: list[str]
"""
_attribute_map = {
'database': {'key': 'database', 'type': 'str'},
'schemas': {'key': 'schemas', 'type': '[str]'},
}
def __init__(self, *, database: str=None, schemas=None, **kwargs) -> None:
super(ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem, self).__init__(**kwargs)
self.database = database
self.schemas = schemas
[docs]class ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput'},
'output': {'key': 'output', 'type': '[ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync'
[docs]class ConnectToTargetSqlDbTaskOutput(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.
:ivar id: Result identifier
:vartype id: str
:ivar databases: Source databases as a map from database name to database
id
:vartype databases: dict[str, str]
:ivar target_server_version: Version of the target server
:vartype target_server_version: str
:ivar target_server_brand_version: Target server brand version
:vartype target_server_brand_version: str
"""
_validation = {
'id': {'readonly': True},
'databases': {'readonly': True},
'target_server_version': {'readonly': True},
'target_server_brand_version': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'databases': {'key': 'databases', 'type': '{str}'},
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'target_server_brand_version': {'key': 'targetServerBrandVersion', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ConnectToTargetSqlDbTaskOutput, self).__init__(**kwargs)
self.id = None
self.databases = None
self.target_server_version = None
self.target_server_brand_version = None
[docs]class ConnectToTargetSqlDbTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.ConnectToTargetSqlDbTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.ConnectToTargetSqlDbTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'ConnectToTargetSqlDbTaskInput'},
'output': {'key': 'output', 'type': '[ConnectToTargetSqlDbTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ConnectToTargetSqlDbTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'ConnectToTarget.SqlDb'
[docs]class ConnectToTargetSqlMISyncTaskOutput(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.
:ivar target_server_version: Target server version
:vartype target_server_version: str
:ivar target_server_brand_version: Target server brand version
:vartype target_server_brand_version: str
:ivar validation_errors: Validation errors
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'target_server_version': {'readonly': True},
'target_server_brand_version': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'target_server_brand_version': {'key': 'targetServerBrandVersion', 'type': 'str'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(ConnectToTargetSqlMISyncTaskOutput, self).__init__(**kwargs)
self.target_server_version = None
self.target_server_brand_version = None
self.validation_errors = None
[docs]class ConnectToTargetSqlMISyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.ConnectToTargetSqlMISyncTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.ConnectToTargetSqlMISyncTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'ConnectToTargetSqlMISyncTaskInput'},
'output': {'key': 'output', 'type': '[ConnectToTargetSqlMISyncTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ConnectToTargetSqlMISyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'ConnectToTarget.AzureSqlDbMI.Sync.LRS'
[docs]class ConnectToTargetSqlMITaskOutput(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.
:ivar id: Result identifier
:vartype id: str
:ivar target_server_version: Target server version
:vartype target_server_version: str
:ivar target_server_brand_version: Target server brand version
:vartype target_server_brand_version: str
:ivar logins: List of logins on the target server.
:vartype logins: list[str]
:ivar agent_jobs: List of agent jobs on the target server.
:vartype agent_jobs: list[str]
:ivar validation_errors: Validation errors
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'target_server_version': {'readonly': True},
'target_server_brand_version': {'readonly': True},
'logins': {'readonly': True},
'agent_jobs': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'target_server_brand_version': {'key': 'targetServerBrandVersion', 'type': 'str'},
'logins': {'key': 'logins', 'type': '[str]'},
'agent_jobs': {'key': 'agentJobs', 'type': '[str]'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(ConnectToTargetSqlMITaskOutput, self).__init__(**kwargs)
self.id = None
self.target_server_version = None
self.target_server_brand_version = None
self.logins = None
self.agent_jobs = None
self.validation_errors = None
[docs]class ConnectToTargetSqlMITaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.ConnectToTargetSqlMITaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.ConnectToTargetSqlMITaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'ConnectToTargetSqlMITaskInput'},
'output': {'key': 'output', 'type': '[ConnectToTargetSqlMITaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ConnectToTargetSqlMITaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'ConnectToTarget.AzureSqlDbMI'
[docs]class ConnectToTargetSqlSqlDbSyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.ConnectToTargetSqlSqlDbSyncTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.ConnectToTargetSqlDbTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'ConnectToTargetSqlSqlDbSyncTaskInput'},
'output': {'key': 'output', 'type': '[ConnectToTargetSqlDbTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ConnectToTargetSqlSqlDbSyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'ConnectToTarget.SqlDb.Sync'
[docs]class Database(Model):
"""Information about a single database.
:param id: Unique identifier for the database
:type id: str
:param name: Name of the database
:type name: str
:param compatibility_level: SQL Server compatibility level of database.
Possible values include: 'CompatLevel80', 'CompatLevel90',
'CompatLevel100', 'CompatLevel110', 'CompatLevel120', 'CompatLevel130',
'CompatLevel140'
:type compatibility_level: str or
~azure.mgmt.datamigration.models.DatabaseCompatLevel
:param collation: Collation name of the database
:type collation: str
:param server_name: Name of the server
:type server_name: str
:param fqdn: Fully qualified name
:type fqdn: str
:param install_id: Install id of the database
:type install_id: str
:param server_version: Version of the server
:type server_version: str
:param server_edition: Edition of the server
:type server_edition: str
:param server_level: Product level of the server (RTM, SP, CTP).
:type server_level: str
:param server_default_data_path: Default path of the data files
:type server_default_data_path: str
:param server_default_log_path: Default path of the log files
:type server_default_log_path: str
:param server_default_backup_path: Default path of the backup folder
:type server_default_backup_path: str
:param server_core_count: Number of cores on the server
:type server_core_count: int
:param server_visible_online_core_count: Number of cores on the server
that have VISIBLE ONLINE status
:type server_visible_online_core_count: int
:param database_state: State of the database. Possible values include:
'Online', 'Restoring', 'Recovering', 'RecoveryPending', 'Suspect',
'Emergency', 'Offline', 'Copying', 'OfflineSecondary'
:type database_state: str or
~azure.mgmt.datamigration.models.DatabaseState
:param server_id: The unique Server Id
:type server_id: str
"""
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'compatibility_level': {'key': 'compatibilityLevel', 'type': 'str'},
'collation': {'key': 'collation', 'type': 'str'},
'server_name': {'key': 'serverName', 'type': 'str'},
'fqdn': {'key': 'fqdn', 'type': 'str'},
'install_id': {'key': 'installId', 'type': 'str'},
'server_version': {'key': 'serverVersion', 'type': 'str'},
'server_edition': {'key': 'serverEdition', 'type': 'str'},
'server_level': {'key': 'serverLevel', 'type': 'str'},
'server_default_data_path': {'key': 'serverDefaultDataPath', 'type': 'str'},
'server_default_log_path': {'key': 'serverDefaultLogPath', 'type': 'str'},
'server_default_backup_path': {'key': 'serverDefaultBackupPath', 'type': 'str'},
'server_core_count': {'key': 'serverCoreCount', 'type': 'int'},
'server_visible_online_core_count': {'key': 'serverVisibleOnlineCoreCount', 'type': 'int'},
'database_state': {'key': 'databaseState', 'type': 'str'},
'server_id': {'key': 'serverId', 'type': 'str'},
}
def __init__(self, *, id: str=None, name: str=None, compatibility_level=None, collation: str=None, server_name: str=None, fqdn: str=None, install_id: str=None, server_version: str=None, server_edition: str=None, server_level: str=None, server_default_data_path: str=None, server_default_log_path: str=None, server_default_backup_path: str=None, server_core_count: int=None, server_visible_online_core_count: int=None, database_state=None, server_id: str=None, **kwargs) -> None:
super(Database, self).__init__(**kwargs)
self.id = id
self.name = name
self.compatibility_level = compatibility_level
self.collation = collation
self.server_name = server_name
self.fqdn = fqdn
self.install_id = install_id
self.server_version = server_version
self.server_edition = server_edition
self.server_level = server_level
self.server_default_data_path = server_default_data_path
self.server_default_log_path = server_default_log_path
self.server_default_backup_path = server_default_backup_path
self.server_core_count = server_core_count
self.server_visible_online_core_count = server_visible_online_core_count
self.database_state = database_state
self.server_id = server_id
[docs]class DatabaseBackupInfo(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.
:ivar database_name: Database name.
:vartype database_name: str
:ivar backup_type: Backup Type. Possible values include: 'Database',
'TransactionLog', 'File', 'DifferentialDatabase', 'DifferentialFile',
'Partial', 'DifferentialPartial'
:vartype backup_type: str or ~azure.mgmt.datamigration.models.BackupType
:ivar backup_files: The list of backup files for the current database.
:vartype backup_files: list[str]
:ivar position: Position of current database backup in the file.
:vartype position: int
:ivar is_damaged: Database was damaged when backed up, but the backup
operation was requested to continue despite errors.
:vartype is_damaged: bool
:ivar is_compressed: Whether the backup set is compressed
:vartype is_compressed: bool
:ivar family_count: Number of files in the backup set.
:vartype family_count: int
:ivar backup_finish_date: Date and time when the backup operation
finished.
:vartype backup_finish_date: datetime
"""
_validation = {
'database_name': {'readonly': True},
'backup_type': {'readonly': True},
'backup_files': {'readonly': True},
'position': {'readonly': True},
'is_damaged': {'readonly': True},
'is_compressed': {'readonly': True},
'family_count': {'readonly': True},
'backup_finish_date': {'readonly': True},
}
_attribute_map = {
'database_name': {'key': 'databaseName', 'type': 'str'},
'backup_type': {'key': 'backupType', 'type': 'str'},
'backup_files': {'key': 'backupFiles', 'type': '[str]'},
'position': {'key': 'position', 'type': 'int'},
'is_damaged': {'key': 'isDamaged', 'type': 'bool'},
'is_compressed': {'key': 'isCompressed', 'type': 'bool'},
'family_count': {'key': 'familyCount', 'type': 'int'},
'backup_finish_date': {'key': 'backupFinishDate', 'type': 'iso-8601'},
}
def __init__(self, **kwargs) -> None:
super(DatabaseBackupInfo, self).__init__(**kwargs)
self.database_name = None
self.backup_type = None
self.backup_files = None
self.position = None
self.is_damaged = None
self.is_compressed = None
self.family_count = None
self.backup_finish_date = None
[docs]class DatabaseFileInfo(Model):
"""Database file specific information.
:param database_name: Name of the database
:type database_name: str
:param id: Unique identifier for database file
:type id: str
:param logical_name: Logical name of the file
:type logical_name: str
:param physical_full_name: Operating-system full path of the file
:type physical_full_name: str
:param restore_full_name: Suggested full path of the file for restoring
:type restore_full_name: str
:param file_type: Database file type. Possible values include: 'Rows',
'Log', 'Filestream', 'NotSupported', 'Fulltext'
:type file_type: str or ~azure.mgmt.datamigration.models.DatabaseFileType
:param size_mb: Size of the file in megabytes
:type size_mb: float
"""
_attribute_map = {
'database_name': {'key': 'databaseName', 'type': 'str'},
'id': {'key': 'id', 'type': 'str'},
'logical_name': {'key': 'logicalName', 'type': 'str'},
'physical_full_name': {'key': 'physicalFullName', 'type': 'str'},
'restore_full_name': {'key': 'restoreFullName', 'type': 'str'},
'file_type': {'key': 'fileType', 'type': 'str'},
'size_mb': {'key': 'sizeMB', 'type': 'float'},
}
def __init__(self, *, database_name: str=None, id: str=None, logical_name: str=None, physical_full_name: str=None, restore_full_name: str=None, file_type=None, size_mb: float=None, **kwargs) -> None:
super(DatabaseFileInfo, self).__init__(**kwargs)
self.database_name = database_name
self.id = id
self.logical_name = logical_name
self.physical_full_name = physical_full_name
self.restore_full_name = restore_full_name
self.file_type = file_type
self.size_mb = size_mb
[docs]class DatabaseInfo(Model):
"""Project Database Details.
All required parameters must be populated in order to send to Azure.
:param source_database_name: Required. Name of the database
:type source_database_name: str
"""
_validation = {
'source_database_name': {'required': True},
}
_attribute_map = {
'source_database_name': {'key': 'sourceDatabaseName', 'type': 'str'},
}
def __init__(self, *, source_database_name: str, **kwargs) -> None:
super(DatabaseInfo, self).__init__(**kwargs)
self.source_database_name = source_database_name
[docs]class DatabaseObjectName(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.
:ivar database_name: The unescaped name of the database containing the
object
:vartype database_name: str
:ivar object_name: The unescaped name of the object
:vartype object_name: str
:ivar schema_name: The unescaped name of the schema containing the object
:vartype schema_name: str
:param object_type: Type of the object in the database. Possible values
include: 'StoredProcedures', 'Table', 'User', 'View', 'Function'
:type object_type: str or ~azure.mgmt.datamigration.models.ObjectType
"""
_validation = {
'database_name': {'readonly': True},
'object_name': {'readonly': True},
'schema_name': {'readonly': True},
}
_attribute_map = {
'database_name': {'key': 'databaseName', 'type': 'str'},
'object_name': {'key': 'objectName', 'type': 'str'},
'schema_name': {'key': 'schemaName', 'type': 'str'},
'object_type': {'key': 'objectType', 'type': 'str'},
}
def __init__(self, *, object_type=None, **kwargs) -> None:
super(DatabaseObjectName, self).__init__(**kwargs)
self.database_name = None
self.object_name = None
self.schema_name = None
self.object_type = object_type
[docs]class DataItemMigrationSummaryResult(Model):
"""Basic summary of a data item migration.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar name: Name of the item
:vartype name: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar state: Current state of migration. Possible values include: 'None',
'InProgress', 'Failed', 'Warning', 'Completed', 'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar status_message: Status message
:vartype status_message: str
:ivar items_count: Number of items
:vartype items_count: long
:ivar items_completed_count: Number of successfully completed items
:vartype items_completed_count: long
:ivar error_prefix: Wildcard string prefix to use for querying all errors
of the item
:vartype error_prefix: str
:ivar result_prefix: Wildcard string prefix to use for querying all
sub-tem results of the item
:vartype result_prefix: str
"""
_validation = {
'name': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'state': {'readonly': True},
'status_message': {'readonly': True},
'items_count': {'readonly': True},
'items_completed_count': {'readonly': True},
'error_prefix': {'readonly': True},
'result_prefix': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'state': {'key': 'state', 'type': 'str'},
'status_message': {'key': 'statusMessage', 'type': 'str'},
'items_count': {'key': 'itemsCount', 'type': 'long'},
'items_completed_count': {'key': 'itemsCompletedCount', 'type': 'long'},
'error_prefix': {'key': 'errorPrefix', 'type': 'str'},
'result_prefix': {'key': 'resultPrefix', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(DataItemMigrationSummaryResult, self).__init__(**kwargs)
self.name = None
self.started_on = None
self.ended_on = None
self.state = None
self.status_message = None
self.items_count = None
self.items_completed_count = None
self.error_prefix = None
self.result_prefix = None
[docs]class DatabaseSummaryResult(DataItemMigrationSummaryResult):
"""Summary of database results in the migration.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar name: Name of the item
:vartype name: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar state: Current state of migration. Possible values include: 'None',
'InProgress', 'Failed', 'Warning', 'Completed', 'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar status_message: Status message
:vartype status_message: str
:ivar items_count: Number of items
:vartype items_count: long
:ivar items_completed_count: Number of successfully completed items
:vartype items_completed_count: long
:ivar error_prefix: Wildcard string prefix to use for querying all errors
of the item
:vartype error_prefix: str
:ivar result_prefix: Wildcard string prefix to use for querying all
sub-tem results of the item
:vartype result_prefix: str
:ivar size_mb: Size of the database in megabytes
:vartype size_mb: float
"""
_validation = {
'name': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'state': {'readonly': True},
'status_message': {'readonly': True},
'items_count': {'readonly': True},
'items_completed_count': {'readonly': True},
'error_prefix': {'readonly': True},
'result_prefix': {'readonly': True},
'size_mb': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'state': {'key': 'state', 'type': 'str'},
'status_message': {'key': 'statusMessage', 'type': 'str'},
'items_count': {'key': 'itemsCount', 'type': 'long'},
'items_completed_count': {'key': 'itemsCompletedCount', 'type': 'long'},
'error_prefix': {'key': 'errorPrefix', 'type': 'str'},
'result_prefix': {'key': 'resultPrefix', 'type': 'str'},
'size_mb': {'key': 'sizeMB', 'type': 'float'},
}
def __init__(self, **kwargs) -> None:
super(DatabaseSummaryResult, self).__init__(**kwargs)
self.size_mb = None
[docs]class DatabaseTable(Model):
"""Table properties.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar has_rows: Indicates whether table is empty or not
:vartype has_rows: bool
:ivar name: Schema-qualified name of the table
:vartype name: str
"""
_validation = {
'has_rows': {'readonly': True},
'name': {'readonly': True},
}
_attribute_map = {
'has_rows': {'key': 'hasRows', 'type': 'bool'},
'name': {'key': 'name', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(DatabaseTable, self).__init__(**kwargs)
self.has_rows = None
self.name = None
[docs]class DataIntegrityValidationResult(Model):
"""Results for checksum based Data Integrity validation results.
:param failed_objects: List of failed table names of source and target
pair
:type failed_objects: dict[str, str]
:param validation_errors: List of errors that happened while performing
data integrity validation
:type validation_errors: ~azure.mgmt.datamigration.models.ValidationError
"""
_attribute_map = {
'failed_objects': {'key': 'failedObjects', 'type': '{str}'},
'validation_errors': {'key': 'validationErrors', 'type': 'ValidationError'},
}
def __init__(self, *, failed_objects=None, validation_errors=None, **kwargs) -> None:
super(DataIntegrityValidationResult, self).__init__(**kwargs)
self.failed_objects = failed_objects
self.validation_errors = validation_errors
[docs]class DataMigrationError(Model):
"""Migration Task errors.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar message: Error description
:vartype message: str
:param type: Possible values include: 'Default', 'Warning', 'Error'
:type type: str or ~azure.mgmt.datamigration.models.ErrorType
"""
_validation = {
'message': {'readonly': True},
}
_attribute_map = {
'message': {'key': 'message', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(self, *, type=None, **kwargs) -> None:
super(DataMigrationError, self).__init__(**kwargs)
self.message = None
self.type = type
[docs]class Resource(Model):
"""ARM resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Resource ID.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(Resource, self).__init__(**kwargs)
self.id = None
self.name = None
self.type = None
[docs]class TrackedResource(Resource):
"""ARM tracked top level resource.
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.
:ivar id: Resource ID.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param tags: Resource tags.
:type tags: dict[str, str]
:param location: Required. Resource location.
:type location: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'location': {'key': 'location', 'type': 'str'},
}
def __init__(self, *, location: str, tags=None, **kwargs) -> None:
super(TrackedResource, self).__init__(**kwargs)
self.tags = tags
self.location = location
[docs]class DataMigrationService(TrackedResource):
"""A Database Migration Service resource.
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.
:ivar id: Resource ID.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param tags: Resource tags.
:type tags: dict[str, str]
:param location: Required. Resource location.
:type location: str
:param etag: HTTP strong entity tag value. Ignored if submitted
:type etag: str
:param kind: The resource kind. Only 'vm' (the default) is supported.
:type kind: str
:ivar provisioning_state: The resource's provisioning state. Possible
values include: 'Accepted', 'Deleting', 'Deploying', 'Stopped',
'Stopping', 'Starting', 'FailedToStart', 'FailedToStop', 'Succeeded',
'Failed'
:vartype provisioning_state: str or
~azure.mgmt.datamigration.models.ServiceProvisioningState
:param public_key: The public key of the service, used to encrypt secrets
sent to the service
:type public_key: str
:param virtual_subnet_id: Required. The ID of the
Microsoft.Network/virtualNetworks/subnets resource to which the service
should be joined
:type virtual_subnet_id: str
:param sku: Service SKU
:type sku: ~azure.mgmt.datamigration.models.ServiceSku
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'provisioning_state': {'readonly': True},
'virtual_subnet_id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'location': {'key': 'location', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'public_key': {'key': 'properties.publicKey', 'type': 'str'},
'virtual_subnet_id': {'key': 'properties.virtualSubnetId', 'type': 'str'},
'sku': {'key': 'sku', 'type': 'ServiceSku'},
}
def __init__(self, *, location: str, virtual_subnet_id: str, tags=None, etag: str=None, kind: str=None, public_key: str=None, sku=None, **kwargs) -> None:
super(DataMigrationService, self).__init__(tags=tags, location=location, **kwargs)
self.etag = etag
self.kind = kind
self.provisioning_state = None
self.public_key = public_key
self.virtual_subnet_id = virtual_subnet_id
self.sku = sku
[docs]class DataMigrationServiceStatusResponse(Model):
"""Service health status.
:param agent_version: The DMS instance agent version
:type agent_version: str
:param status: The machine-readable status, such as 'Initializing',
'Offline', 'Online', 'Deploying', 'Deleting', 'Stopped', 'Stopping',
'Starting', 'FailedToStart', 'FailedToStop' or 'Failed'
:type status: str
:param vm_size: The services virtual machine size, such as
'Standard_D2_v2'
:type vm_size: str
:param supported_task_types: The list of supported task types
:type supported_task_types: list[str]
"""
_attribute_map = {
'agent_version': {'key': 'agentVersion', 'type': 'str'},
'status': {'key': 'status', 'type': 'str'},
'vm_size': {'key': 'vmSize', 'type': 'str'},
'supported_task_types': {'key': 'supportedTaskTypes', 'type': '[str]'},
}
def __init__(self, *, agent_version: str=None, status: str=None, vm_size: str=None, supported_task_types=None, **kwargs) -> None:
super(DataMigrationServiceStatusResponse, self).__init__(**kwargs)
self.agent_version = agent_version
self.status = status
self.vm_size = vm_size
self.supported_task_types = supported_task_types
[docs]class ExecutionStatistics(Model):
"""Description about the errors happen while performing migration validation.
:param execution_count: No. of query executions
:type execution_count: long
:param cpu_time_ms: CPU Time in millisecond(s) for the query execution
:type cpu_time_ms: float
:param elapsed_time_ms: Time taken in millisecond(s) for executing the
query
:type elapsed_time_ms: float
:param wait_stats: Dictionary of sql query execution wait types and the
respective statistics
:type wait_stats: dict[str,
~azure.mgmt.datamigration.models.WaitStatistics]
:param has_errors: Indicates whether the query resulted in an error
:type has_errors: bool
:param sql_errors: List of sql Errors
:type sql_errors: list[str]
"""
_attribute_map = {
'execution_count': {'key': 'executionCount', 'type': 'long'},
'cpu_time_ms': {'key': 'cpuTimeMs', 'type': 'float'},
'elapsed_time_ms': {'key': 'elapsedTimeMs', 'type': 'float'},
'wait_stats': {'key': 'waitStats', 'type': '{WaitStatistics}'},
'has_errors': {'key': 'hasErrors', 'type': 'bool'},
'sql_errors': {'key': 'sqlErrors', 'type': '[str]'},
}
def __init__(self, *, execution_count: int=None, cpu_time_ms: float=None, elapsed_time_ms: float=None, wait_stats=None, has_errors: bool=None, sql_errors=None, **kwargs) -> None:
super(ExecutionStatistics, self).__init__(**kwargs)
self.execution_count = execution_count
self.cpu_time_ms = cpu_time_ms
self.elapsed_time_ms = elapsed_time_ms
self.wait_stats = wait_stats
self.has_errors = has_errors
self.sql_errors = sql_errors
[docs]class FileShare(Model):
"""File share information with Path, Username, and Password.
All required parameters must be populated in order to send to Azure.
:param user_name: User name credential to connect to the share location
:type user_name: str
:param password: Password credential used to connect to the share
location.
:type password: str
:param path: Required. The folder path for this share.
:type path: str
"""
_validation = {
'path': {'required': True},
}
_attribute_map = {
'user_name': {'key': 'userName', 'type': 'str'},
'password': {'key': 'password', 'type': 'str'},
'path': {'key': 'path', 'type': 'str'},
}
def __init__(self, *, path: str, user_name: str=None, password: str=None, **kwargs) -> None:
super(FileShare, self).__init__(**kwargs)
self.user_name = user_name
self.password = password
self.path = path
[docs]class FileStorageInfo(Model):
"""File storage information.
:param uri: A URI that can be used to access the file content.
:type uri: str
:param headers:
:type headers: dict[str, str]
"""
_attribute_map = {
'uri': {'key': 'uri', 'type': 'str'},
'headers': {'key': 'headers', 'type': '{str}'},
}
def __init__(self, *, uri: str=None, headers=None, **kwargs) -> None:
super(FileStorageInfo, self).__init__(**kwargs)
self.uri = uri
self.headers = headers
[docs]class GetTdeCertificatesSqlTaskOutput(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.
:ivar base64_encoded_certificates: Mapping from certificate name to base
64 encoded format.
:vartype base64_encoded_certificates: dict[str, list[str]]
:ivar validation_errors: Validation errors
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'base64_encoded_certificates': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'base64_encoded_certificates': {'key': 'base64EncodedCertificates', 'type': '{[str]}'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(GetTdeCertificatesSqlTaskOutput, self).__init__(**kwargs)
self.base64_encoded_certificates = None
self.validation_errors = None
[docs]class GetTdeCertificatesSqlTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.GetTdeCertificatesSqlTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.GetTdeCertificatesSqlTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'GetTdeCertificatesSqlTaskInput'},
'output': {'key': 'output', 'type': '[GetTdeCertificatesSqlTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(GetTdeCertificatesSqlTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'GetTDECertificates.Sql'
[docs]class GetUserTablesOracleTaskOutput(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.
:ivar schema_name: The schema this result is for
:vartype schema_name: str
:ivar tables: List of valid tables found for this schema
:vartype tables: list[~azure.mgmt.datamigration.models.DatabaseTable]
:ivar validation_errors: Validation errors associated with the task
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'schema_name': {'readonly': True},
'tables': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'schema_name': {'key': 'schemaName', 'type': 'str'},
'tables': {'key': 'tables', 'type': '[DatabaseTable]'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(GetUserTablesOracleTaskOutput, self).__init__(**kwargs)
self.schema_name = None
self.tables = None
self.validation_errors = None
[docs]class GetUserTablesOracleTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input: ~azure.mgmt.datamigration.models.GetUserTablesOracleTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.GetUserTablesOracleTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'GetUserTablesOracleTaskInput'},
'output': {'key': 'output', 'type': '[GetUserTablesOracleTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(GetUserTablesOracleTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'GetUserTablesOracle'
[docs]class GetUserTablesPostgreSqlTaskInput(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.
:param connection_info: Required. Information for connecting to PostgreSQL
source
:type connection_info:
~azure.mgmt.datamigration.models.PostgreSqlConnectionInfo
:param selected_databases: Required. List of PostgreSQL databases for
which to collect tables
:type selected_databases: list[str]
"""
_validation = {
'connection_info': {'required': True},
'selected_databases': {'required': True},
}
_attribute_map = {
'connection_info': {'key': 'connectionInfo', 'type': 'PostgreSqlConnectionInfo'},
'selected_databases': {'key': 'selectedDatabases', 'type': '[str]'},
}
def __init__(self, *, connection_info, selected_databases, **kwargs) -> None:
super(GetUserTablesPostgreSqlTaskInput, self).__init__(**kwargs)
self.connection_info = connection_info
self.selected_databases = selected_databases
[docs]class GetUserTablesPostgreSqlTaskOutput(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.
:ivar database_name: The database this result is for
:vartype database_name: str
:ivar tables: List of valid tables found for this database
:vartype tables: list[~azure.mgmt.datamigration.models.DatabaseTable]
:ivar validation_errors: Validation errors associated with the task
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'database_name': {'readonly': True},
'tables': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'database_name': {'key': 'databaseName', 'type': 'str'},
'tables': {'key': 'tables', 'type': '[DatabaseTable]'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(GetUserTablesPostgreSqlTaskOutput, self).__init__(**kwargs)
self.database_name = None
self.tables = None
self.validation_errors = None
[docs]class GetUserTablesPostgreSqlTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.GetUserTablesPostgreSqlTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.GetUserTablesPostgreSqlTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'GetUserTablesPostgreSqlTaskInput'},
'output': {'key': 'output', 'type': '[GetUserTablesPostgreSqlTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(GetUserTablesPostgreSqlTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'GetUserTablesPostgreSql'
[docs]class GetUserTablesSqlSyncTaskOutput(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.
:ivar databases_to_source_tables: Mapping from database name to list of
source tables
:vartype databases_to_source_tables: dict[str,
list[~azure.mgmt.datamigration.models.DatabaseTable]]
:ivar databases_to_target_tables: Mapping from database name to list of
target tables
:vartype databases_to_target_tables: dict[str,
list[~azure.mgmt.datamigration.models.DatabaseTable]]
:ivar table_validation_errors: Mapping from database name to list of
validation errors
:vartype table_validation_errors: dict[str, list[str]]
:ivar validation_errors: Validation errors
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'databases_to_source_tables': {'readonly': True},
'databases_to_target_tables': {'readonly': True},
'table_validation_errors': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'databases_to_source_tables': {'key': 'databasesToSourceTables', 'type': '{[DatabaseTable]}'},
'databases_to_target_tables': {'key': 'databasesToTargetTables', 'type': '{[DatabaseTable]}'},
'table_validation_errors': {'key': 'tableValidationErrors', 'type': '{[str]}'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(GetUserTablesSqlSyncTaskOutput, self).__init__(**kwargs)
self.databases_to_source_tables = None
self.databases_to_target_tables = None
self.table_validation_errors = None
self.validation_errors = None
[docs]class GetUserTablesSqlSyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.GetUserTablesSqlSyncTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.GetUserTablesSqlSyncTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'GetUserTablesSqlSyncTaskInput'},
'output': {'key': 'output', 'type': '[GetUserTablesSqlSyncTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(GetUserTablesSqlSyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'GetUserTables.AzureSqlDb.Sync'
[docs]class GetUserTablesSqlTaskOutput(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.
:ivar id: Result identifier
:vartype id: str
:ivar databases_to_tables: Mapping from database name to list of tables
:vartype databases_to_tables: dict[str,
list[~azure.mgmt.datamigration.models.DatabaseTable]]
:ivar validation_errors: Validation errors
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'databases_to_tables': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'databases_to_tables': {'key': 'databasesToTables', 'type': '{[DatabaseTable]}'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(GetUserTablesSqlTaskOutput, self).__init__(**kwargs)
self.id = None
self.databases_to_tables = None
self.validation_errors = None
[docs]class GetUserTablesSqlTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input: ~azure.mgmt.datamigration.models.GetUserTablesSqlTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.GetUserTablesSqlTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'GetUserTablesSqlTaskInput'},
'output': {'key': 'output', 'type': '[GetUserTablesSqlTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(GetUserTablesSqlTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'GetUserTables.Sql'
[docs]class InstallOCIDriverTaskOutput(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.
:ivar validation_errors: Validation errors
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'validation_errors': {'readonly': True},
}
_attribute_map = {
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(InstallOCIDriverTaskOutput, self).__init__(**kwargs)
self.validation_errors = None
[docs]class InstallOCIDriverTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input:
:type input: ~azure.mgmt.datamigration.models.InstallOCIDriverTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.InstallOCIDriverTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'InstallOCIDriverTaskInput'},
'output': {'key': 'output', 'type': '[InstallOCIDriverTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(InstallOCIDriverTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Service.Install.OCI'
[docs]class MigrateMISyncCompleteCommandOutput(Model):
"""Output for command that completes online migration for an Azure SQL
Database Managed Instance.
:param errors: List of errors that happened during the command execution
:type errors: list[~azure.mgmt.datamigration.models.ReportableException]
"""
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ReportableException]'},
}
def __init__(self, *, errors=None, **kwargs) -> None:
super(MigrateMISyncCompleteCommandOutput, self).__init__(**kwargs)
self.errors = errors
[docs]class MigrateMISyncCompleteCommandProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the command. This is ignored if submitted.
Possible values include: 'Unknown', 'Accepted', 'Running', 'Succeeded',
'Failed'
:vartype state: str or ~azure.mgmt.datamigration.models.CommandState
:param command_type: Required. Constant filled by server.
:type command_type: str
:param input: Command input
:type input:
~azure.mgmt.datamigration.models.MigrateMISyncCompleteCommandInput
:ivar output: Command output. This is ignored if submitted.
:vartype output:
~azure.mgmt.datamigration.models.MigrateMISyncCompleteCommandOutput
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'command_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'command_type': {'key': 'commandType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MigrateMISyncCompleteCommandInput'},
'output': {'key': 'output', 'type': 'MigrateMISyncCompleteCommandOutput'},
}
def __init__(self, *, input=None, **kwargs) -> None:
super(MigrateMISyncCompleteCommandProperties, self).__init__(**kwargs)
self.input = input
self.output = None
self.command_type = 'Migrate.SqlServer.AzureDbSqlMi.Complete'
[docs]class MigrateMongoDbTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input:
:type input: ~azure.mgmt.datamigration.models.MongoDbMigrationSettings
:ivar output:
:vartype output: list[~azure.mgmt.datamigration.models.MongoDbProgress]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MongoDbMigrationSettings'},
'output': {'key': 'output', 'type': '[MongoDbProgress]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(MigrateMongoDbTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Migrate.MongoDb'
[docs]class MigrateOracleAzureDbForPostgreSqlSyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.MigrateOracleAzureDbPostgreSqlSyncTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.MigrateOracleAzureDbPostgreSqlSyncTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MigrateOracleAzureDbPostgreSqlSyncTaskInput'},
'output': {'key': 'output', 'type': '[MigrateOracleAzureDbPostgreSqlSyncTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(MigrateOracleAzureDbForPostgreSqlSyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Migrate.Oracle.AzureDbForPostgreSql.Sync'
[docs]class MigrateOracleAzureDbPostgreSqlSyncDatabaseInput(Model):
"""Database specific information for Oracle to Azure Database for PostgreSQL
migration task inputs.
:param case_manipulation: How to handle object name casing: either
Preserve or ToLower
:type case_manipulation: str
:param name: Name of the migration pipeline
:type name: str
:param schema_name: Name of the source schema
:type schema_name: str
:param table_map: Mapping of source to target tables
:type table_map: dict[str, str]
:param target_database_name: Name of target database. Note: Target
database will be truncated before starting migration.
:type target_database_name: str
:param migration_setting: Migration settings which tune the migration
behavior
:type migration_setting: dict[str, str]
:param source_setting: Source settings to tune source endpoint migration
behavior
:type source_setting: dict[str, str]
:param target_setting: Target settings to tune target endpoint migration
behavior
:type target_setting: dict[str, str]
"""
_attribute_map = {
'case_manipulation': {'key': 'caseManipulation', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'schema_name': {'key': 'schemaName', 'type': 'str'},
'table_map': {'key': 'tableMap', 'type': '{str}'},
'target_database_name': {'key': 'targetDatabaseName', 'type': 'str'},
'migration_setting': {'key': 'migrationSetting', 'type': '{str}'},
'source_setting': {'key': 'sourceSetting', 'type': '{str}'},
'target_setting': {'key': 'targetSetting', 'type': '{str}'},
}
def __init__(self, *, case_manipulation: str=None, name: str=None, schema_name: str=None, table_map=None, target_database_name: str=None, migration_setting=None, source_setting=None, target_setting=None, **kwargs) -> None:
super(MigrateOracleAzureDbPostgreSqlSyncDatabaseInput, self).__init__(**kwargs)
self.case_manipulation = case_manipulation
self.name = name
self.schema_name = schema_name
self.table_map = table_map
self.target_database_name = target_database_name
self.migration_setting = migration_setting
self.source_setting = source_setting
self.target_setting = target_setting
[docs]class MigrateOracleAzureDbPostgreSqlSyncTaskInput(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.
:param selected_databases: Required. Databases to migrate
:type selected_databases:
list[~azure.mgmt.datamigration.models.MigrateOracleAzureDbPostgreSqlSyncDatabaseInput]
:param target_connection_info: Required. Connection information for target
Azure Database for PostgreSQL
:type target_connection_info:
~azure.mgmt.datamigration.models.PostgreSqlConnectionInfo
:param source_connection_info: Required. Connection information for source
Oracle
:type source_connection_info:
~azure.mgmt.datamigration.models.OracleConnectionInfo
"""
_validation = {
'selected_databases': {'required': True},
'target_connection_info': {'required': True},
'source_connection_info': {'required': True},
}
_attribute_map = {
'selected_databases': {'key': 'selectedDatabases', 'type': '[MigrateOracleAzureDbPostgreSqlSyncDatabaseInput]'},
'target_connection_info': {'key': 'targetConnectionInfo', 'type': 'PostgreSqlConnectionInfo'},
'source_connection_info': {'key': 'sourceConnectionInfo', 'type': 'OracleConnectionInfo'},
}
def __init__(self, *, selected_databases, target_connection_info, source_connection_info, **kwargs) -> None:
super(MigrateOracleAzureDbPostgreSqlSyncTaskInput, self).__init__(**kwargs)
self.selected_databases = selected_databases
self.target_connection_info = target_connection_info
self.source_connection_info = source_connection_info
[docs]class MigrateOracleAzureDbPostgreSqlSyncTaskOutput(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,
MigrateOracleAzureDbPostgreSqlSyncTaskOutputError,
MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel,
MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel,
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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
}
_subtype_map = {
'result_type': {'DatabaseLevelErrorOutput': 'MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError', 'ErrorOutput': 'MigrateOracleAzureDbPostgreSqlSyncTaskOutputError', 'TableLevelOutput': 'MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel', 'DatabaseLevelOutput': 'MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel', 'MigrationLevelOutput': 'MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel'}
}
def __init__(self, **kwargs) -> None:
super(MigrateOracleAzureDbPostgreSqlSyncTaskOutput, self).__init__(**kwargs)
self.id = None
self.result_type = None
[docs]class MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:param error_message: Error message
:type error_message: str
:param events: List of error events.
:type events:
list[~azure.mgmt.datamigration.models.SyncMigrationDatabaseErrorEvent]
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'error_message': {'key': 'errorMessage', 'type': 'str'},
'events': {'key': 'events', 'type': '[SyncMigrationDatabaseErrorEvent]'},
}
def __init__(self, *, error_message: str=None, events=None, **kwargs) -> None:
super(MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError, self).__init__(**kwargs)
self.error_message = error_message
self.events = events
self.result_type = 'DatabaseLevelErrorOutput'
[docs]class MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar database_name: Name of the database
:vartype database_name: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar migration_state: Migration state that this database is in. Possible
values include: 'UNDEFINED', 'CONFIGURING', 'INITIALIAZING', 'STARTING',
'RUNNING', 'READY_TO_COMPLETE', 'COMPLETING', 'COMPLETE', 'CANCELLING',
'CANCELLED', 'FAILED'
:vartype migration_state: str or
~azure.mgmt.datamigration.models.SyncDatabaseMigrationReportingState
:ivar incoming_changes: Number of incoming changes
:vartype incoming_changes: long
:ivar applied_changes: Number of applied changes
:vartype applied_changes: long
:ivar cdc_insert_counter: Number of cdc inserts
:vartype cdc_insert_counter: long
:ivar cdc_delete_counter: Number of cdc deletes
:vartype cdc_delete_counter: long
:ivar cdc_update_counter: Number of cdc updates
:vartype cdc_update_counter: long
:ivar full_load_completed_tables: Number of tables completed in full load
:vartype full_load_completed_tables: long
:ivar full_load_loading_tables: Number of tables loading in full load
:vartype full_load_loading_tables: long
:ivar full_load_queued_tables: Number of tables queued in full load
:vartype full_load_queued_tables: long
:ivar full_load_errored_tables: Number of tables errored in full load
:vartype full_load_errored_tables: long
:ivar initialization_completed: Indicates if initial load (full load) has
been completed
:vartype initialization_completed: bool
:ivar latency: CDC apply latency
:vartype latency: long
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'database_name': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'migration_state': {'readonly': True},
'incoming_changes': {'readonly': True},
'applied_changes': {'readonly': True},
'cdc_insert_counter': {'readonly': True},
'cdc_delete_counter': {'readonly': True},
'cdc_update_counter': {'readonly': True},
'full_load_completed_tables': {'readonly': True},
'full_load_loading_tables': {'readonly': True},
'full_load_queued_tables': {'readonly': True},
'full_load_errored_tables': {'readonly': True},
'initialization_completed': {'readonly': True},
'latency': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'database_name': {'key': 'databaseName', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'migration_state': {'key': 'migrationState', 'type': 'str'},
'incoming_changes': {'key': 'incomingChanges', 'type': 'long'},
'applied_changes': {'key': 'appliedChanges', 'type': 'long'},
'cdc_insert_counter': {'key': 'cdcInsertCounter', 'type': 'long'},
'cdc_delete_counter': {'key': 'cdcDeleteCounter', 'type': 'long'},
'cdc_update_counter': {'key': 'cdcUpdateCounter', 'type': 'long'},
'full_load_completed_tables': {'key': 'fullLoadCompletedTables', 'type': 'long'},
'full_load_loading_tables': {'key': 'fullLoadLoadingTables', 'type': 'long'},
'full_load_queued_tables': {'key': 'fullLoadQueuedTables', 'type': 'long'},
'full_load_errored_tables': {'key': 'fullLoadErroredTables', 'type': 'long'},
'initialization_completed': {'key': 'initializationCompleted', 'type': 'bool'},
'latency': {'key': 'latency', 'type': 'long'},
}
def __init__(self, **kwargs) -> None:
super(MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel, self).__init__(**kwargs)
self.database_name = None
self.started_on = None
self.ended_on = None
self.migration_state = None
self.incoming_changes = None
self.applied_changes = None
self.cdc_insert_counter = None
self.cdc_delete_counter = None
self.cdc_update_counter = None
self.full_load_completed_tables = None
self.full_load_loading_tables = None
self.full_load_queued_tables = None
self.full_load_errored_tables = None
self.initialization_completed = None
self.latency = None
self.result_type = 'DatabaseLevelOutput'
[docs]class MigrateOracleAzureDbPostgreSqlSyncTaskOutputError(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar error: Migration error
:vartype error: ~azure.mgmt.datamigration.models.ReportableException
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'error': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'error': {'key': 'error', 'type': 'ReportableException'},
}
def __init__(self, **kwargs) -> None:
super(MigrateOracleAzureDbPostgreSqlSyncTaskOutputError, self).__init__(**kwargs)
self.error = None
self.result_type = 'ErrorOutput'
[docs]class MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar source_server_version: Source server version
:vartype source_server_version: str
:ivar source_server: Source server name
:vartype source_server: str
:ivar target_server_version: Target server version
:vartype target_server_version: str
:ivar target_server: Target server name
:vartype target_server: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'source_server_version': {'readonly': True},
'source_server': {'readonly': True},
'target_server_version': {'readonly': True},
'target_server': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'source_server_version': {'key': 'sourceServerVersion', 'type': 'str'},
'source_server': {'key': 'sourceServer', 'type': 'str'},
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'target_server': {'key': 'targetServer', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel, self).__init__(**kwargs)
self.started_on = None
self.ended_on = None
self.source_server_version = None
self.source_server = None
self.target_server_version = None
self.target_server = None
self.result_type = 'MigrationLevelOutput'
[docs]class MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar table_name: Name of the table
:vartype table_name: str
:ivar database_name: Name of the database
:vartype database_name: str
:ivar cdc_insert_counter: Number of applied inserts
:vartype cdc_insert_counter: long
:ivar cdc_update_counter: Number of applied updates
:vartype cdc_update_counter: long
:ivar cdc_delete_counter: Number of applied deletes
:vartype cdc_delete_counter: long
:ivar full_load_est_finish_time: Estimate to finish full load
:vartype full_load_est_finish_time: datetime
:ivar full_load_started_on: Full load start time
:vartype full_load_started_on: datetime
:ivar full_load_ended_on: Full load end time
:vartype full_load_ended_on: datetime
:ivar full_load_total_rows: Number of rows applied in full load
:vartype full_load_total_rows: long
:ivar state: Current state of the table migration. Possible values
include: 'BEFORE_LOAD', 'FULL_LOAD', 'COMPLETED', 'CANCELED', 'ERROR',
'FAILED'
:vartype state: str or
~azure.mgmt.datamigration.models.SyncTableMigrationState
:ivar total_changes_applied: Total number of applied changes
:vartype total_changes_applied: long
:ivar data_errors_counter: Number of data errors occurred
:vartype data_errors_counter: long
:ivar last_modified_time: Last modified time on target
:vartype last_modified_time: datetime
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'table_name': {'readonly': True},
'database_name': {'readonly': True},
'cdc_insert_counter': {'readonly': True},
'cdc_update_counter': {'readonly': True},
'cdc_delete_counter': {'readonly': True},
'full_load_est_finish_time': {'readonly': True},
'full_load_started_on': {'readonly': True},
'full_load_ended_on': {'readonly': True},
'full_load_total_rows': {'readonly': True},
'state': {'readonly': True},
'total_changes_applied': {'readonly': True},
'data_errors_counter': {'readonly': True},
'last_modified_time': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'table_name': {'key': 'tableName', 'type': 'str'},
'database_name': {'key': 'databaseName', 'type': 'str'},
'cdc_insert_counter': {'key': 'cdcInsertCounter', 'type': 'long'},
'cdc_update_counter': {'key': 'cdcUpdateCounter', 'type': 'long'},
'cdc_delete_counter': {'key': 'cdcDeleteCounter', 'type': 'long'},
'full_load_est_finish_time': {'key': 'fullLoadEstFinishTime', 'type': 'iso-8601'},
'full_load_started_on': {'key': 'fullLoadStartedOn', 'type': 'iso-8601'},
'full_load_ended_on': {'key': 'fullLoadEndedOn', 'type': 'iso-8601'},
'full_load_total_rows': {'key': 'fullLoadTotalRows', 'type': 'long'},
'state': {'key': 'state', 'type': 'str'},
'total_changes_applied': {'key': 'totalChangesApplied', 'type': 'long'},
'data_errors_counter': {'key': 'dataErrorsCounter', 'type': 'long'},
'last_modified_time': {'key': 'lastModifiedTime', 'type': 'iso-8601'},
}
def __init__(self, **kwargs) -> None:
super(MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel, self).__init__(**kwargs)
self.table_name = None
self.database_name = None
self.cdc_insert_counter = None
self.cdc_update_counter = None
self.cdc_delete_counter = None
self.full_load_est_finish_time = None
self.full_load_started_on = None
self.full_load_ended_on = None
self.full_load_total_rows = None
self.state = None
self.total_changes_applied = None
self.data_errors_counter = None
self.last_modified_time = None
self.result_type = 'TableLevelOutput'
[docs]class MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput(Model):
"""Database specific information for PostgreSQL to Azure Database for
PostgreSQL migration task inputs.
:param name: Name of the database
:type name: str
:param target_database_name: Name of target database. Note: Target
database will be truncated before starting migration.
:type target_database_name: str
:param migration_setting: Migration settings which tune the migration
behavior
:type migration_setting: dict[str, str]
:param source_setting: Source settings to tune source endpoint migration
behavior
:type source_setting: dict[str, str]
:param target_setting: Target settings to tune target endpoint migration
behavior
:type target_setting: dict[str, str]
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'target_database_name': {'key': 'targetDatabaseName', 'type': 'str'},
'migration_setting': {'key': 'migrationSetting', 'type': '{str}'},
'source_setting': {'key': 'sourceSetting', 'type': '{str}'},
'target_setting': {'key': 'targetSetting', 'type': '{str}'},
}
def __init__(self, *, name: str=None, target_database_name: str=None, migration_setting=None, source_setting=None, target_setting=None, **kwargs) -> None:
super(MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput, self).__init__(**kwargs)
self.name = name
self.target_database_name = target_database_name
self.migration_setting = migration_setting
self.source_setting = source_setting
self.target_setting = target_setting
[docs]class MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput(Model):
"""Input for the task that migrates PostgreSQL databases to Azure Database for
PostgreSQL for online migrations.
All required parameters must be populated in order to send to Azure.
:param selected_databases: Required. Databases to migrate
:type selected_databases:
list[~azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput]
:param target_connection_info: Required. Connection information for target
Azure Database for PostgreSQL
:type target_connection_info:
~azure.mgmt.datamigration.models.PostgreSqlConnectionInfo
:param source_connection_info: Required. Connection information for source
PostgreSQL
:type source_connection_info:
~azure.mgmt.datamigration.models.PostgreSqlConnectionInfo
"""
_validation = {
'selected_databases': {'required': True},
'target_connection_info': {'required': True},
'source_connection_info': {'required': True},
}
_attribute_map = {
'selected_databases': {'key': 'selectedDatabases', 'type': '[MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput]'},
'target_connection_info': {'key': 'targetConnectionInfo', 'type': 'PostgreSqlConnectionInfo'},
'source_connection_info': {'key': 'sourceConnectionInfo', 'type': 'PostgreSqlConnectionInfo'},
}
def __init__(self, *, selected_databases, target_connection_info, source_connection_info, **kwargs) -> None:
super(MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput, self).__init__(**kwargs)
self.selected_databases = selected_databases
self.target_connection_info = target_connection_info
self.source_connection_info = source_connection_info
[docs]class MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput(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,
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError,
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel,
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel,
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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
}
_subtype_map = {
'result_type': {'DatabaseLevelErrorOutput': 'MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError', 'ErrorOutput': 'MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError', 'TableLevelOutput': 'MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel', 'DatabaseLevelOutput': 'MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel', 'MigrationLevelOutput': 'MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel'}
}
def __init__(self, **kwargs) -> None:
super(MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput, self).__init__(**kwargs)
self.id = None
self.result_type = None
[docs]class MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:param error_message: Error message
:type error_message: str
:param events: List of error events.
:type events:
list[~azure.mgmt.datamigration.models.SyncMigrationDatabaseErrorEvent]
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'error_message': {'key': 'errorMessage', 'type': 'str'},
'events': {'key': 'events', 'type': '[SyncMigrationDatabaseErrorEvent]'},
}
def __init__(self, *, error_message: str=None, events=None, **kwargs) -> None:
super(MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError, self).__init__(**kwargs)
self.error_message = error_message
self.events = events
self.result_type = 'DatabaseLevelErrorOutput'
[docs]class MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar database_name: Name of the database
:vartype database_name: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar migration_state: Migration state that this database is in. Possible
values include: 'UNDEFINED', 'CONFIGURING', 'INITIALIAZING', 'STARTING',
'RUNNING', 'READY_TO_COMPLETE', 'COMPLETING', 'COMPLETE', 'CANCELLING',
'CANCELLED', 'FAILED'
:vartype migration_state: str or
~azure.mgmt.datamigration.models.SyncDatabaseMigrationReportingState
:ivar incoming_changes: Number of incoming changes
:vartype incoming_changes: long
:ivar applied_changes: Number of applied changes
:vartype applied_changes: long
:ivar cdc_insert_counter: Number of cdc inserts
:vartype cdc_insert_counter: long
:ivar cdc_delete_counter: Number of cdc deletes
:vartype cdc_delete_counter: long
:ivar cdc_update_counter: Number of cdc updates
:vartype cdc_update_counter: long
:ivar full_load_completed_tables: Number of tables completed in full load
:vartype full_load_completed_tables: long
:ivar full_load_loading_tables: Number of tables loading in full load
:vartype full_load_loading_tables: long
:ivar full_load_queued_tables: Number of tables queued in full load
:vartype full_load_queued_tables: long
:ivar full_load_errored_tables: Number of tables errored in full load
:vartype full_load_errored_tables: long
:ivar initialization_completed: Indicates if initial load (full load) has
been completed
:vartype initialization_completed: bool
:ivar latency: CDC apply latency
:vartype latency: long
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'database_name': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'migration_state': {'readonly': True},
'incoming_changes': {'readonly': True},
'applied_changes': {'readonly': True},
'cdc_insert_counter': {'readonly': True},
'cdc_delete_counter': {'readonly': True},
'cdc_update_counter': {'readonly': True},
'full_load_completed_tables': {'readonly': True},
'full_load_loading_tables': {'readonly': True},
'full_load_queued_tables': {'readonly': True},
'full_load_errored_tables': {'readonly': True},
'initialization_completed': {'readonly': True},
'latency': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'database_name': {'key': 'databaseName', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'migration_state': {'key': 'migrationState', 'type': 'str'},
'incoming_changes': {'key': 'incomingChanges', 'type': 'long'},
'applied_changes': {'key': 'appliedChanges', 'type': 'long'},
'cdc_insert_counter': {'key': 'cdcInsertCounter', 'type': 'long'},
'cdc_delete_counter': {'key': 'cdcDeleteCounter', 'type': 'long'},
'cdc_update_counter': {'key': 'cdcUpdateCounter', 'type': 'long'},
'full_load_completed_tables': {'key': 'fullLoadCompletedTables', 'type': 'long'},
'full_load_loading_tables': {'key': 'fullLoadLoadingTables', 'type': 'long'},
'full_load_queued_tables': {'key': 'fullLoadQueuedTables', 'type': 'long'},
'full_load_errored_tables': {'key': 'fullLoadErroredTables', 'type': 'long'},
'initialization_completed': {'key': 'initializationCompleted', 'type': 'bool'},
'latency': {'key': 'latency', 'type': 'long'},
}
def __init__(self, **kwargs) -> None:
super(MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel, self).__init__(**kwargs)
self.database_name = None
self.started_on = None
self.ended_on = None
self.migration_state = None
self.incoming_changes = None
self.applied_changes = None
self.cdc_insert_counter = None
self.cdc_delete_counter = None
self.cdc_update_counter = None
self.full_load_completed_tables = None
self.full_load_loading_tables = None
self.full_load_queued_tables = None
self.full_load_errored_tables = None
self.initialization_completed = None
self.latency = None
self.result_type = 'DatabaseLevelOutput'
[docs]class MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar error: Migration error
:vartype error: ~azure.mgmt.datamigration.models.ReportableException
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'error': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'error': {'key': 'error', 'type': 'ReportableException'},
}
def __init__(self, **kwargs) -> None:
super(MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError, self).__init__(**kwargs)
self.error = None
self.result_type = 'ErrorOutput'
[docs]class MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar source_server_version: Source server version
:vartype source_server_version: str
:ivar source_server: Source server name
:vartype source_server: str
:ivar target_server_version: Target server version
:vartype target_server_version: str
:ivar target_server: Target server name
:vartype target_server: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'source_server_version': {'readonly': True},
'source_server': {'readonly': True},
'target_server_version': {'readonly': True},
'target_server': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'source_server_version': {'key': 'sourceServerVersion', 'type': 'str'},
'source_server': {'key': 'sourceServer', 'type': 'str'},
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'target_server': {'key': 'targetServer', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel, self).__init__(**kwargs)
self.started_on = None
self.ended_on = None
self.source_server_version = None
self.source_server = None
self.target_server_version = None
self.target_server = None
self.result_type = 'MigrationLevelOutput'
[docs]class MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar table_name: Name of the table
:vartype table_name: str
:ivar database_name: Name of the database
:vartype database_name: str
:ivar cdc_insert_counter: Number of applied inserts
:vartype cdc_insert_counter: long
:ivar cdc_update_counter: Number of applied updates
:vartype cdc_update_counter: long
:ivar cdc_delete_counter: Number of applied deletes
:vartype cdc_delete_counter: long
:ivar full_load_est_finish_time: Estimate to finish full load
:vartype full_load_est_finish_time: datetime
:ivar full_load_started_on: Full load start time
:vartype full_load_started_on: datetime
:ivar full_load_ended_on: Full load end time
:vartype full_load_ended_on: datetime
:ivar full_load_total_rows: Number of rows applied in full load
:vartype full_load_total_rows: long
:ivar state: Current state of the table migration. Possible values
include: 'BEFORE_LOAD', 'FULL_LOAD', 'COMPLETED', 'CANCELED', 'ERROR',
'FAILED'
:vartype state: str or
~azure.mgmt.datamigration.models.SyncTableMigrationState
:ivar total_changes_applied: Total number of applied changes
:vartype total_changes_applied: long
:ivar data_errors_counter: Number of data errors occurred
:vartype data_errors_counter: long
:ivar last_modified_time: Last modified time on target
:vartype last_modified_time: datetime
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'table_name': {'readonly': True},
'database_name': {'readonly': True},
'cdc_insert_counter': {'readonly': True},
'cdc_update_counter': {'readonly': True},
'cdc_delete_counter': {'readonly': True},
'full_load_est_finish_time': {'readonly': True},
'full_load_started_on': {'readonly': True},
'full_load_ended_on': {'readonly': True},
'full_load_total_rows': {'readonly': True},
'state': {'readonly': True},
'total_changes_applied': {'readonly': True},
'data_errors_counter': {'readonly': True},
'last_modified_time': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'table_name': {'key': 'tableName', 'type': 'str'},
'database_name': {'key': 'databaseName', 'type': 'str'},
'cdc_insert_counter': {'key': 'cdcInsertCounter', 'type': 'long'},
'cdc_update_counter': {'key': 'cdcUpdateCounter', 'type': 'long'},
'cdc_delete_counter': {'key': 'cdcDeleteCounter', 'type': 'long'},
'full_load_est_finish_time': {'key': 'fullLoadEstFinishTime', 'type': 'iso-8601'},
'full_load_started_on': {'key': 'fullLoadStartedOn', 'type': 'iso-8601'},
'full_load_ended_on': {'key': 'fullLoadEndedOn', 'type': 'iso-8601'},
'full_load_total_rows': {'key': 'fullLoadTotalRows', 'type': 'long'},
'state': {'key': 'state', 'type': 'str'},
'total_changes_applied': {'key': 'totalChangesApplied', 'type': 'long'},
'data_errors_counter': {'key': 'dataErrorsCounter', 'type': 'long'},
'last_modified_time': {'key': 'lastModifiedTime', 'type': 'iso-8601'},
}
def __init__(self, **kwargs) -> None:
super(MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel, self).__init__(**kwargs)
self.table_name = None
self.database_name = None
self.cdc_insert_counter = None
self.cdc_update_counter = None
self.cdc_delete_counter = None
self.full_load_est_finish_time = None
self.full_load_started_on = None
self.full_load_ended_on = None
self.full_load_total_rows = None
self.state = None
self.total_changes_applied = None
self.data_errors_counter = None
self.last_modified_time = None
self.result_type = 'TableLevelOutput'
[docs]class MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput'},
'output': {'key': 'output', 'type': '[MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Migrate.PostgreSql.AzureDbForPostgreSql.Sync'
[docs]class MigrateSchemaSqlServerSqlDbTaskOutput(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: MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel,
MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel,
MigrateSchemaSqlServerSqlDbTaskOutputError, 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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
}
_subtype_map = {
'result_type': {'MigrationLevelOutput': 'MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel', 'DatabaseLevelOutput': 'MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel', 'SchemaErrorOutput': 'MigrateSchemaSqlServerSqlDbTaskOutputError', 'ErrorOutput': 'MigrateSchemaSqlTaskOutputError'}
}
def __init__(self, **kwargs) -> None:
super(MigrateSchemaSqlServerSqlDbTaskOutput, self).__init__(**kwargs)
self.id = None
self.result_type = None
[docs]class MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar database_name: The name of the database
:vartype database_name: str
:ivar state: State of the schema migration for this database. Possible
values include: 'None', 'InProgress', 'Failed', 'Warning', 'Completed',
'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar stage: Schema migration stage for this database. Possible values
include: 'NotStarted', 'ValidatingInputs', 'CollectingObjects',
'DownloadingScript', 'GeneratingScript', 'UploadingScript',
'DeployingSchema', 'Completed', 'CompletedWithWarnings', 'Failed'
:vartype stage: str or
~azure.mgmt.datamigration.models.SchemaMigrationStage
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar database_error_result_prefix: Prefix string to use for querying
errors for this database
:vartype database_error_result_prefix: str
:ivar schema_error_result_prefix: Prefix string to use for querying schema
errors for this database
:vartype schema_error_result_prefix: str
:ivar number_of_successful_operations: Number of successful operations for
this database
:vartype number_of_successful_operations: long
:ivar number_of_failed_operations: Number of failed operations for this
database
:vartype number_of_failed_operations: long
:ivar file_id: Identifier for the file resource containing the schema of
this database
:vartype file_id: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'database_name': {'readonly': True},
'state': {'readonly': True},
'stage': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'database_error_result_prefix': {'readonly': True},
'schema_error_result_prefix': {'readonly': True},
'number_of_successful_operations': {'readonly': True},
'number_of_failed_operations': {'readonly': True},
'file_id': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'database_name': {'key': 'databaseName', 'type': 'str'},
'state': {'key': 'state', 'type': 'str'},
'stage': {'key': 'stage', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'database_error_result_prefix': {'key': 'databaseErrorResultPrefix', 'type': 'str'},
'schema_error_result_prefix': {'key': 'schemaErrorResultPrefix', 'type': 'str'},
'number_of_successful_operations': {'key': 'numberOfSuccessfulOperations', 'type': 'long'},
'number_of_failed_operations': {'key': 'numberOfFailedOperations', 'type': 'long'},
'file_id': {'key': 'fileId', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel, self).__init__(**kwargs)
self.database_name = None
self.state = None
self.stage = None
self.started_on = None
self.ended_on = None
self.database_error_result_prefix = None
self.schema_error_result_prefix = None
self.number_of_successful_operations = None
self.number_of_failed_operations = None
self.file_id = None
self.result_type = 'DatabaseLevelOutput'
[docs]class MigrateSchemaSqlServerSqlDbTaskOutputError(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar command_text: Schema command which failed
:vartype command_text: str
:ivar error_text: Reason of failure
:vartype error_text: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'command_text': {'readonly': True},
'error_text': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'command_text': {'key': 'commandText', 'type': 'str'},
'error_text': {'key': 'errorText', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSchemaSqlServerSqlDbTaskOutputError, self).__init__(**kwargs)
self.command_text = None
self.error_text = None
self.result_type = 'SchemaErrorOutput'
[docs]class MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar state: Overall state of the schema migration. Possible values
include: 'None', 'InProgress', 'Failed', 'Warning', 'Completed',
'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar source_server_version: Source server version
:vartype source_server_version: str
:ivar source_server_brand_version: Source server brand version
:vartype source_server_brand_version: str
:ivar target_server_version: Target server version
:vartype target_server_version: str
:ivar target_server_brand_version: Target server brand version
:vartype target_server_brand_version: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'state': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'source_server_version': {'readonly': True},
'source_server_brand_version': {'readonly': True},
'target_server_version': {'readonly': True},
'target_server_brand_version': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'state': {'key': 'state', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'source_server_version': {'key': 'sourceServerVersion', 'type': 'str'},
'source_server_brand_version': {'key': 'sourceServerBrandVersion', 'type': 'str'},
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'target_server_brand_version': {'key': 'targetServerBrandVersion', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel, self).__init__(**kwargs)
self.state = None
self.started_on = None
self.ended_on = None
self.source_server_version = None
self.source_server_brand_version = None
self.target_server_version = None
self.target_server_brand_version = None
self.result_type = 'MigrationLevelOutput'
[docs]class MigrateSchemaSqlServerSqlDbTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.MigrateSchemaSqlServerSqlDbTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.MigrateSchemaSqlServerSqlDbTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MigrateSchemaSqlServerSqlDbTaskInput'},
'output': {'key': 'output', 'type': '[MigrateSchemaSqlServerSqlDbTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(MigrateSchemaSqlServerSqlDbTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'MigrateSchemaSqlServerSqlDb'
[docs]class MigrateSchemaSqlTaskOutputError(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar error: Migration error
:vartype error: ~azure.mgmt.datamigration.models.ReportableException
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'error': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'error': {'key': 'error', 'type': 'ReportableException'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSchemaSqlTaskOutputError, self).__init__(**kwargs)
self.error = None
self.result_type = 'ErrorOutput'
[docs]class MigrateSqlServerSqlDbSyncTaskOutput(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,
MigrateSqlServerSqlDbSyncTaskOutputError,
MigrateSqlServerSqlDbSyncTaskOutputTableLevel,
MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel,
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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
}
_subtype_map = {
'result_type': {'DatabaseLevelErrorOutput': 'MigrateSqlServerSqlDbSyncTaskOutputDatabaseError', 'ErrorOutput': 'MigrateSqlServerSqlDbSyncTaskOutputError', 'TableLevelOutput': 'MigrateSqlServerSqlDbSyncTaskOutputTableLevel', 'DatabaseLevelOutput': 'MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel', 'MigrationLevelOutput': 'MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel'}
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlDbSyncTaskOutput, self).__init__(**kwargs)
self.id = None
self.result_type = None
[docs]class MigrateSqlServerSqlDbSyncTaskOutputDatabaseError(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:param error_message: Error message
:type error_message: str
:param events: List of error events.
:type events:
list[~azure.mgmt.datamigration.models.SyncMigrationDatabaseErrorEvent]
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'error_message': {'key': 'errorMessage', 'type': 'str'},
'events': {'key': 'events', 'type': '[SyncMigrationDatabaseErrorEvent]'},
}
def __init__(self, *, error_message: str=None, events=None, **kwargs) -> None:
super(MigrateSqlServerSqlDbSyncTaskOutputDatabaseError, self).__init__(**kwargs)
self.error_message = error_message
self.events = events
self.result_type = 'DatabaseLevelErrorOutput'
[docs]class MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar database_name: Name of the database
:vartype database_name: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar migration_state: Migration state that this database is in. Possible
values include: 'UNDEFINED', 'CONFIGURING', 'INITIALIAZING', 'STARTING',
'RUNNING', 'READY_TO_COMPLETE', 'COMPLETING', 'COMPLETE', 'CANCELLING',
'CANCELLED', 'FAILED'
:vartype migration_state: str or
~azure.mgmt.datamigration.models.SyncDatabaseMigrationReportingState
:ivar incoming_changes: Number of incoming changes
:vartype incoming_changes: long
:ivar applied_changes: Number of applied changes
:vartype applied_changes: long
:ivar cdc_insert_counter: Number of cdc inserts
:vartype cdc_insert_counter: long
:ivar cdc_delete_counter: Number of cdc deletes
:vartype cdc_delete_counter: long
:ivar cdc_update_counter: Number of cdc updates
:vartype cdc_update_counter: long
:ivar full_load_completed_tables: Number of tables completed in full load
:vartype full_load_completed_tables: long
:ivar full_load_loading_tables: Number of tables loading in full load
:vartype full_load_loading_tables: long
:ivar full_load_queued_tables: Number of tables queued in full load
:vartype full_load_queued_tables: long
:ivar full_load_errored_tables: Number of tables errored in full load
:vartype full_load_errored_tables: long
:ivar initialization_completed: Indicates if initial load (full load) has
been completed
:vartype initialization_completed: bool
:ivar latency: CDC apply latency
:vartype latency: long
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'database_name': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'migration_state': {'readonly': True},
'incoming_changes': {'readonly': True},
'applied_changes': {'readonly': True},
'cdc_insert_counter': {'readonly': True},
'cdc_delete_counter': {'readonly': True},
'cdc_update_counter': {'readonly': True},
'full_load_completed_tables': {'readonly': True},
'full_load_loading_tables': {'readonly': True},
'full_load_queued_tables': {'readonly': True},
'full_load_errored_tables': {'readonly': True},
'initialization_completed': {'readonly': True},
'latency': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'database_name': {'key': 'databaseName', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'migration_state': {'key': 'migrationState', 'type': 'str'},
'incoming_changes': {'key': 'incomingChanges', 'type': 'long'},
'applied_changes': {'key': 'appliedChanges', 'type': 'long'},
'cdc_insert_counter': {'key': 'cdcInsertCounter', 'type': 'long'},
'cdc_delete_counter': {'key': 'cdcDeleteCounter', 'type': 'long'},
'cdc_update_counter': {'key': 'cdcUpdateCounter', 'type': 'long'},
'full_load_completed_tables': {'key': 'fullLoadCompletedTables', 'type': 'long'},
'full_load_loading_tables': {'key': 'fullLoadLoadingTables', 'type': 'long'},
'full_load_queued_tables': {'key': 'fullLoadQueuedTables', 'type': 'long'},
'full_load_errored_tables': {'key': 'fullLoadErroredTables', 'type': 'long'},
'initialization_completed': {'key': 'initializationCompleted', 'type': 'bool'},
'latency': {'key': 'latency', 'type': 'long'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel, self).__init__(**kwargs)
self.database_name = None
self.started_on = None
self.ended_on = None
self.migration_state = None
self.incoming_changes = None
self.applied_changes = None
self.cdc_insert_counter = None
self.cdc_delete_counter = None
self.cdc_update_counter = None
self.full_load_completed_tables = None
self.full_load_loading_tables = None
self.full_load_queued_tables = None
self.full_load_errored_tables = None
self.initialization_completed = None
self.latency = None
self.result_type = 'DatabaseLevelOutput'
[docs]class MigrateSqlServerSqlDbSyncTaskOutputError(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar error: Migration error
:vartype error: ~azure.mgmt.datamigration.models.ReportableException
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'error': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'error': {'key': 'error', 'type': 'ReportableException'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlDbSyncTaskOutputError, self).__init__(**kwargs)
self.error = None
self.result_type = 'ErrorOutput'
[docs]class MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar source_server_version: Source server version
:vartype source_server_version: str
:ivar source_server: Source server name
:vartype source_server: str
:ivar target_server_version: Target server version
:vartype target_server_version: str
:ivar target_server: Target server name
:vartype target_server: str
:ivar database_count: Count of databases
:vartype database_count: int
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'source_server_version': {'readonly': True},
'source_server': {'readonly': True},
'target_server_version': {'readonly': True},
'target_server': {'readonly': True},
'database_count': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'source_server_version': {'key': 'sourceServerVersion', 'type': 'str'},
'source_server': {'key': 'sourceServer', 'type': 'str'},
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'target_server': {'key': 'targetServer', 'type': 'str'},
'database_count': {'key': 'databaseCount', 'type': 'int'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel, self).__init__(**kwargs)
self.started_on = None
self.ended_on = None
self.source_server_version = None
self.source_server = None
self.target_server_version = None
self.target_server = None
self.database_count = None
self.result_type = 'MigrationLevelOutput'
[docs]class MigrateSqlServerSqlDbSyncTaskOutputTableLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar table_name: Name of the table
:vartype table_name: str
:ivar database_name: Name of the database
:vartype database_name: str
:ivar cdc_insert_counter: Number of applied inserts
:vartype cdc_insert_counter: long
:ivar cdc_update_counter: Number of applied updates
:vartype cdc_update_counter: long
:ivar cdc_delete_counter: Number of applied deletes
:vartype cdc_delete_counter: long
:ivar full_load_est_finish_time: Estimate to finish full load
:vartype full_load_est_finish_time: datetime
:ivar full_load_started_on: Full load start time
:vartype full_load_started_on: datetime
:ivar full_load_ended_on: Full load end time
:vartype full_load_ended_on: datetime
:ivar full_load_total_rows: Number of rows applied in full load
:vartype full_load_total_rows: long
:ivar state: Current state of the table migration. Possible values
include: 'BEFORE_LOAD', 'FULL_LOAD', 'COMPLETED', 'CANCELED', 'ERROR',
'FAILED'
:vartype state: str or
~azure.mgmt.datamigration.models.SyncTableMigrationState
:ivar total_changes_applied: Total number of applied changes
:vartype total_changes_applied: long
:ivar data_errors_counter: Number of data errors occurred
:vartype data_errors_counter: long
:ivar last_modified_time: Last modified time on target
:vartype last_modified_time: datetime
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'table_name': {'readonly': True},
'database_name': {'readonly': True},
'cdc_insert_counter': {'readonly': True},
'cdc_update_counter': {'readonly': True},
'cdc_delete_counter': {'readonly': True},
'full_load_est_finish_time': {'readonly': True},
'full_load_started_on': {'readonly': True},
'full_load_ended_on': {'readonly': True},
'full_load_total_rows': {'readonly': True},
'state': {'readonly': True},
'total_changes_applied': {'readonly': True},
'data_errors_counter': {'readonly': True},
'last_modified_time': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'table_name': {'key': 'tableName', 'type': 'str'},
'database_name': {'key': 'databaseName', 'type': 'str'},
'cdc_insert_counter': {'key': 'cdcInsertCounter', 'type': 'long'},
'cdc_update_counter': {'key': 'cdcUpdateCounter', 'type': 'long'},
'cdc_delete_counter': {'key': 'cdcDeleteCounter', 'type': 'long'},
'full_load_est_finish_time': {'key': 'fullLoadEstFinishTime', 'type': 'iso-8601'},
'full_load_started_on': {'key': 'fullLoadStartedOn', 'type': 'iso-8601'},
'full_load_ended_on': {'key': 'fullLoadEndedOn', 'type': 'iso-8601'},
'full_load_total_rows': {'key': 'fullLoadTotalRows', 'type': 'long'},
'state': {'key': 'state', 'type': 'str'},
'total_changes_applied': {'key': 'totalChangesApplied', 'type': 'long'},
'data_errors_counter': {'key': 'dataErrorsCounter', 'type': 'long'},
'last_modified_time': {'key': 'lastModifiedTime', 'type': 'iso-8601'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlDbSyncTaskOutputTableLevel, self).__init__(**kwargs)
self.table_name = None
self.database_name = None
self.cdc_insert_counter = None
self.cdc_update_counter = None
self.cdc_delete_counter = None
self.full_load_est_finish_time = None
self.full_load_started_on = None
self.full_load_ended_on = None
self.full_load_total_rows = None
self.state = None
self.total_changes_applied = None
self.data_errors_counter = None
self.last_modified_time = None
self.result_type = 'TableLevelOutput'
[docs]class MigrateSqlServerSqlDbSyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.MigrateSqlServerSqlDbSyncTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.MigrateSqlServerSqlDbSyncTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MigrateSqlServerSqlDbSyncTaskInput'},
'output': {'key': 'output', 'type': '[MigrateSqlServerSqlDbSyncTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(MigrateSqlServerSqlDbSyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Migrate.SqlServer.AzureSqlDb.Sync'
[docs]class MigrateSqlServerSqlDbTaskOutput(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: MigrateSqlServerSqlDbTaskOutputError,
MigrateSqlServerSqlDbTaskOutputTableLevel,
MigrateSqlServerSqlDbTaskOutputDatabaseLevel,
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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
}
_subtype_map = {
'result_type': {'ErrorOutput': 'MigrateSqlServerSqlDbTaskOutputError', 'TableLevelOutput': 'MigrateSqlServerSqlDbTaskOutputTableLevel', 'DatabaseLevelOutput': 'MigrateSqlServerSqlDbTaskOutputDatabaseLevel', 'MigrationLevelOutput': 'MigrateSqlServerSqlDbTaskOutputMigrationLevel'}
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlDbTaskOutput, self).__init__(**kwargs)
self.id = None
self.result_type = None
[docs]class MigrateSqlServerSqlDbTaskOutputDatabaseLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar database_name: Name of the item
:vartype database_name: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar state: Current state of migration. Possible values include: 'None',
'InProgress', 'Failed', 'Warning', 'Completed', 'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar stage: Migration stage that this database is in. Possible values
include: 'None', 'Initialize', 'Backup', 'FileCopy', 'Restore',
'Completed'
:vartype stage: str or
~azure.mgmt.datamigration.models.DatabaseMigrationStage
:ivar status_message: Status message
:vartype status_message: str
:ivar message: Migration progress message
:vartype message: str
:ivar number_of_objects: Number of objects
:vartype number_of_objects: long
:ivar number_of_objects_completed: Number of successfully completed
objects
:vartype number_of_objects_completed: long
:ivar error_count: Number of database/object errors.
:vartype error_count: long
:ivar error_prefix: Wildcard string prefix to use for querying all errors
of the item
:vartype error_prefix: str
:ivar result_prefix: Wildcard string prefix to use for querying all
sub-tem results of the item
:vartype result_prefix: str
:ivar exceptions_and_warnings: Migration exceptions and warnings.
:vartype exceptions_and_warnings:
list[~azure.mgmt.datamigration.models.ReportableException]
:ivar object_summary: Summary of object results in the migration
:vartype object_summary: dict[str,
~azure.mgmt.datamigration.models.DataItemMigrationSummaryResult]
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'database_name': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'state': {'readonly': True},
'stage': {'readonly': True},
'status_message': {'readonly': True},
'message': {'readonly': True},
'number_of_objects': {'readonly': True},
'number_of_objects_completed': {'readonly': True},
'error_count': {'readonly': True},
'error_prefix': {'readonly': True},
'result_prefix': {'readonly': True},
'exceptions_and_warnings': {'readonly': True},
'object_summary': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'database_name': {'key': 'databaseName', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'state': {'key': 'state', 'type': 'str'},
'stage': {'key': 'stage', 'type': 'str'},
'status_message': {'key': 'statusMessage', 'type': 'str'},
'message': {'key': 'message', 'type': 'str'},
'number_of_objects': {'key': 'numberOfObjects', 'type': 'long'},
'number_of_objects_completed': {'key': 'numberOfObjectsCompleted', 'type': 'long'},
'error_count': {'key': 'errorCount', 'type': 'long'},
'error_prefix': {'key': 'errorPrefix', 'type': 'str'},
'result_prefix': {'key': 'resultPrefix', 'type': 'str'},
'exceptions_and_warnings': {'key': 'exceptionsAndWarnings', 'type': '[ReportableException]'},
'object_summary': {'key': 'objectSummary', 'type': '{DataItemMigrationSummaryResult}'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlDbTaskOutputDatabaseLevel, self).__init__(**kwargs)
self.database_name = None
self.started_on = None
self.ended_on = None
self.state = None
self.stage = None
self.status_message = None
self.message = None
self.number_of_objects = None
self.number_of_objects_completed = None
self.error_count = None
self.error_prefix = None
self.result_prefix = None
self.exceptions_and_warnings = None
self.object_summary = None
self.result_type = 'DatabaseLevelOutput'
[docs]class MigrateSqlServerSqlDbTaskOutputError(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar error: Migration error
:vartype error: ~azure.mgmt.datamigration.models.ReportableException
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'error': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'error': {'key': 'error', 'type': 'ReportableException'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlDbTaskOutputError, self).__init__(**kwargs)
self.error = None
self.result_type = 'ErrorOutput'
[docs]class MigrateSqlServerSqlDbTaskOutputMigrationLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar duration_in_seconds: Duration of task execution in seconds.
:vartype duration_in_seconds: long
:ivar status: Current status of migration. Possible values include:
'Default', 'Connecting', 'SourceAndTargetSelected', 'SelectLogins',
'Configured', 'Running', 'Error', 'Stopped', 'Completed',
'CompletedWithWarnings'
:vartype status: str or ~azure.mgmt.datamigration.models.MigrationStatus
:ivar status_message: Migration status message
:vartype status_message: str
:ivar message: Migration progress message
:vartype message: str
:ivar databases: Selected databases as a map from database name to
database id
:vartype databases: dict[str, str]
:ivar database_summary: Summary of database results in the migration
:vartype database_summary: dict[str,
~azure.mgmt.datamigration.models.DatabaseSummaryResult]
:param migration_validation_result: Migration Validation Results
:type migration_validation_result:
~azure.mgmt.datamigration.models.MigrationValidationResult
:param migration_report_result: Migration Report Result, provides unique
url for downloading your migration report.
:type migration_report_result:
~azure.mgmt.datamigration.models.MigrationReportResult
:ivar source_server_version: Source server version
:vartype source_server_version: str
:ivar source_server_brand_version: Source server brand version
:vartype source_server_brand_version: str
:ivar target_server_version: Target server version
:vartype target_server_version: str
:ivar target_server_brand_version: Target server brand version
:vartype target_server_brand_version: str
:ivar exceptions_and_warnings: Migration exceptions and warnings.
:vartype exceptions_and_warnings:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'duration_in_seconds': {'readonly': True},
'status': {'readonly': True},
'status_message': {'readonly': True},
'message': {'readonly': True},
'databases': {'readonly': True},
'database_summary': {'readonly': True},
'source_server_version': {'readonly': True},
'source_server_brand_version': {'readonly': True},
'target_server_version': {'readonly': True},
'target_server_brand_version': {'readonly': True},
'exceptions_and_warnings': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'duration_in_seconds': {'key': 'durationInSeconds', 'type': 'long'},
'status': {'key': 'status', 'type': 'str'},
'status_message': {'key': 'statusMessage', 'type': 'str'},
'message': {'key': 'message', 'type': 'str'},
'databases': {'key': 'databases', 'type': '{str}'},
'database_summary': {'key': 'databaseSummary', 'type': '{DatabaseSummaryResult}'},
'migration_validation_result': {'key': 'migrationValidationResult', 'type': 'MigrationValidationResult'},
'migration_report_result': {'key': 'migrationReportResult', 'type': 'MigrationReportResult'},
'source_server_version': {'key': 'sourceServerVersion', 'type': 'str'},
'source_server_brand_version': {'key': 'sourceServerBrandVersion', 'type': 'str'},
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'target_server_brand_version': {'key': 'targetServerBrandVersion', 'type': 'str'},
'exceptions_and_warnings': {'key': 'exceptionsAndWarnings', 'type': '[ReportableException]'},
}
def __init__(self, *, migration_validation_result=None, migration_report_result=None, **kwargs) -> None:
super(MigrateSqlServerSqlDbTaskOutputMigrationLevel, self).__init__(**kwargs)
self.started_on = None
self.ended_on = None
self.duration_in_seconds = None
self.status = None
self.status_message = None
self.message = None
self.databases = None
self.database_summary = None
self.migration_validation_result = migration_validation_result
self.migration_report_result = migration_report_result
self.source_server_version = None
self.source_server_brand_version = None
self.target_server_version = None
self.target_server_brand_version = None
self.exceptions_and_warnings = None
self.result_type = 'MigrationLevelOutput'
[docs]class MigrateSqlServerSqlDbTaskOutputTableLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar object_name: Name of the item
:vartype object_name: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar state: Current state of migration. Possible values include: 'None',
'InProgress', 'Failed', 'Warning', 'Completed', 'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar status_message: Status message
:vartype status_message: str
:ivar items_count: Number of items
:vartype items_count: long
:ivar items_completed_count: Number of successfully completed items
:vartype items_completed_count: long
:ivar error_prefix: Wildcard string prefix to use for querying all errors
of the item
:vartype error_prefix: str
:ivar result_prefix: Wildcard string prefix to use for querying all
sub-tem results of the item
:vartype result_prefix: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'object_name': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'state': {'readonly': True},
'status_message': {'readonly': True},
'items_count': {'readonly': True},
'items_completed_count': {'readonly': True},
'error_prefix': {'readonly': True},
'result_prefix': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'object_name': {'key': 'objectName', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'state': {'key': 'state', 'type': 'str'},
'status_message': {'key': 'statusMessage', 'type': 'str'},
'items_count': {'key': 'itemsCount', 'type': 'long'},
'items_completed_count': {'key': 'itemsCompletedCount', 'type': 'long'},
'error_prefix': {'key': 'errorPrefix', 'type': 'str'},
'result_prefix': {'key': 'resultPrefix', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlDbTaskOutputTableLevel, self).__init__(**kwargs)
self.object_name = None
self.started_on = None
self.ended_on = None
self.state = None
self.status_message = None
self.items_count = None
self.items_completed_count = None
self.error_prefix = None
self.result_prefix = None
self.result_type = 'TableLevelOutput'
[docs]class MigrateSqlServerSqlDbTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.MigrateSqlServerSqlDbTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.MigrateSqlServerSqlDbTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MigrateSqlServerSqlDbTaskInput'},
'output': {'key': 'output', 'type': '[MigrateSqlServerSqlDbTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(MigrateSqlServerSqlDbTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Migrate.SqlServer.SqlDb'
[docs]class MigrateSqlServerSqlMISyncTaskOutput(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: MigrateSqlServerSqlMISyncTaskOutputError,
MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel,
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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
}
_subtype_map = {
'result_type': {'ErrorOutput': 'MigrateSqlServerSqlMISyncTaskOutputError', 'DatabaseLevelOutput': 'MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel', 'MigrationLevelOutput': 'MigrateSqlServerSqlMISyncTaskOutputMigrationLevel'}
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlMISyncTaskOutput, self).__init__(**kwargs)
self.id = None
self.result_type = None
[docs]class MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar source_database_name: Name of the database
:vartype source_database_name: str
:ivar migration_state: Current state of database. Possible values include:
'UNDEFINED', 'INITIAL', 'FULL_BACKUP_UPLOAD_START', 'LOG_SHIPPING_START',
'UPLOAD_LOG_FILES_START', 'CUTOVER_START', 'POST_CUTOVER_COMPLETE',
'COMPLETED', 'CANCELLED', 'FAILED'
:vartype migration_state: str or
~azure.mgmt.datamigration.models.DatabaseMigrationState
:ivar started_on: Database migration start time
:vartype started_on: datetime
:ivar ended_on: Database migration end time
:vartype ended_on: datetime
:ivar full_backup_set_info: Details of full backup set
:vartype full_backup_set_info:
~azure.mgmt.datamigration.models.BackupSetInfo
:ivar last_restored_backup_set_info: Last applied backup set information
:vartype last_restored_backup_set_info:
~azure.mgmt.datamigration.models.BackupSetInfo
:ivar active_backup_sets: Backup sets that are currently active (Either
being uploaded or getting restored)
:vartype active_backup_sets:
list[~azure.mgmt.datamigration.models.BackupSetInfo]
:ivar container_name: Name of container created in the Azure Storage
account where backups are copied to
:vartype container_name: str
:ivar error_prefix: prefix string to use for querying errors for this
database
:vartype error_prefix: str
:ivar is_full_backup_restored: Whether full backup has been applied to the
target database or not
:vartype is_full_backup_restored: bool
:ivar exceptions_and_warnings: Migration exceptions and warnings
:vartype exceptions_and_warnings:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'source_database_name': {'readonly': True},
'migration_state': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'full_backup_set_info': {'readonly': True},
'last_restored_backup_set_info': {'readonly': True},
'active_backup_sets': {'readonly': True},
'container_name': {'readonly': True},
'error_prefix': {'readonly': True},
'is_full_backup_restored': {'readonly': True},
'exceptions_and_warnings': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'source_database_name': {'key': 'sourceDatabaseName', 'type': 'str'},
'migration_state': {'key': 'migrationState', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'full_backup_set_info': {'key': 'fullBackupSetInfo', 'type': 'BackupSetInfo'},
'last_restored_backup_set_info': {'key': 'lastRestoredBackupSetInfo', 'type': 'BackupSetInfo'},
'active_backup_sets': {'key': 'activeBackupSets', 'type': '[BackupSetInfo]'},
'container_name': {'key': 'containerName', 'type': 'str'},
'error_prefix': {'key': 'errorPrefix', 'type': 'str'},
'is_full_backup_restored': {'key': 'isFullBackupRestored', 'type': 'bool'},
'exceptions_and_warnings': {'key': 'exceptionsAndWarnings', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel, self).__init__(**kwargs)
self.source_database_name = None
self.migration_state = None
self.started_on = None
self.ended_on = None
self.full_backup_set_info = None
self.last_restored_backup_set_info = None
self.active_backup_sets = None
self.container_name = None
self.error_prefix = None
self.is_full_backup_restored = None
self.exceptions_and_warnings = None
self.result_type = 'DatabaseLevelOutput'
[docs]class MigrateSqlServerSqlMISyncTaskOutputError(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar error: Migration error
:vartype error: ~azure.mgmt.datamigration.models.ReportableException
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'error': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'error': {'key': 'error', 'type': 'ReportableException'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlMISyncTaskOutputError, self).__init__(**kwargs)
self.error = None
self.result_type = 'ErrorOutput'
[docs]class MigrateSqlServerSqlMISyncTaskOutputMigrationLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar database_count: Count of databases
:vartype database_count: int
:ivar state: Current state of migration. Possible values include: 'None',
'InProgress', 'Failed', 'Warning', 'Completed', 'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar source_server_name: Source server name
:vartype source_server_name: str
:ivar source_server_version: Source server version
:vartype source_server_version: str
:ivar source_server_brand_version: Source server brand version
:vartype source_server_brand_version: str
:ivar target_server_name: Target server name
:vartype target_server_name: str
:ivar target_server_version: Target server version
:vartype target_server_version: str
:ivar target_server_brand_version: Target server brand version
:vartype target_server_brand_version: str
:ivar database_error_count: Number of database level errors
:vartype database_error_count: int
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'database_count': {'readonly': True},
'state': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'source_server_name': {'readonly': True},
'source_server_version': {'readonly': True},
'source_server_brand_version': {'readonly': True},
'target_server_name': {'readonly': True},
'target_server_version': {'readonly': True},
'target_server_brand_version': {'readonly': True},
'database_error_count': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'database_count': {'key': 'databaseCount', 'type': 'int'},
'state': {'key': 'state', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'source_server_name': {'key': 'sourceServerName', 'type': 'str'},
'source_server_version': {'key': 'sourceServerVersion', 'type': 'str'},
'source_server_brand_version': {'key': 'sourceServerBrandVersion', 'type': 'str'},
'target_server_name': {'key': 'targetServerName', 'type': 'str'},
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'target_server_brand_version': {'key': 'targetServerBrandVersion', 'type': 'str'},
'database_error_count': {'key': 'databaseErrorCount', 'type': 'int'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlMISyncTaskOutputMigrationLevel, self).__init__(**kwargs)
self.database_count = None
self.state = None
self.started_on = None
self.ended_on = None
self.source_server_name = None
self.source_server_version = None
self.source_server_brand_version = None
self.target_server_name = None
self.target_server_version = None
self.target_server_brand_version = None
self.database_error_count = None
self.result_type = 'MigrationLevelOutput'
[docs]class MigrateSqlServerSqlMISyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.MigrateSqlServerSqlMISyncTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.MigrateSqlServerSqlMISyncTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MigrateSqlServerSqlMISyncTaskInput'},
'output': {'key': 'output', 'type': '[MigrateSqlServerSqlMISyncTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(MigrateSqlServerSqlMISyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS'
[docs]class MigrateSqlServerSqlMITaskOutput(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: MigrateSqlServerSqlMITaskOutputError,
MigrateSqlServerSqlMITaskOutputLoginLevel,
MigrateSqlServerSqlMITaskOutputAgentJobLevel,
MigrateSqlServerSqlMITaskOutputDatabaseLevel,
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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
}
_subtype_map = {
'result_type': {'ErrorOutput': 'MigrateSqlServerSqlMITaskOutputError', 'LoginLevelOutput': 'MigrateSqlServerSqlMITaskOutputLoginLevel', 'AgentJobLevelOutput': 'MigrateSqlServerSqlMITaskOutputAgentJobLevel', 'DatabaseLevelOutput': 'MigrateSqlServerSqlMITaskOutputDatabaseLevel', 'MigrationLevelOutput': 'MigrateSqlServerSqlMITaskOutputMigrationLevel'}
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlMITaskOutput, self).__init__(**kwargs)
self.id = None
self.result_type = None
[docs]class MigrateSqlServerSqlMITaskOutputAgentJobLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar name: Agent Job name.
:vartype name: str
:ivar is_enabled: The state of the original Agent Job.
:vartype is_enabled: bool
:ivar state: Current state of migration. Possible values include: 'None',
'InProgress', 'Failed', 'Warning', 'Completed', 'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar message: Migration progress message
:vartype message: str
:ivar exceptions_and_warnings: Migration errors and warnings per job
:vartype exceptions_and_warnings:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'name': {'readonly': True},
'is_enabled': {'readonly': True},
'state': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'message': {'readonly': True},
'exceptions_and_warnings': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'is_enabled': {'key': 'isEnabled', 'type': 'bool'},
'state': {'key': 'state', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'message': {'key': 'message', 'type': 'str'},
'exceptions_and_warnings': {'key': 'exceptionsAndWarnings', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlMITaskOutputAgentJobLevel, self).__init__(**kwargs)
self.name = None
self.is_enabled = None
self.state = None
self.started_on = None
self.ended_on = None
self.message = None
self.exceptions_and_warnings = None
self.result_type = 'AgentJobLevelOutput'
[docs]class MigrateSqlServerSqlMITaskOutputDatabaseLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar database_name: Name of the database
:vartype database_name: str
:ivar size_mb: Size of the database in megabytes
:vartype size_mb: float
:ivar state: Current state of migration. Possible values include: 'None',
'InProgress', 'Failed', 'Warning', 'Completed', 'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar stage: Current stage of migration. Possible values include: 'None',
'Initialize', 'Backup', 'FileCopy', 'Restore', 'Completed'
:vartype stage: str or
~azure.mgmt.datamigration.models.DatabaseMigrationStage
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar message: Migration progress message
:vartype message: str
:ivar exceptions_and_warnings: Migration exceptions and warnings
:vartype exceptions_and_warnings:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'database_name': {'readonly': True},
'size_mb': {'readonly': True},
'state': {'readonly': True},
'stage': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'message': {'readonly': True},
'exceptions_and_warnings': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'database_name': {'key': 'databaseName', 'type': 'str'},
'size_mb': {'key': 'sizeMB', 'type': 'float'},
'state': {'key': 'state', 'type': 'str'},
'stage': {'key': 'stage', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'message': {'key': 'message', 'type': 'str'},
'exceptions_and_warnings': {'key': 'exceptionsAndWarnings', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlMITaskOutputDatabaseLevel, self).__init__(**kwargs)
self.database_name = None
self.size_mb = None
self.state = None
self.stage = None
self.started_on = None
self.ended_on = None
self.message = None
self.exceptions_and_warnings = None
self.result_type = 'DatabaseLevelOutput'
[docs]class MigrateSqlServerSqlMITaskOutputError(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar error: Migration error
:vartype error: ~azure.mgmt.datamigration.models.ReportableException
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'error': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'error': {'key': 'error', 'type': 'ReportableException'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlMITaskOutputError, self).__init__(**kwargs)
self.error = None
self.result_type = 'ErrorOutput'
[docs]class MigrateSqlServerSqlMITaskOutputLoginLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar login_name: Login name.
:vartype login_name: str
:ivar state: Current state of login. Possible values include: 'None',
'InProgress', 'Failed', 'Warning', 'Completed', 'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar stage: Current stage of login. Possible values include: 'None',
'Initialize', 'LoginMigration', 'EstablishUserMapping',
'AssignRoleMembership', 'AssignRoleOwnership',
'EstablishServerPermissions', 'EstablishObjectPermissions', 'Completed'
:vartype stage: str or
~azure.mgmt.datamigration.models.LoginMigrationStage
:ivar started_on: Login migration start time
:vartype started_on: datetime
:ivar ended_on: Login migration end time
:vartype ended_on: datetime
:ivar message: Login migration progress message
:vartype message: str
:ivar exceptions_and_warnings: Login migration errors and warnings per
login
:vartype exceptions_and_warnings:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'login_name': {'readonly': True},
'state': {'readonly': True},
'stage': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'message': {'readonly': True},
'exceptions_and_warnings': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'login_name': {'key': 'loginName', 'type': 'str'},
'state': {'key': 'state', 'type': 'str'},
'stage': {'key': 'stage', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'message': {'key': 'message', 'type': 'str'},
'exceptions_and_warnings': {'key': 'exceptionsAndWarnings', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlMITaskOutputLoginLevel, self).__init__(**kwargs)
self.login_name = None
self.state = None
self.stage = None
self.started_on = None
self.ended_on = None
self.message = None
self.exceptions_and_warnings = None
self.result_type = 'LoginLevelOutput'
[docs]class MigrateSqlServerSqlMITaskOutputMigrationLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar status: Current status of migration. Possible values include:
'Default', 'Connecting', 'SourceAndTargetSelected', 'SelectLogins',
'Configured', 'Running', 'Error', 'Stopped', 'Completed',
'CompletedWithWarnings'
:vartype status: str or ~azure.mgmt.datamigration.models.MigrationStatus
:ivar state: Current state of migration. Possible values include: 'None',
'InProgress', 'Failed', 'Warning', 'Completed', 'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar agent_jobs: Selected agent jobs as a map from name to id
:vartype agent_jobs: dict[str, str]
:ivar logins: Selected logins as a map from name to id
:vartype logins: dict[str, str]
:ivar message: Migration progress message
:vartype message: str
:ivar server_role_results: Map of server role migration results.
:vartype server_role_results: dict[str,
~azure.mgmt.datamigration.models.StartMigrationScenarioServerRoleResult]
:ivar orphaned_users_info: List of orphaned users.
:vartype orphaned_users_info:
list[~azure.mgmt.datamigration.models.OrphanedUserInfo]
:ivar databases: Selected databases as a map from database name to
database id
:vartype databases: dict[str, str]
:ivar source_server_version: Source server version
:vartype source_server_version: str
:ivar source_server_brand_version: Source server brand version
:vartype source_server_brand_version: str
:ivar target_server_version: Target server version
:vartype target_server_version: str
:ivar target_server_brand_version: Target server brand version
:vartype target_server_brand_version: str
:ivar exceptions_and_warnings: Migration exceptions and warnings.
:vartype exceptions_and_warnings:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'status': {'readonly': True},
'state': {'readonly': True},
'agent_jobs': {'readonly': True},
'logins': {'readonly': True},
'message': {'readonly': True},
'server_role_results': {'readonly': True},
'orphaned_users_info': {'readonly': True},
'databases': {'readonly': True},
'source_server_version': {'readonly': True},
'source_server_brand_version': {'readonly': True},
'target_server_version': {'readonly': True},
'target_server_brand_version': {'readonly': True},
'exceptions_and_warnings': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'status': {'key': 'status', 'type': 'str'},
'state': {'key': 'state', 'type': 'str'},
'agent_jobs': {'key': 'agentJobs', 'type': '{str}'},
'logins': {'key': 'logins', 'type': '{str}'},
'message': {'key': 'message', 'type': 'str'},
'server_role_results': {'key': 'serverRoleResults', 'type': '{StartMigrationScenarioServerRoleResult}'},
'orphaned_users_info': {'key': 'orphanedUsersInfo', 'type': '[OrphanedUserInfo]'},
'databases': {'key': 'databases', 'type': '{str}'},
'source_server_version': {'key': 'sourceServerVersion', 'type': 'str'},
'source_server_brand_version': {'key': 'sourceServerBrandVersion', 'type': 'str'},
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'target_server_brand_version': {'key': 'targetServerBrandVersion', 'type': 'str'},
'exceptions_and_warnings': {'key': 'exceptionsAndWarnings', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSqlServerSqlMITaskOutputMigrationLevel, self).__init__(**kwargs)
self.started_on = None
self.ended_on = None
self.status = None
self.state = None
self.agent_jobs = None
self.logins = None
self.message = None
self.server_role_results = None
self.orphaned_users_info = None
self.databases = None
self.source_server_version = None
self.source_server_brand_version = None
self.target_server_version = None
self.target_server_brand_version = None
self.exceptions_and_warnings = None
self.result_type = 'MigrationLevelOutput'
[docs]class MigrateSqlServerSqlMITaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input:
~azure.mgmt.datamigration.models.MigrateSqlServerSqlMITaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.MigrateSqlServerSqlMITaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MigrateSqlServerSqlMITaskInput'},
'output': {'key': 'output', 'type': '[MigrateSqlServerSqlMITaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(MigrateSqlServerSqlMITaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Migrate.SqlServer.AzureSqlDbMI'
[docs]class MigrateSsisTaskOutput(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: MigrateSsisTaskOutputProjectLevel,
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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
}
_subtype_map = {
'result_type': {'SsisProjectLevelOutput': 'MigrateSsisTaskOutputProjectLevel', 'MigrationLevelOutput': 'MigrateSsisTaskOutputMigrationLevel'}
}
def __init__(self, **kwargs) -> None:
super(MigrateSsisTaskOutput, self).__init__(**kwargs)
self.id = None
self.result_type = None
[docs]class MigrateSsisTaskOutputMigrationLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar status: Current status of migration. Possible values include:
'Default', 'Connecting', 'SourceAndTargetSelected', 'SelectLogins',
'Configured', 'Running', 'Error', 'Stopped', 'Completed',
'CompletedWithWarnings'
:vartype status: str or ~azure.mgmt.datamigration.models.MigrationStatus
:ivar message: Migration progress message
:vartype message: str
:ivar source_server_version: Source server version
:vartype source_server_version: str
:ivar source_server_brand_version: Source server brand version
:vartype source_server_brand_version: str
:ivar target_server_version: Target server version
:vartype target_server_version: str
:ivar target_server_brand_version: Target server brand version
:vartype target_server_brand_version: str
:ivar exceptions_and_warnings: Migration exceptions and warnings.
:vartype exceptions_and_warnings:
list[~azure.mgmt.datamigration.models.ReportableException]
:ivar stage: Stage of SSIS migration. Possible values include: 'None',
'Initialize', 'InProgress', 'Completed'
:vartype stage: str or ~azure.mgmt.datamigration.models.SsisMigrationStage
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'status': {'readonly': True},
'message': {'readonly': True},
'source_server_version': {'readonly': True},
'source_server_brand_version': {'readonly': True},
'target_server_version': {'readonly': True},
'target_server_brand_version': {'readonly': True},
'exceptions_and_warnings': {'readonly': True},
'stage': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'status': {'key': 'status', 'type': 'str'},
'message': {'key': 'message', 'type': 'str'},
'source_server_version': {'key': 'sourceServerVersion', 'type': 'str'},
'source_server_brand_version': {'key': 'sourceServerBrandVersion', 'type': 'str'},
'target_server_version': {'key': 'targetServerVersion', 'type': 'str'},
'target_server_brand_version': {'key': 'targetServerBrandVersion', 'type': 'str'},
'exceptions_and_warnings': {'key': 'exceptionsAndWarnings', 'type': '[ReportableException]'},
'stage': {'key': 'stage', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSsisTaskOutputMigrationLevel, self).__init__(**kwargs)
self.started_on = None
self.ended_on = None
self.status = None
self.message = None
self.source_server_version = None
self.source_server_brand_version = None
self.target_server_version = None
self.target_server_brand_version = None
self.exceptions_and_warnings = None
self.stage = None
self.result_type = 'MigrationLevelOutput'
[docs]class MigrateSsisTaskOutputProjectLevel(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.
:ivar id: Result identifier
:vartype id: str
:param result_type: Required. Constant filled by server.
:type result_type: str
:ivar folder_name: Name of the folder
:vartype folder_name: str
:ivar project_name: Name of the project
:vartype project_name: str
:ivar state: Current state of migration. Possible values include: 'None',
'InProgress', 'Failed', 'Warning', 'Completed', 'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar stage: Stage of SSIS migration. Possible values include: 'None',
'Initialize', 'InProgress', 'Completed'
:vartype stage: str or ~azure.mgmt.datamigration.models.SsisMigrationStage
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar message: Migration progress message
:vartype message: str
:ivar exceptions_and_warnings: Migration exceptions and warnings
:vartype exceptions_and_warnings:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'result_type': {'required': True},
'folder_name': {'readonly': True},
'project_name': {'readonly': True},
'state': {'readonly': True},
'stage': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'message': {'readonly': True},
'exceptions_and_warnings': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'folder_name': {'key': 'folderName', 'type': 'str'},
'project_name': {'key': 'projectName', 'type': 'str'},
'state': {'key': 'state', 'type': 'str'},
'stage': {'key': 'stage', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'message': {'key': 'message', 'type': 'str'},
'exceptions_and_warnings': {'key': 'exceptionsAndWarnings', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSsisTaskOutputProjectLevel, self).__init__(**kwargs)
self.folder_name = None
self.project_name = None
self.state = None
self.stage = None
self.started_on = None
self.ended_on = None
self.message = None
self.exceptions_and_warnings = None
self.result_type = 'SsisProjectLevelOutput'
[docs]class MigrateSsisTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input: Task input
:type input: ~azure.mgmt.datamigration.models.MigrateSsisTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.MigrateSsisTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MigrateSsisTaskInput'},
'output': {'key': 'output', 'type': '[MigrateSsisTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(MigrateSsisTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Migrate.Ssis'
[docs]class MigrateSyncCompleteCommandOutput(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.
:ivar id: Result identifier
:vartype id: str
:ivar errors: List of errors that happened during the command execution
:vartype errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'id': {'readonly': True},
'errors': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'errors': {'key': 'errors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(MigrateSyncCompleteCommandOutput, self).__init__(**kwargs)
self.id = None
self.errors = None
[docs]class MigrateSyncCompleteCommandProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the command. This is ignored if submitted.
Possible values include: 'Unknown', 'Accepted', 'Running', 'Succeeded',
'Failed'
:vartype state: str or ~azure.mgmt.datamigration.models.CommandState
:param command_type: Required. Constant filled by server.
:type command_type: str
:param input: Command input
:type input:
~azure.mgmt.datamigration.models.MigrateSyncCompleteCommandInput
:ivar output: Command output. This is ignored if submitted.
:vartype output:
~azure.mgmt.datamigration.models.MigrateSyncCompleteCommandOutput
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'command_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'command_type': {'key': 'commandType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MigrateSyncCompleteCommandInput'},
'output': {'key': 'output', 'type': 'MigrateSyncCompleteCommandOutput'},
}
def __init__(self, *, input=None, **kwargs) -> None:
super(MigrateSyncCompleteCommandProperties, self).__init__(**kwargs)
self.input = input
self.output = None
self.command_type = 'Migrate.Sync.Complete.Database'
[docs]class MigrationEligibilityInfo(Model):
"""Information about migration eligibility of a server object.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar is_eligible_for_migration: Whether object is eligible for migration
or not.
:vartype is_eligible_for_migration: bool
:ivar validation_messages: Information about eligibility failure for the
server object.
:vartype validation_messages: list[str]
"""
_validation = {
'is_eligible_for_migration': {'readonly': True},
'validation_messages': {'readonly': True},
}
_attribute_map = {
'is_eligible_for_migration': {'key': 'isEligibleForMigration', 'type': 'bool'},
'validation_messages': {'key': 'validationMessages', 'type': '[str]'},
}
def __init__(self, **kwargs) -> None:
super(MigrationEligibilityInfo, self).__init__(**kwargs)
self.is_eligible_for_migration = None
self.validation_messages = None
[docs]class MigrationReportResult(Model):
"""Migration validation report result, contains the url for downloading the
generated report.
:param id: Migration validation result identifier
:type id: str
:param report_url: The url of the report.
:type report_url: str
"""
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'report_url': {'key': 'reportUrl', 'type': 'str'},
}
def __init__(self, *, id: str=None, report_url: str=None, **kwargs) -> None:
super(MigrationReportResult, self).__init__(**kwargs)
self.id = id
self.report_url = report_url
[docs]class MigrationValidationDatabaseLevelResult(Model):
"""Database level validation results.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Result identifier
:vartype id: str
:ivar migration_id: Migration Identifier
:vartype migration_id: str
:ivar source_database_name: Name of the source database
:vartype source_database_name: str
:ivar target_database_name: Name of the target database
:vartype target_database_name: str
:ivar started_on: Validation start time
:vartype started_on: datetime
:ivar ended_on: Validation end time
:vartype ended_on: datetime
:ivar data_integrity_validation_result: Provides data integrity validation
result between the source and target tables that are migrated.
:vartype data_integrity_validation_result:
~azure.mgmt.datamigration.models.DataIntegrityValidationResult
:ivar schema_validation_result: Provides schema comparison result between
source and target database
:vartype schema_validation_result:
~azure.mgmt.datamigration.models.SchemaComparisonValidationResult
:ivar query_analysis_validation_result: Results of some of the query
execution result between source and target database
:vartype query_analysis_validation_result:
~azure.mgmt.datamigration.models.QueryAnalysisValidationResult
:ivar status: Current status of validation at the database level. Possible
values include: 'Default', 'NotStarted', 'Initialized', 'InProgress',
'Completed', 'CompletedWithIssues', 'Stopped', 'Failed'
:vartype status: str or ~azure.mgmt.datamigration.models.ValidationStatus
"""
_validation = {
'id': {'readonly': True},
'migration_id': {'readonly': True},
'source_database_name': {'readonly': True},
'target_database_name': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'data_integrity_validation_result': {'readonly': True},
'schema_validation_result': {'readonly': True},
'query_analysis_validation_result': {'readonly': True},
'status': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'migration_id': {'key': 'migrationId', 'type': 'str'},
'source_database_name': {'key': 'sourceDatabaseName', 'type': 'str'},
'target_database_name': {'key': 'targetDatabaseName', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'data_integrity_validation_result': {'key': 'dataIntegrityValidationResult', 'type': 'DataIntegrityValidationResult'},
'schema_validation_result': {'key': 'schemaValidationResult', 'type': 'SchemaComparisonValidationResult'},
'query_analysis_validation_result': {'key': 'queryAnalysisValidationResult', 'type': 'QueryAnalysisValidationResult'},
'status': {'key': 'status', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(MigrationValidationDatabaseLevelResult, self).__init__(**kwargs)
self.id = None
self.migration_id = None
self.source_database_name = None
self.target_database_name = None
self.started_on = None
self.ended_on = None
self.data_integrity_validation_result = None
self.schema_validation_result = None
self.query_analysis_validation_result = None
self.status = None
[docs]class MigrationValidationDatabaseSummaryResult(Model):
"""Migration Validation Database level summary result.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Result identifier
:vartype id: str
:ivar migration_id: Migration Identifier
:vartype migration_id: str
:ivar source_database_name: Name of the source database
:vartype source_database_name: str
:ivar target_database_name: Name of the target database
:vartype target_database_name: str
:ivar started_on: Validation start time
:vartype started_on: datetime
:ivar ended_on: Validation end time
:vartype ended_on: datetime
:ivar status: Current status of validation at the database level. Possible
values include: 'Default', 'NotStarted', 'Initialized', 'InProgress',
'Completed', 'CompletedWithIssues', 'Stopped', 'Failed'
:vartype status: str or ~azure.mgmt.datamigration.models.ValidationStatus
"""
_validation = {
'id': {'readonly': True},
'migration_id': {'readonly': True},
'source_database_name': {'readonly': True},
'target_database_name': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'status': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'migration_id': {'key': 'migrationId', 'type': 'str'},
'source_database_name': {'key': 'sourceDatabaseName', 'type': 'str'},
'target_database_name': {'key': 'targetDatabaseName', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'status': {'key': 'status', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(MigrationValidationDatabaseSummaryResult, self).__init__(**kwargs)
self.id = None
self.migration_id = None
self.source_database_name = None
self.target_database_name = None
self.started_on = None
self.ended_on = None
self.status = None
[docs]class MigrationValidationOptions(Model):
"""Types of validations to run after the migration.
:param enable_schema_validation: Allows to compare the schema information
between source and target.
:type enable_schema_validation: bool
:param enable_data_integrity_validation: Allows to perform a checksum
based data integrity validation between source and target for the selected
database / tables .
:type enable_data_integrity_validation: bool
:param enable_query_analysis_validation: 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.
:type enable_query_analysis_validation: bool
"""
_attribute_map = {
'enable_schema_validation': {'key': 'enableSchemaValidation', 'type': 'bool'},
'enable_data_integrity_validation': {'key': 'enableDataIntegrityValidation', 'type': 'bool'},
'enable_query_analysis_validation': {'key': 'enableQueryAnalysisValidation', 'type': 'bool'},
}
def __init__(self, *, enable_schema_validation: bool=None, enable_data_integrity_validation: bool=None, enable_query_analysis_validation: bool=None, **kwargs) -> None:
super(MigrationValidationOptions, self).__init__(**kwargs)
self.enable_schema_validation = enable_schema_validation
self.enable_data_integrity_validation = enable_data_integrity_validation
self.enable_query_analysis_validation = enable_query_analysis_validation
[docs]class MigrationValidationResult(Model):
"""Migration Validation Result.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Migration validation result identifier
:vartype id: str
:ivar migration_id: Migration Identifier
:vartype migration_id: str
:param summary_results: Validation summary results for each database
:type summary_results: dict[str,
~azure.mgmt.datamigration.models.MigrationValidationDatabaseSummaryResult]
:ivar status: Current status of validation at the migration level. Status
from the database validation result status will be aggregated here.
Possible values include: 'Default', 'NotStarted', 'Initialized',
'InProgress', 'Completed', 'CompletedWithIssues', 'Stopped', 'Failed'
:vartype status: str or ~azure.mgmt.datamigration.models.ValidationStatus
"""
_validation = {
'id': {'readonly': True},
'migration_id': {'readonly': True},
'status': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'migration_id': {'key': 'migrationId', 'type': 'str'},
'summary_results': {'key': 'summaryResults', 'type': '{MigrationValidationDatabaseSummaryResult}'},
'status': {'key': 'status', 'type': 'str'},
}
def __init__(self, *, summary_results=None, **kwargs) -> None:
super(MigrationValidationResult, self).__init__(**kwargs)
self.id = None
self.migration_id = None
self.summary_results = summary_results
self.status = None
[docs]class MiSqlConnectionInfo(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.
:param user_name: User name
:type user_name: str
:param password: Password credential.
:type password: str
:param type: Required. Constant filled by server.
:type type: str
:param managed_instance_resource_id: Required. Resource id for Azure SQL
database Managed instance
:type managed_instance_resource_id: str
"""
_validation = {
'type': {'required': True},
'managed_instance_resource_id': {'required': True},
}
_attribute_map = {
'user_name': {'key': 'userName', 'type': 'str'},
'password': {'key': 'password', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'managed_instance_resource_id': {'key': 'managedInstanceResourceId', 'type': 'str'},
}
def __init__(self, *, managed_instance_resource_id: str, user_name: str=None, password: str=None, **kwargs) -> None:
super(MiSqlConnectionInfo, self).__init__(user_name=user_name, password=password, **kwargs)
self.managed_instance_resource_id = managed_instance_resource_id
self.type = 'MiSqlConnectionInfo'
[docs]class MongoDbCancelCommand(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the command. This is ignored if submitted.
Possible values include: 'Unknown', 'Accepted', 'Running', 'Succeeded',
'Failed'
:vartype state: str or ~azure.mgmt.datamigration.models.CommandState
:param command_type: Required. Constant filled by server.
:type command_type: str
:param input: Command input
:type input: ~azure.mgmt.datamigration.models.MongoDbCommandInput
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'command_type': {'required': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'command_type': {'key': 'commandType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MongoDbCommandInput'},
}
def __init__(self, *, input=None, **kwargs) -> None:
super(MongoDbCancelCommand, self).__init__(**kwargs)
self.input = input
self.command_type = 'cancel'
[docs]class MongoDbClusterInfo(Model):
"""Describes a MongoDB data source.
All required parameters must be populated in order to send to Azure.
:param databases: Required. A list of non-system databases in the cluster
:type databases:
list[~azure.mgmt.datamigration.models.MongoDbDatabaseInfo]
:param supports_sharding: Required. Whether the cluster supports sharded
collections
:type supports_sharding: bool
:param type: Required. The type of data source. Possible values include:
'BlobContainer', 'CosmosDb', 'MongoDb'
:type type: str or ~azure.mgmt.datamigration.models.MongoDbClusterType
:param version: Required. The version of the data source in the form x.y.z
(e.g. 3.6.7). Not used if Type is BlobContainer.
:type version: str
"""
_validation = {
'databases': {'required': True},
'supports_sharding': {'required': True},
'type': {'required': True},
'version': {'required': True},
}
_attribute_map = {
'databases': {'key': 'databases', 'type': '[MongoDbDatabaseInfo]'},
'supports_sharding': {'key': 'supportsSharding', 'type': 'bool'},
'type': {'key': 'type', 'type': 'str'},
'version': {'key': 'version', 'type': 'str'},
}
def __init__(self, *, databases, supports_sharding: bool, type, version: str, **kwargs) -> None:
super(MongoDbClusterInfo, self).__init__(**kwargs)
self.databases = databases
self.supports_sharding = supports_sharding
self.type = type
self.version = version
[docs]class MongoDbObjectInfo(Model):
"""Describes a database or collection within a MongoDB data source.
All required parameters must be populated in order to send to Azure.
:param average_document_size: Required. The average document size, or -1
if the average size is unknown
:type average_document_size: long
:param data_size: Required. The estimated total data size, in bytes, or -1
if the size is unknown.
:type data_size: long
:param document_count: Required. The estimated total number of documents,
or -1 if the document count is unknown
:type document_count: long
:param name: Required. The unqualified name of the database or collection
:type name: str
:param qualified_name: Required. The qualified name of the database or
collection. For a collection, this is the database-qualified name.
:type qualified_name: str
"""
_validation = {
'average_document_size': {'required': True},
'data_size': {'required': True},
'document_count': {'required': True},
'name': {'required': True},
'qualified_name': {'required': True},
}
_attribute_map = {
'average_document_size': {'key': 'averageDocumentSize', 'type': 'long'},
'data_size': {'key': 'dataSize', 'type': 'long'},
'document_count': {'key': 'documentCount', 'type': 'long'},
'name': {'key': 'name', 'type': 'str'},
'qualified_name': {'key': 'qualifiedName', 'type': 'str'},
}
def __init__(self, *, average_document_size: int, data_size: int, document_count: int, name: str, qualified_name: str, **kwargs) -> None:
super(MongoDbObjectInfo, self).__init__(**kwargs)
self.average_document_size = average_document_size
self.data_size = data_size
self.document_count = document_count
self.name = name
self.qualified_name = qualified_name
[docs]class MongoDbCollectionInfo(MongoDbObjectInfo):
"""Describes a supported collection within a MongoDB database.
All required parameters must be populated in order to send to Azure.
:param average_document_size: Required. The average document size, or -1
if the average size is unknown
:type average_document_size: long
:param data_size: Required. The estimated total data size, in bytes, or -1
if the size is unknown.
:type data_size: long
:param document_count: Required. The estimated total number of documents,
or -1 if the document count is unknown
:type document_count: long
:param name: Required. The unqualified name of the database or collection
:type name: str
:param qualified_name: Required. The qualified name of the database or
collection. For a collection, this is the database-qualified name.
:type qualified_name: str
:param database_name: Required. The name of the database containing the
collection
:type database_name: str
:param is_capped: Required. Whether the collection is a capped collection
(i.e. whether it has a fixed size and acts like a circular buffer)
:type is_capped: bool
:param is_system_collection: Required. Whether the collection is system
collection
:type is_system_collection: bool
:param is_view: Required. Whether the collection is a view of another
collection
:type is_view: bool
:param shard_key: The shard key on the collection, or null if the
collection is not sharded
:type shard_key: ~azure.mgmt.datamigration.models.MongoDbShardKeyInfo
:param supports_sharding: Required. Whether the database has sharding
enabled. Note that the migration task will enable sharding on the target
if necessary.
:type supports_sharding: bool
:param view_of: The name of the collection that this is a view of, if
IsView is true
:type view_of: str
"""
_validation = {
'average_document_size': {'required': True},
'data_size': {'required': True},
'document_count': {'required': True},
'name': {'required': True},
'qualified_name': {'required': True},
'database_name': {'required': True},
'is_capped': {'required': True},
'is_system_collection': {'required': True},
'is_view': {'required': True},
'supports_sharding': {'required': True},
}
_attribute_map = {
'average_document_size': {'key': 'averageDocumentSize', 'type': 'long'},
'data_size': {'key': 'dataSize', 'type': 'long'},
'document_count': {'key': 'documentCount', 'type': 'long'},
'name': {'key': 'name', 'type': 'str'},
'qualified_name': {'key': 'qualifiedName', 'type': 'str'},
'database_name': {'key': 'databaseName', 'type': 'str'},
'is_capped': {'key': 'isCapped', 'type': 'bool'},
'is_system_collection': {'key': 'isSystemCollection', 'type': 'bool'},
'is_view': {'key': 'isView', 'type': 'bool'},
'shard_key': {'key': 'shardKey', 'type': 'MongoDbShardKeyInfo'},
'supports_sharding': {'key': 'supportsSharding', 'type': 'bool'},
'view_of': {'key': 'viewOf', 'type': 'str'},
}
def __init__(self, *, 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=None, view_of: str=None, **kwargs) -> None:
super(MongoDbCollectionInfo, self).__init__(average_document_size=average_document_size, data_size=data_size, document_count=document_count, name=name, qualified_name=qualified_name, **kwargs)
self.database_name = database_name
self.is_capped = is_capped
self.is_system_collection = is_system_collection
self.is_view = is_view
self.shard_key = shard_key
self.supports_sharding = supports_sharding
self.view_of = view_of
[docs]class MongoDbProgress(Model):
"""Base class for MongoDB migration outputs.
All required parameters must be populated in order to send to Azure.
:param bytes_copied: Required. The number of document bytes copied during
the Copying stage
:type bytes_copied: long
:param documents_copied: Required. The number of documents copied during
the Copying stage
:type documents_copied: long
:param elapsed_time: Required. The elapsed time in the format
[ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)
:type elapsed_time: str
:param errors: Required. The errors and warnings that have occurred for
the current object. The keys are the error codes.
:type errors: dict[str, ~azure.mgmt.datamigration.models.MongoDbError]
:param events_pending: Required. The number of oplog events awaiting
replay
:type events_pending: long
:param events_replayed: Required. The number of oplog events replayed so
far
:type events_replayed: long
:param last_event_time: The timestamp of the last oplog event received, or
null if no oplog event has been received yet
:type last_event_time: datetime
:param last_replay_time: The timestamp of the last oplog event replayed,
or null if no oplog event has been replayed yet
:type last_replay_time: datetime
:param name: 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.
:type name: str
:param qualified_name: 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.
:type qualified_name: str
:param result_type: Required. The type of progress object. Possible values
include: 'Migration', 'Database', 'Collection'
:type result_type: str or ~azure.mgmt.datamigration.models.enum
:param state: Required. Possible values include: 'NotStarted',
'ValidatingInput', 'Initializing', 'Restarting', 'Copying',
'InitialReplay', 'Replaying', 'Finalizing', 'Complete', 'Canceled',
'Failed'
:type state: str or ~azure.mgmt.datamigration.models.MongoDbMigrationState
:param total_bytes: Required. The total number of document bytes on the
source at the beginning of the Copying stage, or -1 if the total size was
unknown
:type total_bytes: long
:param total_documents: Required. The total number of documents on the
source at the beginning of the Copying stage, or -1 if the total count was
unknown
:type total_documents: long
"""
_validation = {
'bytes_copied': {'required': True},
'documents_copied': {'required': True},
'elapsed_time': {'required': True},
'errors': {'required': True},
'events_pending': {'required': True},
'events_replayed': {'required': True},
'result_type': {'required': True},
'state': {'required': True},
'total_bytes': {'required': True},
'total_documents': {'required': True},
}
_attribute_map = {
'bytes_copied': {'key': 'bytesCopied', 'type': 'long'},
'documents_copied': {'key': 'documentsCopied', 'type': 'long'},
'elapsed_time': {'key': 'elapsedTime', 'type': 'str'},
'errors': {'key': 'errors', 'type': '{MongoDbError}'},
'events_pending': {'key': 'eventsPending', 'type': 'long'},
'events_replayed': {'key': 'eventsReplayed', 'type': 'long'},
'last_event_time': {'key': 'lastEventTime', 'type': 'iso-8601'},
'last_replay_time': {'key': 'lastReplayTime', 'type': 'iso-8601'},
'name': {'key': 'name', 'type': 'str'},
'qualified_name': {'key': 'qualifiedName', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'state': {'key': 'state', 'type': 'str'},
'total_bytes': {'key': 'totalBytes', 'type': 'long'},
'total_documents': {'key': 'totalDocuments', 'type': 'long'},
}
def __init__(self, *, bytes_copied: int, documents_copied: int, elapsed_time: str, errors, events_pending: int, events_replayed: int, result_type, state, total_bytes: int, total_documents: int, last_event_time=None, last_replay_time=None, name: str=None, qualified_name: str=None, **kwargs) -> None:
super(MongoDbProgress, self).__init__(**kwargs)
self.bytes_copied = bytes_copied
self.documents_copied = documents_copied
self.elapsed_time = elapsed_time
self.errors = errors
self.events_pending = events_pending
self.events_replayed = events_replayed
self.last_event_time = last_event_time
self.last_replay_time = last_replay_time
self.name = name
self.qualified_name = qualified_name
self.result_type = result_type
self.state = state
self.total_bytes = total_bytes
self.total_documents = total_documents
[docs]class MongoDbCollectionProgress(MongoDbProgress):
"""Describes the progress of a collection.
All required parameters must be populated in order to send to Azure.
:param bytes_copied: Required. The number of document bytes copied during
the Copying stage
:type bytes_copied: long
:param documents_copied: Required. The number of documents copied during
the Copying stage
:type documents_copied: long
:param elapsed_time: Required. The elapsed time in the format
[ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)
:type elapsed_time: str
:param errors: Required. The errors and warnings that have occurred for
the current object. The keys are the error codes.
:type errors: dict[str, ~azure.mgmt.datamigration.models.MongoDbError]
:param events_pending: Required. The number of oplog events awaiting
replay
:type events_pending: long
:param events_replayed: Required. The number of oplog events replayed so
far
:type events_replayed: long
:param last_event_time: The timestamp of the last oplog event received, or
null if no oplog event has been received yet
:type last_event_time: datetime
:param last_replay_time: The timestamp of the last oplog event replayed,
or null if no oplog event has been replayed yet
:type last_replay_time: datetime
:param name: 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.
:type name: str
:param qualified_name: 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.
:type qualified_name: str
:param result_type: Required. The type of progress object. Possible values
include: 'Migration', 'Database', 'Collection'
:type result_type: str or ~azure.mgmt.datamigration.models.enum
:param state: Required. Possible values include: 'NotStarted',
'ValidatingInput', 'Initializing', 'Restarting', 'Copying',
'InitialReplay', 'Replaying', 'Finalizing', 'Complete', 'Canceled',
'Failed'
:type state: str or ~azure.mgmt.datamigration.models.MongoDbMigrationState
:param total_bytes: Required. The total number of document bytes on the
source at the beginning of the Copying stage, or -1 if the total size was
unknown
:type total_bytes: long
:param total_documents: Required. The total number of documents on the
source at the beginning of the Copying stage, or -1 if the total count was
unknown
:type total_documents: long
"""
_validation = {
'bytes_copied': {'required': True},
'documents_copied': {'required': True},
'elapsed_time': {'required': True},
'errors': {'required': True},
'events_pending': {'required': True},
'events_replayed': {'required': True},
'result_type': {'required': True},
'state': {'required': True},
'total_bytes': {'required': True},
'total_documents': {'required': True},
}
_attribute_map = {
'bytes_copied': {'key': 'bytesCopied', 'type': 'long'},
'documents_copied': {'key': 'documentsCopied', 'type': 'long'},
'elapsed_time': {'key': 'elapsedTime', 'type': 'str'},
'errors': {'key': 'errors', 'type': '{MongoDbError}'},
'events_pending': {'key': 'eventsPending', 'type': 'long'},
'events_replayed': {'key': 'eventsReplayed', 'type': 'long'},
'last_event_time': {'key': 'lastEventTime', 'type': 'iso-8601'},
'last_replay_time': {'key': 'lastReplayTime', 'type': 'iso-8601'},
'name': {'key': 'name', 'type': 'str'},
'qualified_name': {'key': 'qualifiedName', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'state': {'key': 'state', 'type': 'str'},
'total_bytes': {'key': 'totalBytes', 'type': 'long'},
'total_documents': {'key': 'totalDocuments', 'type': 'long'},
}
def __init__(self, *, bytes_copied: int, documents_copied: int, elapsed_time: str, errors, events_pending: int, events_replayed: int, result_type, state, total_bytes: int, total_documents: int, last_event_time=None, last_replay_time=None, name: str=None, qualified_name: str=None, **kwargs) -> None:
super(MongoDbCollectionProgress, self).__init__(bytes_copied=bytes_copied, documents_copied=documents_copied, elapsed_time=elapsed_time, errors=errors, events_pending=events_pending, events_replayed=events_replayed, last_event_time=last_event_time, last_replay_time=last_replay_time, name=name, qualified_name=qualified_name, result_type=result_type, state=state, total_bytes=total_bytes, total_documents=total_documents, **kwargs)
[docs]class MongoDbCollectionSettings(Model):
"""Describes how an individual MongoDB collection should be migrated.
:param can_delete: Whether the migrator is allowed to drop the target
collection in the course of performing a migration. The default is true.
:type can_delete: bool
:param shard_key:
:type shard_key: ~azure.mgmt.datamigration.models.MongoDbShardKeySetting
:param target_rus: The RUs that should be configured on a CosmosDB target,
or null to use the default. This has no effect on non-CosmosDB targets.
:type target_rus: int
"""
_attribute_map = {
'can_delete': {'key': 'canDelete', 'type': 'bool'},
'shard_key': {'key': 'shardKey', 'type': 'MongoDbShardKeySetting'},
'target_rus': {'key': 'targetRUs', 'type': 'int'},
}
def __init__(self, *, can_delete: bool=None, shard_key=None, target_rus: int=None, **kwargs) -> None:
super(MongoDbCollectionSettings, self).__init__(**kwargs)
self.can_delete = can_delete
self.shard_key = shard_key
self.target_rus = target_rus
[docs]class MongoDbConnectionInfo(ConnectionInfo):
"""Describes a connection to a MongoDB data source.
All required parameters must be populated in order to send to Azure.
:param user_name: User name
:type user_name: str
:param password: Password credential.
:type password: str
:param type: Required. Constant filled by server.
:type type: str
:param connection_string: Required. A MongoDB connection string or blob
container URL. The user name and password can be specified here or in the
userName and password properties
:type connection_string: str
"""
_validation = {
'type': {'required': True},
'connection_string': {'required': True},
}
_attribute_map = {
'user_name': {'key': 'userName', 'type': 'str'},
'password': {'key': 'password', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'connection_string': {'key': 'connectionString', 'type': 'str'},
}
def __init__(self, *, connection_string: str, user_name: str=None, password: str=None, **kwargs) -> None:
super(MongoDbConnectionInfo, self).__init__(user_name=user_name, password=password, **kwargs)
self.connection_string = connection_string
self.type = 'MongoDbConnectionInfo'
[docs]class MongoDbDatabaseInfo(MongoDbObjectInfo):
"""Describes a database within a MongoDB data source.
All required parameters must be populated in order to send to Azure.
:param average_document_size: Required. The average document size, or -1
if the average size is unknown
:type average_document_size: long
:param data_size: Required. The estimated total data size, in bytes, or -1
if the size is unknown.
:type data_size: long
:param document_count: Required. The estimated total number of documents,
or -1 if the document count is unknown
:type document_count: long
:param name: Required. The unqualified name of the database or collection
:type name: str
:param qualified_name: Required. The qualified name of the database or
collection. For a collection, this is the database-qualified name.
:type qualified_name: str
:param collections: Required. A list of supported collections in a MongoDB
database
:type collections:
list[~azure.mgmt.datamigration.models.MongoDbCollectionInfo]
:param supports_sharding: Required. Whether the database has sharding
enabled. Note that the migration task will enable sharding on the target
if necessary.
:type supports_sharding: bool
"""
_validation = {
'average_document_size': {'required': True},
'data_size': {'required': True},
'document_count': {'required': True},
'name': {'required': True},
'qualified_name': {'required': True},
'collections': {'required': True},
'supports_sharding': {'required': True},
}
_attribute_map = {
'average_document_size': {'key': 'averageDocumentSize', 'type': 'long'},
'data_size': {'key': 'dataSize', 'type': 'long'},
'document_count': {'key': 'documentCount', 'type': 'long'},
'name': {'key': 'name', 'type': 'str'},
'qualified_name': {'key': 'qualifiedName', 'type': 'str'},
'collections': {'key': 'collections', 'type': '[MongoDbCollectionInfo]'},
'supports_sharding': {'key': 'supportsSharding', 'type': 'bool'},
}
def __init__(self, *, average_document_size: int, data_size: int, document_count: int, name: str, qualified_name: str, collections, supports_sharding: bool, **kwargs) -> None:
super(MongoDbDatabaseInfo, self).__init__(average_document_size=average_document_size, data_size=data_size, document_count=document_count, name=name, qualified_name=qualified_name, **kwargs)
self.collections = collections
self.supports_sharding = supports_sharding
[docs]class MongoDbDatabaseProgress(MongoDbProgress):
"""Describes the progress of a database.
All required parameters must be populated in order to send to Azure.
:param bytes_copied: Required. The number of document bytes copied during
the Copying stage
:type bytes_copied: long
:param documents_copied: Required. The number of documents copied during
the Copying stage
:type documents_copied: long
:param elapsed_time: Required. The elapsed time in the format
[ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)
:type elapsed_time: str
:param errors: Required. The errors and warnings that have occurred for
the current object. The keys are the error codes.
:type errors: dict[str, ~azure.mgmt.datamigration.models.MongoDbError]
:param events_pending: Required. The number of oplog events awaiting
replay
:type events_pending: long
:param events_replayed: Required. The number of oplog events replayed so
far
:type events_replayed: long
:param last_event_time: The timestamp of the last oplog event received, or
null if no oplog event has been received yet
:type last_event_time: datetime
:param last_replay_time: The timestamp of the last oplog event replayed,
or null if no oplog event has been replayed yet
:type last_replay_time: datetime
:param name: 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.
:type name: str
:param qualified_name: 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.
:type qualified_name: str
:param result_type: Required. The type of progress object. Possible values
include: 'Migration', 'Database', 'Collection'
:type result_type: str or ~azure.mgmt.datamigration.models.enum
:param state: Required. Possible values include: 'NotStarted',
'ValidatingInput', 'Initializing', 'Restarting', 'Copying',
'InitialReplay', 'Replaying', 'Finalizing', 'Complete', 'Canceled',
'Failed'
:type state: str or ~azure.mgmt.datamigration.models.MongoDbMigrationState
:param total_bytes: Required. The total number of document bytes on the
source at the beginning of the Copying stage, or -1 if the total size was
unknown
:type total_bytes: long
:param total_documents: Required. The total number of documents on the
source at the beginning of the Copying stage, or -1 if the total count was
unknown
:type total_documents: long
:param collections: The progress of the collections in the database. The
keys are the unqualified names of the collections
:type collections: dict[str,
~azure.mgmt.datamigration.models.MongoDbCollectionProgress]
"""
_validation = {
'bytes_copied': {'required': True},
'documents_copied': {'required': True},
'elapsed_time': {'required': True},
'errors': {'required': True},
'events_pending': {'required': True},
'events_replayed': {'required': True},
'result_type': {'required': True},
'state': {'required': True},
'total_bytes': {'required': True},
'total_documents': {'required': True},
}
_attribute_map = {
'bytes_copied': {'key': 'bytesCopied', 'type': 'long'},
'documents_copied': {'key': 'documentsCopied', 'type': 'long'},
'elapsed_time': {'key': 'elapsedTime', 'type': 'str'},
'errors': {'key': 'errors', 'type': '{MongoDbError}'},
'events_pending': {'key': 'eventsPending', 'type': 'long'},
'events_replayed': {'key': 'eventsReplayed', 'type': 'long'},
'last_event_time': {'key': 'lastEventTime', 'type': 'iso-8601'},
'last_replay_time': {'key': 'lastReplayTime', 'type': 'iso-8601'},
'name': {'key': 'name', 'type': 'str'},
'qualified_name': {'key': 'qualifiedName', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'state': {'key': 'state', 'type': 'str'},
'total_bytes': {'key': 'totalBytes', 'type': 'long'},
'total_documents': {'key': 'totalDocuments', 'type': 'long'},
'collections': {'key': 'collections', 'type': '{MongoDbCollectionProgress}'},
}
def __init__(self, *, bytes_copied: int, documents_copied: int, elapsed_time: str, errors, events_pending: int, events_replayed: int, result_type, state, total_bytes: int, total_documents: int, last_event_time=None, last_replay_time=None, name: str=None, qualified_name: str=None, collections=None, **kwargs) -> None:
super(MongoDbDatabaseProgress, self).__init__(bytes_copied=bytes_copied, documents_copied=documents_copied, elapsed_time=elapsed_time, errors=errors, events_pending=events_pending, events_replayed=events_replayed, last_event_time=last_event_time, last_replay_time=last_replay_time, name=name, qualified_name=qualified_name, result_type=result_type, state=state, total_bytes=total_bytes, total_documents=total_documents, **kwargs)
self.collections = collections
[docs]class MongoDbDatabaseSettings(Model):
"""Describes how an individual MongoDB database should be migrated.
All required parameters must be populated in order to send to Azure.
:param collections: Required. The collections on the source database to
migrate to the target. The keys are the unqualified names of the
collections.
:type collections: dict[str,
~azure.mgmt.datamigration.models.MongoDbCollectionSettings]
:param target_rus: 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.
:type target_rus: int
"""
_validation = {
'collections': {'required': True},
}
_attribute_map = {
'collections': {'key': 'collections', 'type': '{MongoDbCollectionSettings}'},
'target_rus': {'key': 'targetRUs', 'type': 'int'},
}
def __init__(self, *, collections, target_rus: int=None, **kwargs) -> None:
super(MongoDbDatabaseSettings, self).__init__(**kwargs)
self.collections = collections
self.target_rus = target_rus
[docs]class MongoDbError(Model):
"""Describes an error or warning that occurred during a MongoDB migration.
:param code: The non-localized, machine-readable code that describes the
error or warning
:type code: str
:param count: The number of times the error or warning has occurred
:type count: int
:param message: The localized, human-readable message that describes the
error or warning
:type message: str
:param type: The type of error or warning. Possible values include:
'Error', 'ValidationError', 'Warning'
:type type: str or ~azure.mgmt.datamigration.models.MongoDbErrorType
"""
_attribute_map = {
'code': {'key': 'code', 'type': 'str'},
'count': {'key': 'count', 'type': 'int'},
'message': {'key': 'message', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(self, *, code: str=None, count: int=None, message: str=None, type=None, **kwargs) -> None:
super(MongoDbError, self).__init__(**kwargs)
self.code = code
self.count = count
self.message = message
self.type = type
[docs]class MongoDbFinishCommand(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the command. This is ignored if submitted.
Possible values include: 'Unknown', 'Accepted', 'Running', 'Succeeded',
'Failed'
:vartype state: str or ~azure.mgmt.datamigration.models.CommandState
:param command_type: Required. Constant filled by server.
:type command_type: str
:param input: Command input
:type input: ~azure.mgmt.datamigration.models.MongoDbFinishCommandInput
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'command_type': {'required': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'command_type': {'key': 'commandType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MongoDbFinishCommandInput'},
}
def __init__(self, *, input=None, **kwargs) -> None:
super(MongoDbFinishCommand, self).__init__(**kwargs)
self.input = input
self.command_type = 'finish'
[docs]class MongoDbMigrationProgress(MongoDbProgress):
"""Describes the progress of the overall migration.
All required parameters must be populated in order to send to Azure.
:param bytes_copied: Required. The number of document bytes copied during
the Copying stage
:type bytes_copied: long
:param documents_copied: Required. The number of documents copied during
the Copying stage
:type documents_copied: long
:param elapsed_time: Required. The elapsed time in the format
[ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)
:type elapsed_time: str
:param errors: Required. The errors and warnings that have occurred for
the current object. The keys are the error codes.
:type errors: dict[str, ~azure.mgmt.datamigration.models.MongoDbError]
:param events_pending: Required. The number of oplog events awaiting
replay
:type events_pending: long
:param events_replayed: Required. The number of oplog events replayed so
far
:type events_replayed: long
:param last_event_time: The timestamp of the last oplog event received, or
null if no oplog event has been received yet
:type last_event_time: datetime
:param last_replay_time: The timestamp of the last oplog event replayed,
or null if no oplog event has been replayed yet
:type last_replay_time: datetime
:param name: 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.
:type name: str
:param qualified_name: 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.
:type qualified_name: str
:param result_type: Required. The type of progress object. Possible values
include: 'Migration', 'Database', 'Collection'
:type result_type: str or ~azure.mgmt.datamigration.models.enum
:param state: Required. Possible values include: 'NotStarted',
'ValidatingInput', 'Initializing', 'Restarting', 'Copying',
'InitialReplay', 'Replaying', 'Finalizing', 'Complete', 'Canceled',
'Failed'
:type state: str or ~azure.mgmt.datamigration.models.MongoDbMigrationState
:param total_bytes: Required. The total number of document bytes on the
source at the beginning of the Copying stage, or -1 if the total size was
unknown
:type total_bytes: long
:param total_documents: Required. The total number of documents on the
source at the beginning of the Copying stage, or -1 if the total count was
unknown
:type total_documents: long
:param databases: The progress of the databases in the migration. The keys
are the names of the databases
:type databases: dict[str,
~azure.mgmt.datamigration.models.MongoDbDatabaseProgress]
"""
_validation = {
'bytes_copied': {'required': True},
'documents_copied': {'required': True},
'elapsed_time': {'required': True},
'errors': {'required': True},
'events_pending': {'required': True},
'events_replayed': {'required': True},
'result_type': {'required': True},
'state': {'required': True},
'total_bytes': {'required': True},
'total_documents': {'required': True},
}
_attribute_map = {
'bytes_copied': {'key': 'bytesCopied', 'type': 'long'},
'documents_copied': {'key': 'documentsCopied', 'type': 'long'},
'elapsed_time': {'key': 'elapsedTime', 'type': 'str'},
'errors': {'key': 'errors', 'type': '{MongoDbError}'},
'events_pending': {'key': 'eventsPending', 'type': 'long'},
'events_replayed': {'key': 'eventsReplayed', 'type': 'long'},
'last_event_time': {'key': 'lastEventTime', 'type': 'iso-8601'},
'last_replay_time': {'key': 'lastReplayTime', 'type': 'iso-8601'},
'name': {'key': 'name', 'type': 'str'},
'qualified_name': {'key': 'qualifiedName', 'type': 'str'},
'result_type': {'key': 'resultType', 'type': 'str'},
'state': {'key': 'state', 'type': 'str'},
'total_bytes': {'key': 'totalBytes', 'type': 'long'},
'total_documents': {'key': 'totalDocuments', 'type': 'long'},
'databases': {'key': 'databases', 'type': '{MongoDbDatabaseProgress}'},
}
def __init__(self, *, bytes_copied: int, documents_copied: int, elapsed_time: str, errors, events_pending: int, events_replayed: int, result_type, state, total_bytes: int, total_documents: int, last_event_time=None, last_replay_time=None, name: str=None, qualified_name: str=None, databases=None, **kwargs) -> None:
super(MongoDbMigrationProgress, self).__init__(bytes_copied=bytes_copied, documents_copied=documents_copied, elapsed_time=elapsed_time, errors=errors, events_pending=events_pending, events_replayed=events_replayed, last_event_time=last_event_time, last_replay_time=last_replay_time, name=name, qualified_name=qualified_name, result_type=result_type, state=state, total_bytes=total_bytes, total_documents=total_documents, **kwargs)
self.databases = databases
[docs]class MongoDbMigrationSettings(Model):
"""Describes how a MongoDB data migration should be performed.
All required parameters must be populated in order to send to Azure.
:param boost_rus: 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.
:type boost_rus: int
:param databases: Required. The databases on the source cluster to migrate
to the target. The keys are the names of the databases.
:type databases: dict[str,
~azure.mgmt.datamigration.models.MongoDbDatabaseSettings]
:param replication: Describes how changes will be replicated from the
source to the target. The default is OneTime. Possible values include:
'Disabled', 'OneTime', 'Continuous'
:type replication: str or
~azure.mgmt.datamigration.models.MongoDbReplication
:param source: Required. Settings used to connect to the source cluster
:type source: ~azure.mgmt.datamigration.models.MongoDbConnectionInfo
:param target: Required. Settings used to connect to the target cluster
:type target: ~azure.mgmt.datamigration.models.MongoDbConnectionInfo
:param throttling: Settings used to limit the resource usage of the
migration
:type throttling:
~azure.mgmt.datamigration.models.MongoDbThrottlingSettings
"""
_validation = {
'databases': {'required': True},
'source': {'required': True},
'target': {'required': True},
}
_attribute_map = {
'boost_rus': {'key': 'boostRUs', 'type': 'int'},
'databases': {'key': 'databases', 'type': '{MongoDbDatabaseSettings}'},
'replication': {'key': 'replication', 'type': 'str'},
'source': {'key': 'source', 'type': 'MongoDbConnectionInfo'},
'target': {'key': 'target', 'type': 'MongoDbConnectionInfo'},
'throttling': {'key': 'throttling', 'type': 'MongoDbThrottlingSettings'},
}
def __init__(self, *, databases, source, target, boost_rus: int=None, replication=None, throttling=None, **kwargs) -> None:
super(MongoDbMigrationSettings, self).__init__(**kwargs)
self.boost_rus = boost_rus
self.databases = databases
self.replication = replication
self.source = source
self.target = target
self.throttling = throttling
[docs]class MongoDbRestartCommand(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the command. This is ignored if submitted.
Possible values include: 'Unknown', 'Accepted', 'Running', 'Succeeded',
'Failed'
:vartype state: str or ~azure.mgmt.datamigration.models.CommandState
:param command_type: Required. Constant filled by server.
:type command_type: str
:param input: Command input
:type input: ~azure.mgmt.datamigration.models.MongoDbCommandInput
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'command_type': {'required': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'command_type': {'key': 'commandType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MongoDbCommandInput'},
}
def __init__(self, *, input=None, **kwargs) -> None:
super(MongoDbRestartCommand, self).__init__(**kwargs)
self.input = input
self.command_type = 'restart'
[docs]class MongoDbShardKeyField(Model):
"""Describes a field reference within a MongoDB shard key.
All required parameters must be populated in order to send to Azure.
:param name: Required. The name of the field
:type name: str
:param order: Required. The field ordering. Possible values include:
'Forward', 'Reverse', 'Hashed'
:type order: str or ~azure.mgmt.datamigration.models.MongoDbShardKeyOrder
"""
_validation = {
'name': {'required': True},
'order': {'required': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'order': {'key': 'order', 'type': 'str'},
}
def __init__(self, *, name: str, order, **kwargs) -> None:
super(MongoDbShardKeyField, self).__init__(**kwargs)
self.name = name
self.order = order
[docs]class MongoDbShardKeyInfo(Model):
"""Describes a MongoDB shard key.
All required parameters must be populated in order to send to Azure.
:param fields: Required. The fields within the shard key
:type fields: list[~azure.mgmt.datamigration.models.MongoDbShardKeyField]
:param is_unique: Required. Whether the shard key is unique
:type is_unique: bool
"""
_validation = {
'fields': {'required': True},
'is_unique': {'required': True},
}
_attribute_map = {
'fields': {'key': 'fields', 'type': '[MongoDbShardKeyField]'},
'is_unique': {'key': 'isUnique', 'type': 'bool'},
}
def __init__(self, *, fields, is_unique: bool, **kwargs) -> None:
super(MongoDbShardKeyInfo, self).__init__(**kwargs)
self.fields = fields
self.is_unique = is_unique
[docs]class MongoDbShardKeySetting(Model):
"""Describes a MongoDB shard key.
All required parameters must be populated in order to send to Azure.
:param fields: Required. The fields within the shard key
:type fields: list[~azure.mgmt.datamigration.models.MongoDbShardKeyField]
:param is_unique: Required. Whether the shard key is unique
:type is_unique: bool
"""
_validation = {
'fields': {'required': True},
'is_unique': {'required': True},
}
_attribute_map = {
'fields': {'key': 'fields', 'type': '[MongoDbShardKeyField]'},
'is_unique': {'key': 'isUnique', 'type': 'bool'},
}
def __init__(self, *, fields, is_unique: bool, **kwargs) -> None:
super(MongoDbShardKeySetting, self).__init__(**kwargs)
self.fields = fields
self.is_unique = is_unique
[docs]class MongoDbThrottlingSettings(Model):
"""Specifies resource limits for the migration.
:param min_free_cpu: The percentage of CPU time that the migrator will try
to avoid using, from 0 to 100
:type min_free_cpu: int
:param min_free_memory_mb: The number of megabytes of RAM that the
migrator will try to avoid using
:type min_free_memory_mb: int
:param max_parallelism: The maximum number of work items (e.g. collection
copies) that will be processed in parallel
:type max_parallelism: int
"""
_attribute_map = {
'min_free_cpu': {'key': 'minFreeCpu', 'type': 'int'},
'min_free_memory_mb': {'key': 'minFreeMemoryMb', 'type': 'int'},
'max_parallelism': {'key': 'maxParallelism', 'type': 'int'},
}
def __init__(self, *, min_free_cpu: int=None, min_free_memory_mb: int=None, max_parallelism: int=None, **kwargs) -> None:
super(MongoDbThrottlingSettings, self).__init__(**kwargs)
self.min_free_cpu = min_free_cpu
self.min_free_memory_mb = min_free_memory_mb
self.max_parallelism = max_parallelism
[docs]class MySqlConnectionInfo(ConnectionInfo):
"""Information for connecting to MySQL server.
All required parameters must be populated in order to send to Azure.
:param user_name: User name
:type user_name: str
:param password: Password credential.
:type password: str
:param type: Required. Constant filled by server.
:type type: str
:param server_name: Required. Name of the server
:type server_name: str
:param port: Required. Port for Server
:type port: int
"""
_validation = {
'type': {'required': True},
'server_name': {'required': True},
'port': {'required': True},
}
_attribute_map = {
'user_name': {'key': 'userName', 'type': 'str'},
'password': {'key': 'password', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'server_name': {'key': 'serverName', 'type': 'str'},
'port': {'key': 'port', 'type': 'int'},
}
def __init__(self, *, server_name: str, port: int, user_name: str=None, password: str=None, **kwargs) -> None:
super(MySqlConnectionInfo, self).__init__(user_name=user_name, password=password, **kwargs)
self.server_name = server_name
self.port = port
self.type = 'MySqlConnectionInfo'
[docs]class NameAvailabilityRequest(Model):
"""A resource type and proposed name.
:param name: The proposed resource name
:type name: str
:param type: The resource type chain (e.g. virtualMachines/extensions)
:type type: str
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(self, *, name: str=None, type: str=None, **kwargs) -> None:
super(NameAvailabilityRequest, self).__init__(**kwargs)
self.name = name
self.type = type
[docs]class NameAvailabilityResponse(Model):
"""Indicates whether a proposed resource name is available.
:param name_available: If true, the name is valid and available. If false,
'reason' describes why not.
:type name_available: bool
:param reason: The reason why the name is not available, if nameAvailable
is false. Possible values include: 'AlreadyExists', 'Invalid'
:type reason: str or
~azure.mgmt.datamigration.models.NameCheckFailureReason
:param message: The localized reason why the name is not available, if
nameAvailable is false
:type message: str
"""
_attribute_map = {
'name_available': {'key': 'nameAvailable', 'type': 'bool'},
'reason': {'key': 'reason', 'type': 'str'},
'message': {'key': 'message', 'type': 'str'},
}
def __init__(self, *, name_available: bool=None, reason=None, message: str=None, **kwargs) -> None:
super(NameAvailabilityResponse, self).__init__(**kwargs)
self.name_available = name_available
self.reason = reason
self.message = message
[docs]class NonSqlDataMigrationTable(Model):
"""Defines metadata for table to be migrated.
:param source_name: Source table name
:type source_name: str
"""
_attribute_map = {
'source_name': {'key': 'sourceName', 'type': 'str'},
}
def __init__(self, *, source_name: str=None, **kwargs) -> None:
super(NonSqlDataMigrationTable, self).__init__(**kwargs)
self.source_name = source_name
[docs]class NonSqlDataMigrationTableResult(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.
:ivar result_code: Result code of the data migration. Possible values
include: 'Initial', 'Completed', 'ObjectNotExistsInSource',
'ObjectNotExistsInTarget', 'TargetObjectIsInaccessible', 'FatalError'
:vartype result_code: str or
~azure.mgmt.datamigration.models.DataMigrationResultCode
:ivar source_name: Name of the source table
:vartype source_name: str
:ivar target_name: Name of the target table
:vartype target_name: str
:ivar source_row_count: Number of rows in the source table
:vartype source_row_count: long
:ivar target_row_count: Number of rows in the target table
:vartype target_row_count: long
:ivar elapsed_time_in_miliseconds: Time taken to migrate the data
:vartype elapsed_time_in_miliseconds: float
:ivar errors: List of errors, if any, during migration
:vartype errors: list[~azure.mgmt.datamigration.models.DataMigrationError]
"""
_validation = {
'result_code': {'readonly': True},
'source_name': {'readonly': True},
'target_name': {'readonly': True},
'source_row_count': {'readonly': True},
'target_row_count': {'readonly': True},
'elapsed_time_in_miliseconds': {'readonly': True},
'errors': {'readonly': True},
}
_attribute_map = {
'result_code': {'key': 'resultCode', 'type': 'str'},
'source_name': {'key': 'sourceName', 'type': 'str'},
'target_name': {'key': 'targetName', 'type': 'str'},
'source_row_count': {'key': 'sourceRowCount', 'type': 'long'},
'target_row_count': {'key': 'targetRowCount', 'type': 'long'},
'elapsed_time_in_miliseconds': {'key': 'elapsedTimeInMiliseconds', 'type': 'float'},
'errors': {'key': 'errors', 'type': '[DataMigrationError]'},
}
def __init__(self, **kwargs) -> None:
super(NonSqlDataMigrationTableResult, self).__init__(**kwargs)
self.result_code = None
self.source_name = None
self.target_name = None
self.source_row_count = None
self.target_row_count = None
self.elapsed_time_in_miliseconds = None
self.errors = None
[docs]class NonSqlMigrationTaskOutput(Model):
"""Base class for non sql migration task output.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Result identifier
:vartype id: str
:ivar started_on: Migration start time
:vartype started_on: datetime
:ivar ended_on: Migration end time
:vartype ended_on: datetime
:ivar status: Current state of migration. Possible values include:
'Default', 'Connecting', 'SourceAndTargetSelected', 'SelectLogins',
'Configured', 'Running', 'Error', 'Stopped', 'Completed',
'CompletedWithWarnings'
:vartype status: str or ~azure.mgmt.datamigration.models.MigrationStatus
:ivar data_migration_table_results: Results of the migration. The key
contains the table name and the value the table result object
:vartype data_migration_table_results: dict[str,
~azure.mgmt.datamigration.models.NonSqlDataMigrationTableResult]
:ivar progress_message: Message about the progress of the migration
:vartype progress_message: str
:ivar source_server_name: Name of source server
:vartype source_server_name: str
:ivar target_server_name: Name of target server
:vartype target_server_name: str
"""
_validation = {
'id': {'readonly': True},
'started_on': {'readonly': True},
'ended_on': {'readonly': True},
'status': {'readonly': True},
'data_migration_table_results': {'readonly': True},
'progress_message': {'readonly': True},
'source_server_name': {'readonly': True},
'target_server_name': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'started_on': {'key': 'startedOn', 'type': 'iso-8601'},
'ended_on': {'key': 'endedOn', 'type': 'iso-8601'},
'status': {'key': 'status', 'type': 'str'},
'data_migration_table_results': {'key': 'dataMigrationTableResults', 'type': '{NonSqlDataMigrationTableResult}'},
'progress_message': {'key': 'progressMessage', 'type': 'str'},
'source_server_name': {'key': 'sourceServerName', 'type': 'str'},
'target_server_name': {'key': 'targetServerName', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(NonSqlMigrationTaskOutput, self).__init__(**kwargs)
self.id = None
self.started_on = None
self.ended_on = None
self.status = None
self.data_migration_table_results = None
self.progress_message = None
self.source_server_name = None
self.target_server_name = None
[docs]class ODataError(Model):
"""Error information in OData format.
:param code: The machine-readable description of the error, such as
'InvalidRequest' or 'InternalServerError'
:type code: str
:param message: The human-readable description of the error
:type message: str
:param details: Inner errors that caused this error
:type details: list[~azure.mgmt.datamigration.models.ODataError]
"""
_attribute_map = {
'code': {'key': 'code', 'type': 'str'},
'message': {'key': 'message', 'type': 'str'},
'details': {'key': 'details', 'type': '[ODataError]'},
}
def __init__(self, *, code: str=None, message: str=None, details=None, **kwargs) -> None:
super(ODataError, self).__init__(**kwargs)
self.code = code
self.message = message
self.details = details
[docs]class OracleConnectionInfo(ConnectionInfo):
"""Information for connecting to Oracle server.
All required parameters must be populated in order to send to Azure.
:param user_name: User name
:type user_name: str
:param password: Password credential.
:type password: str
:param type: Required. Constant filled by server.
:type type: str
:param data_source: Required. EZConnect or TNSName connection string.
:type data_source: str
"""
_validation = {
'type': {'required': True},
'data_source': {'required': True},
}
_attribute_map = {
'user_name': {'key': 'userName', 'type': 'str'},
'password': {'key': 'password', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'data_source': {'key': 'dataSource', 'type': 'str'},
}
def __init__(self, *, data_source: str, user_name: str=None, password: str=None, **kwargs) -> None:
super(OracleConnectionInfo, self).__init__(user_name=user_name, password=password, **kwargs)
self.data_source = data_source
self.type = 'OracleConnectionInfo'
[docs]class OracleOCIDriverInfo(Model):
"""Information about an Oracle OCI driver.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar driver_name: The name of the driver package
:vartype driver_name: str
:ivar driver_size: The size in bytes of the driver package
:vartype driver_size: str
:ivar archive_checksum: The MD5 Base64 encoded checksum for the driver
package.
:vartype archive_checksum: str
:ivar oracle_checksum: The checksum for the driver package provided by
Oracle.
:vartype oracle_checksum: str
:ivar assembly_version: Version listed in the OCI assembly 'oci.dll'
:vartype assembly_version: str
:ivar supported_oracle_versions: List of Oracle database versions
supported by this driver. Only major minor of the version is listed.
:vartype supported_oracle_versions: list[str]
"""
_validation = {
'driver_name': {'readonly': True},
'driver_size': {'readonly': True},
'archive_checksum': {'readonly': True},
'oracle_checksum': {'readonly': True},
'assembly_version': {'readonly': True},
'supported_oracle_versions': {'readonly': True},
}
_attribute_map = {
'driver_name': {'key': 'driverName', 'type': 'str'},
'driver_size': {'key': 'driverSize', 'type': 'str'},
'archive_checksum': {'key': 'archiveChecksum', 'type': 'str'},
'oracle_checksum': {'key': 'oracleChecksum', 'type': 'str'},
'assembly_version': {'key': 'assemblyVersion', 'type': 'str'},
'supported_oracle_versions': {'key': 'supportedOracleVersions', 'type': '[str]'},
}
def __init__(self, **kwargs) -> None:
super(OracleOCIDriverInfo, self).__init__(**kwargs)
self.driver_name = None
self.driver_size = None
self.archive_checksum = None
self.oracle_checksum = None
self.assembly_version = None
self.supported_oracle_versions = None
[docs]class OrphanedUserInfo(Model):
"""Information of orphaned users on the SQL server database.
:param name: Name of the orphaned user
:type name: str
:param database_name: Parent database of the user
:type database_name: str
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'database_name': {'key': 'databaseName', 'type': 'str'},
}
def __init__(self, *, name: str=None, database_name: str=None, **kwargs) -> None:
super(OrphanedUserInfo, self).__init__(**kwargs)
self.name = name
self.database_name = database_name
[docs]class PostgreSqlConnectionInfo(ConnectionInfo):
"""Information for connecting to PostgreSQL server.
All required parameters must be populated in order to send to Azure.
:param user_name: User name
:type user_name: str
:param password: Password credential.
:type password: str
:param type: Required. Constant filled by server.
:type type: str
:param server_name: Required. Name of the server
:type server_name: str
:param database_name: Name of the database
:type database_name: str
:param port: Required. Port for Server
:type port: int
"""
_validation = {
'type': {'required': True},
'server_name': {'required': True},
'port': {'required': True},
}
_attribute_map = {
'user_name': {'key': 'userName', 'type': 'str'},
'password': {'key': 'password', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'server_name': {'key': 'serverName', 'type': 'str'},
'database_name': {'key': 'databaseName', 'type': 'str'},
'port': {'key': 'port', 'type': 'int'},
}
def __init__(self, *, server_name: str, port: int, user_name: str=None, password: str=None, database_name: str=None, **kwargs) -> None:
super(PostgreSqlConnectionInfo, self).__init__(user_name=user_name, password=password, **kwargs)
self.server_name = server_name
self.database_name = database_name
self.port = port
self.type = 'PostgreSqlConnectionInfo'
[docs]class Project(TrackedResource):
"""A project resource.
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.
:ivar id: Resource ID.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param tags: Resource tags.
:type tags: dict[str, str]
:param location: Required. Resource location.
:type location: str
:param source_platform: Required. Source platform for the project.
Possible values include: 'SQL', 'MySQL', 'PostgreSql', 'MongoDb',
'Unknown'
:type source_platform: str or
~azure.mgmt.datamigration.models.ProjectSourcePlatform
:param target_platform: Required. Target platform for the project.
Possible values include: 'SQLDB', 'SQLMI', 'AzureDbForMySql',
'AzureDbForPostgreSql', 'MongoDb', 'Unknown'
:type target_platform: str or
~azure.mgmt.datamigration.models.ProjectTargetPlatform
:ivar creation_time: UTC Date and time when project was created
:vartype creation_time: datetime
:param source_connection_info: Information for connecting to source
:type source_connection_info:
~azure.mgmt.datamigration.models.ConnectionInfo
:param target_connection_info: Information for connecting to target
:type target_connection_info:
~azure.mgmt.datamigration.models.ConnectionInfo
:param databases_info: List of DatabaseInfo
:type databases_info: list[~azure.mgmt.datamigration.models.DatabaseInfo]
:ivar provisioning_state: The project's provisioning state. Possible
values include: 'Deleting', 'Succeeded'
:vartype provisioning_state: str or
~azure.mgmt.datamigration.models.ProjectProvisioningState
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'source_platform': {'required': True},
'target_platform': {'required': True},
'creation_time': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'location': {'key': 'location', 'type': 'str'},
'source_platform': {'key': 'properties.sourcePlatform', 'type': 'str'},
'target_platform': {'key': 'properties.targetPlatform', 'type': 'str'},
'creation_time': {'key': 'properties.creationTime', 'type': 'iso-8601'},
'source_connection_info': {'key': 'properties.sourceConnectionInfo', 'type': 'ConnectionInfo'},
'target_connection_info': {'key': 'properties.targetConnectionInfo', 'type': 'ConnectionInfo'},
'databases_info': {'key': 'properties.databasesInfo', 'type': '[DatabaseInfo]'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(self, *, location: str, source_platform, target_platform, tags=None, source_connection_info=None, target_connection_info=None, databases_info=None, **kwargs) -> None:
super(Project, self).__init__(tags=tags, location=location, **kwargs)
self.source_platform = source_platform
self.target_platform = target_platform
self.creation_time = None
self.source_connection_info = source_connection_info
self.target_connection_info = target_connection_info
self.databases_info = databases_info
self.provisioning_state = None
[docs]class ProjectFile(Resource):
"""A file resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Resource ID.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param etag: HTTP strong entity tag value. This is ignored if submitted.
:type etag: str
:param properties: Custom file properties
:type properties: ~azure.mgmt.datamigration.models.ProjectFileProperties
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'ProjectFileProperties'},
}
def __init__(self, *, etag: str=None, properties=None, **kwargs) -> None:
super(ProjectFile, self).__init__(**kwargs)
self.etag = etag
self.properties = properties
[docs]class ProjectFileProperties(Model):
"""Base class for file properties.
Variables are only populated by the server, and will be ignored when
sending a request.
:param extension: Optional File extension. If submitted it should not have
a leading period and must match the extension from filePath.
:type extension: str
:param file_path: Relative path of this file resource. This property can
be set when creating or updating the file resource.
:type file_path: str
:ivar last_modified: Modification DateTime.
:vartype last_modified: datetime
:param media_type: File content type. This property can be modified to
reflect the file content type.
:type media_type: str
:ivar size: File size.
:vartype size: long
"""
_validation = {
'last_modified': {'readonly': True},
'size': {'readonly': True},
}
_attribute_map = {
'extension': {'key': 'extension', 'type': 'str'},
'file_path': {'key': 'filePath', 'type': 'str'},
'last_modified': {'key': 'lastModified', 'type': 'iso-8601'},
'media_type': {'key': 'mediaType', 'type': 'str'},
'size': {'key': 'size', 'type': 'long'},
}
def __init__(self, *, extension: str=None, file_path: str=None, media_type: str=None, **kwargs) -> None:
super(ProjectFileProperties, self).__init__(**kwargs)
self.extension = extension
self.file_path = file_path
self.last_modified = None
self.media_type = media_type
self.size = None
[docs]class ProjectTask(Resource):
"""A task resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Resource ID.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param etag: HTTP strong entity tag value. This is ignored if submitted.
:type etag: str
:param properties: Custom task properties
:type properties: ~azure.mgmt.datamigration.models.ProjectTaskProperties
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'properties': {'key': 'properties', 'type': 'ProjectTaskProperties'},
}
def __init__(self, *, etag: str=None, properties=None, **kwargs) -> None:
super(ProjectTask, self).__init__(**kwargs)
self.etag = etag
self.properties = properties
[docs]class QueryAnalysisValidationResult(Model):
"""Results for query analysis comparison between the source and target.
:param query_results: List of queries executed and it's execution results
in source and target
:type query_results: ~azure.mgmt.datamigration.models.QueryExecutionResult
:param validation_errors: Errors that are part of the execution
:type validation_errors: ~azure.mgmt.datamigration.models.ValidationError
"""
_attribute_map = {
'query_results': {'key': 'queryResults', 'type': 'QueryExecutionResult'},
'validation_errors': {'key': 'validationErrors', 'type': 'ValidationError'},
}
def __init__(self, *, query_results=None, validation_errors=None, **kwargs) -> None:
super(QueryAnalysisValidationResult, self).__init__(**kwargs)
self.query_results = query_results
self.validation_errors = validation_errors
[docs]class QueryExecutionResult(Model):
"""Describes query analysis results for execution in source and target.
:param query_text: Query text retrieved from the source server
:type query_text: str
:param statements_in_batch: Total no. of statements in the batch
:type statements_in_batch: long
:param source_result: Query analysis result from the source
:type source_result: ~azure.mgmt.datamigration.models.ExecutionStatistics
:param target_result: Query analysis result from the target
:type target_result: ~azure.mgmt.datamigration.models.ExecutionStatistics
"""
_attribute_map = {
'query_text': {'key': 'queryText', 'type': 'str'},
'statements_in_batch': {'key': 'statementsInBatch', 'type': 'long'},
'source_result': {'key': 'sourceResult', 'type': 'ExecutionStatistics'},
'target_result': {'key': 'targetResult', 'type': 'ExecutionStatistics'},
}
def __init__(self, *, query_text: str=None, statements_in_batch: int=None, source_result=None, target_result=None, **kwargs) -> None:
super(QueryExecutionResult, self).__init__(**kwargs)
self.query_text = query_text
self.statements_in_batch = statements_in_batch
self.source_result = source_result
self.target_result = target_result
[docs]class Quota(Model):
"""Describes a quota for or usage details about a resource.
:param current_value: The current value of the quota. If null or missing,
the current value cannot be determined in the context of the request.
:type current_value: float
:param id: The resource ID of the quota object
:type id: str
:param limit: The maximum value of the quota. If null or missing, the
quota has no maximum, in which case it merely tracks usage.
:type limit: float
:param name: The name of the quota
:type name: ~azure.mgmt.datamigration.models.QuotaName
:param unit: The unit for the quota, such as Count, Bytes, BytesPerSecond,
etc.
:type unit: str
"""
_attribute_map = {
'current_value': {'key': 'currentValue', 'type': 'float'},
'id': {'key': 'id', 'type': 'str'},
'limit': {'key': 'limit', 'type': 'float'},
'name': {'key': 'name', 'type': 'QuotaName'},
'unit': {'key': 'unit', 'type': 'str'},
}
def __init__(self, *, current_value: float=None, id: str=None, limit: float=None, name=None, unit: str=None, **kwargs) -> None:
super(Quota, self).__init__(**kwargs)
self.current_value = current_value
self.id = id
self.limit = limit
self.name = name
self.unit = unit
[docs]class QuotaName(Model):
"""The name of the quota.
:param localized_value: The localized name of the quota
:type localized_value: str
:param value: The unlocalized name (or ID) of the quota
:type value: str
"""
_attribute_map = {
'localized_value': {'key': 'localizedValue', 'type': 'str'},
'value': {'key': 'value', 'type': 'str'},
}
def __init__(self, *, localized_value: str=None, value: str=None, **kwargs) -> None:
super(QuotaName, self).__init__(**kwargs)
self.localized_value = localized_value
self.value = value
[docs]class ReportableException(Model):
"""Exception object for all custom exceptions.
:param message: Error message
:type message: str
:param actionable_message: Actionable steps for this exception
:type actionable_message: str
:param file_path: The path to the file where exception occurred
:type file_path: str
:param line_number: The line number where exception occurred
:type line_number: str
:param h_result: Coded numerical value that is assigned to a specific
exception
:type h_result: int
:param stack_trace: Stack trace
:type stack_trace: str
"""
_attribute_map = {
'message': {'key': 'message', 'type': 'str'},
'actionable_message': {'key': 'actionableMessage', 'type': 'str'},
'file_path': {'key': 'filePath', 'type': 'str'},
'line_number': {'key': 'lineNumber', 'type': 'str'},
'h_result': {'key': 'hResult', 'type': 'int'},
'stack_trace': {'key': 'stackTrace', 'type': 'str'},
}
def __init__(self, *, message: str=None, actionable_message: str=None, file_path: str=None, line_number: str=None, h_result: int=None, stack_trace: str=None, **kwargs) -> None:
super(ReportableException, self).__init__(**kwargs)
self.message = message
self.actionable_message = actionable_message
self.file_path = file_path
self.line_number = line_number
self.h_result = h_result
self.stack_trace = stack_trace
[docs]class ResourceSku(Model):
"""Describes an available DMS SKU.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar resource_type: The type of resource the SKU applies to.
:vartype resource_type: str
:ivar name: The name of SKU.
:vartype name: str
:ivar tier: Specifies the tier of DMS in a scale set.
:vartype tier: str
:ivar size: The Size of the SKU.
:vartype size: str
:ivar family: The Family of this particular SKU.
:vartype family: str
:ivar kind: The Kind of resources that are supported in this SKU.
:vartype kind: str
:ivar capacity: Not used.
:vartype capacity: ~azure.mgmt.datamigration.models.ResourceSkuCapacity
:ivar locations: The set of locations that the SKU is available.
:vartype locations: list[str]
:ivar api_versions: The api versions that support this SKU.
:vartype api_versions: list[str]
:ivar costs: Metadata for retrieving price info.
:vartype costs: list[~azure.mgmt.datamigration.models.ResourceSkuCosts]
:ivar capabilities: A name value pair to describe the capability.
:vartype capabilities:
list[~azure.mgmt.datamigration.models.ResourceSkuCapabilities]
:ivar restrictions: The restrictions because of which SKU cannot be used.
This is empty if there are no restrictions.
:vartype restrictions:
list[~azure.mgmt.datamigration.models.ResourceSkuRestrictions]
"""
_validation = {
'resource_type': {'readonly': True},
'name': {'readonly': True},
'tier': {'readonly': True},
'size': {'readonly': True},
'family': {'readonly': True},
'kind': {'readonly': True},
'capacity': {'readonly': True},
'locations': {'readonly': True},
'api_versions': {'readonly': True},
'costs': {'readonly': True},
'capabilities': {'readonly': True},
'restrictions': {'readonly': True},
}
_attribute_map = {
'resource_type': {'key': 'resourceType', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'tier': {'key': 'tier', 'type': 'str'},
'size': {'key': 'size', 'type': 'str'},
'family': {'key': 'family', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'str'},
'capacity': {'key': 'capacity', 'type': 'ResourceSkuCapacity'},
'locations': {'key': 'locations', 'type': '[str]'},
'api_versions': {'key': 'apiVersions', 'type': '[str]'},
'costs': {'key': 'costs', 'type': '[ResourceSkuCosts]'},
'capabilities': {'key': 'capabilities', 'type': '[ResourceSkuCapabilities]'},
'restrictions': {'key': 'restrictions', 'type': '[ResourceSkuRestrictions]'},
}
def __init__(self, **kwargs) -> None:
super(ResourceSku, self).__init__(**kwargs)
self.resource_type = None
self.name = None
self.tier = None
self.size = None
self.family = None
self.kind = None
self.capacity = None
self.locations = None
self.api_versions = None
self.costs = None
self.capabilities = None
self.restrictions = None
[docs]class ResourceSkuCapabilities(Model):
"""Describes The SKU capabilities object.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar name: An invariant to describe the feature.
:vartype name: str
:ivar value: An invariant if the feature is measured by quantity.
:vartype value: str
"""
_validation = {
'name': {'readonly': True},
'value': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'value': {'key': 'value', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ResourceSkuCapabilities, self).__init__(**kwargs)
self.name = None
self.value = None
[docs]class ResourceSkuCapacity(Model):
"""Describes scaling information of a SKU.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar minimum: The minimum capacity.
:vartype minimum: long
:ivar maximum: The maximum capacity.
:vartype maximum: long
:ivar default: The default capacity.
:vartype default: long
:ivar scale_type: The scale type applicable to the SKU. Possible values
include: 'Automatic', 'Manual', 'None'
:vartype scale_type: str or
~azure.mgmt.datamigration.models.ResourceSkuCapacityScaleType
"""
_validation = {
'minimum': {'readonly': True},
'maximum': {'readonly': True},
'default': {'readonly': True},
'scale_type': {'readonly': True},
}
_attribute_map = {
'minimum': {'key': 'minimum', 'type': 'long'},
'maximum': {'key': 'maximum', 'type': 'long'},
'default': {'key': 'default', 'type': 'long'},
'scale_type': {'key': 'scaleType', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ResourceSkuCapacity, self).__init__(**kwargs)
self.minimum = None
self.maximum = None
self.default = None
self.scale_type = None
[docs]class ResourceSkuCosts(Model):
"""Describes metadata for retrieving price info.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar meter_id: Used for querying price from commerce.
:vartype meter_id: str
:ivar quantity: The multiplier is needed to extend the base metered cost.
:vartype quantity: long
:ivar extended_unit: An invariant to show the extended unit.
:vartype extended_unit: str
"""
_validation = {
'meter_id': {'readonly': True},
'quantity': {'readonly': True},
'extended_unit': {'readonly': True},
}
_attribute_map = {
'meter_id': {'key': 'meterID', 'type': 'str'},
'quantity': {'key': 'quantity', 'type': 'long'},
'extended_unit': {'key': 'extendedUnit', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ResourceSkuCosts, self).__init__(**kwargs)
self.meter_id = None
self.quantity = None
self.extended_unit = None
[docs]class ResourceSkuRestrictions(Model):
"""Describes scaling information of a SKU.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar type: The type of restrictions. Possible values include: 'location'
:vartype type: str or
~azure.mgmt.datamigration.models.ResourceSkuRestrictionsType
:ivar values: The value of restrictions. If the restriction type is set to
location. This would be different locations where the SKU is restricted.
:vartype values: list[str]
:ivar reason_code: The reason code for restriction. Possible values
include: 'QuotaId', 'NotAvailableForSubscription'
:vartype reason_code: str or
~azure.mgmt.datamigration.models.ResourceSkuRestrictionsReasonCode
"""
_validation = {
'type': {'readonly': True},
'values': {'readonly': True},
'reason_code': {'readonly': True},
}
_attribute_map = {
'type': {'key': 'type', 'type': 'str'},
'values': {'key': 'values', 'type': '[str]'},
'reason_code': {'key': 'reasonCode', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ResourceSkuRestrictions, self).__init__(**kwargs)
self.type = None
self.values = None
self.reason_code = None
[docs]class SchemaComparisonValidationResult(Model):
"""Results for schema comparison between the source and target.
:param schema_differences: List of schema differences between the source
and target databases
:type schema_differences:
~azure.mgmt.datamigration.models.SchemaComparisonValidationResultType
:param validation_errors: List of errors that happened while performing
schema compare validation
:type validation_errors: ~azure.mgmt.datamigration.models.ValidationError
:param source_database_object_count: Count of source database objects
:type source_database_object_count: dict[str, long]
:param target_database_object_count: Count of target database objects
:type target_database_object_count: dict[str, long]
"""
_attribute_map = {
'schema_differences': {'key': 'schemaDifferences', 'type': 'SchemaComparisonValidationResultType'},
'validation_errors': {'key': 'validationErrors', 'type': 'ValidationError'},
'source_database_object_count': {'key': 'sourceDatabaseObjectCount', 'type': '{long}'},
'target_database_object_count': {'key': 'targetDatabaseObjectCount', 'type': '{long}'},
}
def __init__(self, *, schema_differences=None, validation_errors=None, source_database_object_count=None, target_database_object_count=None, **kwargs) -> None:
super(SchemaComparisonValidationResult, self).__init__(**kwargs)
self.schema_differences = schema_differences
self.validation_errors = validation_errors
self.source_database_object_count = source_database_object_count
self.target_database_object_count = target_database_object_count
[docs]class SchemaComparisonValidationResultType(Model):
"""Description about the errors happen while performing migration validation.
:param object_name: Name of the object that has the difference
:type object_name: str
:param object_type: Type of the object that has the difference. e.g
(Table/View/StoredProcedure). Possible values include: 'StoredProcedures',
'Table', 'User', 'View', 'Function'
:type object_type: str or ~azure.mgmt.datamigration.models.ObjectType
:param update_action: Update action type with respect to target. Possible
values include: 'DeletedOnTarget', 'ChangedOnTarget', 'AddedOnTarget'
:type update_action: str or
~azure.mgmt.datamigration.models.UpdateActionType
"""
_attribute_map = {
'object_name': {'key': 'objectName', 'type': 'str'},
'object_type': {'key': 'objectType', 'type': 'str'},
'update_action': {'key': 'updateAction', 'type': 'str'},
}
def __init__(self, *, object_name: str=None, object_type=None, update_action=None, **kwargs) -> None:
super(SchemaComparisonValidationResultType, self).__init__(**kwargs)
self.object_name = object_name
self.object_type = object_type
self.update_action = update_action
[docs]class SchemaMigrationSetting(Model):
"""Settings for migrating schema from source to target.
:param schema_option: Option on how to migrate the schema. Possible values
include: 'None', 'ExtractFromSource', 'UseStorageFile'
:type schema_option: str or
~azure.mgmt.datamigration.models.SchemaMigrationOption
:param file_id: Resource Identifier of a file resource containing the
uploaded schema file
:type file_id: str
"""
_attribute_map = {
'schema_option': {'key': 'schemaOption', 'type': 'str'},
'file_id': {'key': 'fileId', 'type': 'str'},
}
def __init__(self, *, schema_option=None, file_id: str=None, **kwargs) -> None:
super(SchemaMigrationSetting, self).__init__(**kwargs)
self.schema_option = schema_option
self.file_id = file_id
[docs]class ServerProperties(Model):
"""Server properties for MySQL type source.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar server_platform: Name of the server platform
:vartype server_platform: str
:ivar server_name: Name of the server
:vartype server_name: str
:ivar server_version: Version of the database server
:vartype server_version: str
:ivar server_edition: Edition of the database server
:vartype server_edition: str
:ivar server_operating_system_version: Version of the operating system
:vartype server_operating_system_version: str
:ivar server_database_count: Number of databases in the server
:vartype server_database_count: int
"""
_validation = {
'server_platform': {'readonly': True},
'server_name': {'readonly': True},
'server_version': {'readonly': True},
'server_edition': {'readonly': True},
'server_operating_system_version': {'readonly': True},
'server_database_count': {'readonly': True},
}
_attribute_map = {
'server_platform': {'key': 'serverPlatform', 'type': 'str'},
'server_name': {'key': 'serverName', 'type': 'str'},
'server_version': {'key': 'serverVersion', 'type': 'str'},
'server_edition': {'key': 'serverEdition', 'type': 'str'},
'server_operating_system_version': {'key': 'serverOperatingSystemVersion', 'type': 'str'},
'server_database_count': {'key': 'serverDatabaseCount', 'type': 'int'},
}
def __init__(self, **kwargs) -> None:
super(ServerProperties, self).__init__(**kwargs)
self.server_platform = None
self.server_name = None
self.server_version = None
self.server_edition = None
self.server_operating_system_version = None
self.server_database_count = None
[docs]class ServiceOperation(Model):
"""Description of an action supported by the Database Migration Service.
:param name: The fully qualified action name, e.g.
Microsoft.DataMigration/services/read
:type name: str
:param display: Localized display text
:type display: ~azure.mgmt.datamigration.models.ServiceOperationDisplay
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'display': {'key': 'display', 'type': 'ServiceOperationDisplay'},
}
def __init__(self, *, name: str=None, display=None, **kwargs) -> None:
super(ServiceOperation, self).__init__(**kwargs)
self.name = name
self.display = display
[docs]class ServiceOperationDisplay(Model):
"""Localized display text.
:param provider: The localized resource provider name
:type provider: str
:param resource: The localized resource type name
:type resource: str
:param operation: The localized operation name
:type operation: str
:param description: The localized operation description
:type description: str
"""
_attribute_map = {
'provider': {'key': 'provider', 'type': 'str'},
'resource': {'key': 'resource', 'type': 'str'},
'operation': {'key': 'operation', 'type': 'str'},
'description': {'key': 'description', 'type': 'str'},
}
def __init__(self, *, provider: str=None, resource: str=None, operation: str=None, description: str=None, **kwargs) -> None:
super(ServiceOperationDisplay, self).__init__(**kwargs)
self.provider = provider
self.resource = resource
self.operation = operation
self.description = description
[docs]class ServiceSku(Model):
"""An Azure SKU instance.
:param name: The unique name of the SKU, such as 'P3'
:type name: str
:param tier: The tier of the SKU, such as 'Basic', 'General Purpose', or
'Business Critical'
:type tier: str
:param family: The SKU family, used when the service has multiple
performance classes within a tier, such as 'A', 'D', etc. for virtual
machines
:type family: str
:param size: 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
:type size: str
:param capacity: The capacity of the SKU, if it supports scaling
:type capacity: int
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'tier': {'key': 'tier', 'type': 'str'},
'family': {'key': 'family', 'type': 'str'},
'size': {'key': 'size', 'type': 'str'},
'capacity': {'key': 'capacity', 'type': 'int'},
}
def __init__(self, *, name: str=None, tier: str=None, family: str=None, size: str=None, capacity: int=None, **kwargs) -> None:
super(ServiceSku, self).__init__(**kwargs)
self.name = name
self.tier = tier
self.family = family
self.size = size
self.capacity = capacity
[docs]class SqlConnectionInfo(ConnectionInfo):
"""Information for connecting to SQL database server.
All required parameters must be populated in order to send to Azure.
:param user_name: User name
:type user_name: str
:param password: Password credential.
:type password: str
:param type: Required. Constant filled by server.
:type type: str
:param data_source: Required. Data source in the format
Protocol:MachineName\\SQLServerInstanceName,PortNumber
:type data_source: str
:param authentication: Authentication type to use for connection. Possible
values include: 'None', 'WindowsAuthentication', 'SqlAuthentication',
'ActiveDirectoryIntegrated', 'ActiveDirectoryPassword'
:type authentication: str or
~azure.mgmt.datamigration.models.AuthenticationType
:param encrypt_connection: Whether to encrypt the connection. Default
value: True .
:type encrypt_connection: bool
:param additional_settings: Additional connection settings
:type additional_settings: str
:param trust_server_certificate: Whether to trust the server certificate.
Default value: False .
:type trust_server_certificate: bool
:param platform: Server platform type for connection. Possible values
include: 'SqlOnPrem'
:type platform: str or ~azure.mgmt.datamigration.models.SqlSourcePlatform
"""
_validation = {
'type': {'required': True},
'data_source': {'required': True},
}
_attribute_map = {
'user_name': {'key': 'userName', 'type': 'str'},
'password': {'key': 'password', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'data_source': {'key': 'dataSource', 'type': 'str'},
'authentication': {'key': 'authentication', 'type': 'str'},
'encrypt_connection': {'key': 'encryptConnection', 'type': 'bool'},
'additional_settings': {'key': 'additionalSettings', 'type': 'str'},
'trust_server_certificate': {'key': 'trustServerCertificate', 'type': 'bool'},
'platform': {'key': 'platform', 'type': 'str'},
}
def __init__(self, *, data_source: str, user_name: str=None, password: str=None, authentication=None, encrypt_connection: bool=True, additional_settings: str=None, trust_server_certificate: bool=False, platform=None, **kwargs) -> None:
super(SqlConnectionInfo, self).__init__(user_name=user_name, password=password, **kwargs)
self.data_source = data_source
self.authentication = authentication
self.encrypt_connection = encrypt_connection
self.additional_settings = additional_settings
self.trust_server_certificate = trust_server_certificate
self.platform = platform
self.type = 'SqlConnectionInfo'
[docs]class SsisMigrationInfo(Model):
"""SSIS migration info with SSIS store type, overwrite policy.
:param ssis_store_type: The SSIS store type of source, only SSIS catalog
is supported now in DMS. Possible values include: 'SsisCatalog'
:type ssis_store_type: str or
~azure.mgmt.datamigration.models.SsisStoreType
:param project_overwrite_option: The overwrite option for the SSIS project
migration. Possible values include: 'Ignore', 'Overwrite'
:type project_overwrite_option: str or
~azure.mgmt.datamigration.models.SsisMigrationOverwriteOption
:param environment_overwrite_option: The overwrite option for the SSIS
environment migration. Possible values include: 'Ignore', 'Overwrite'
:type environment_overwrite_option: str or
~azure.mgmt.datamigration.models.SsisMigrationOverwriteOption
"""
_attribute_map = {
'ssis_store_type': {'key': 'ssisStoreType', 'type': 'str'},
'project_overwrite_option': {'key': 'projectOverwriteOption', 'type': 'str'},
'environment_overwrite_option': {'key': 'environmentOverwriteOption', 'type': 'str'},
}
def __init__(self, *, ssis_store_type=None, project_overwrite_option=None, environment_overwrite_option=None, **kwargs) -> None:
super(SsisMigrationInfo, self).__init__(**kwargs)
self.ssis_store_type = ssis_store_type
self.project_overwrite_option = project_overwrite_option
self.environment_overwrite_option = environment_overwrite_option
[docs]class StartMigrationScenarioServerRoleResult(Model):
"""Server role migration result.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar name: Name of server role.
:vartype name: str
:ivar state: Current state of migration. Possible values include: 'None',
'InProgress', 'Failed', 'Warning', 'Completed', 'Skipped', 'Stopped'
:vartype state: str or ~azure.mgmt.datamigration.models.MigrationState
:ivar exceptions_and_warnings: Migration exceptions and warnings.
:vartype exceptions_and_warnings:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'name': {'readonly': True},
'state': {'readonly': True},
'exceptions_and_warnings': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'state': {'key': 'state', 'type': 'str'},
'exceptions_and_warnings': {'key': 'exceptionsAndWarnings', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(StartMigrationScenarioServerRoleResult, self).__init__(**kwargs)
self.name = None
self.state = None
self.exceptions_and_warnings = None
[docs]class SyncMigrationDatabaseErrorEvent(Model):
"""Database migration errors for online migration.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar timestamp_string: String value of timestamp.
:vartype timestamp_string: str
:ivar event_type_string: Event type.
:vartype event_type_string: str
:ivar event_text: Event text.
:vartype event_text: str
"""
_validation = {
'timestamp_string': {'readonly': True},
'event_type_string': {'readonly': True},
'event_text': {'readonly': True},
}
_attribute_map = {
'timestamp_string': {'key': 'timestampString', 'type': 'str'},
'event_type_string': {'key': 'eventTypeString', 'type': 'str'},
'event_text': {'key': 'eventText', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(SyncMigrationDatabaseErrorEvent, self).__init__(**kwargs)
self.timestamp_string = None
self.event_type_string = None
self.event_text = None
[docs]class UploadOCIDriverTaskOutput(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.
:ivar driver_package_name: The name of the driver package that was
validated and uploaded.
:vartype driver_package_name: str
:ivar validation_errors: Validation errors
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'driver_package_name': {'readonly': True},
'validation_errors': {'readonly': True},
}
_attribute_map = {
'driver_package_name': {'key': 'driverPackageName', 'type': 'str'},
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(UploadOCIDriverTaskOutput, self).__init__(**kwargs)
self.driver_package_name = None
self.validation_errors = None
[docs]class UploadOCIDriverTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input:
:type input: ~azure.mgmt.datamigration.models.UploadOCIDriverTaskInput
:ivar output: Task output. This is ignored if submitted.
:vartype output:
list[~azure.mgmt.datamigration.models.UploadOCIDriverTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'UploadOCIDriverTaskInput'},
'output': {'key': 'output', 'type': '[UploadOCIDriverTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(UploadOCIDriverTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Service.Upload.OCI'
[docs]class ValidateMongoDbTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input:
:type input: ~azure.mgmt.datamigration.models.MongoDbMigrationSettings
:ivar output: An array containing a single MongoDbMigrationProgress object
:vartype output:
list[~azure.mgmt.datamigration.models.MongoDbMigrationProgress]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MongoDbMigrationSettings'},
'output': {'key': 'output', 'type': '[MongoDbMigrationProgress]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ValidateMongoDbTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Validate.MongoDb'
[docs]class ValidateOracleAzureDbForPostgreSqlSyncTaskProperties(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.
:ivar errors: Array of errors. This is ignored if submitted.
:vartype errors: list[~azure.mgmt.datamigration.models.ODataError]
:ivar state: The state of the task. This is ignored if submitted. Possible
values include: 'Unknown', 'Queued', 'Running', 'Canceled', 'Succeeded',
'Failed', 'FailedInputValidation', 'Faulted'
:vartype state: str or ~azure.mgmt.datamigration.models.TaskState
:ivar commands: Array of command properties.
:vartype commands:
list[~azure.mgmt.datamigration.models.CommandProperties]
:param client_data: Key value pairs of client data to attach meta data
information to task
:type client_data: dict[str, str]
:param task_type: Required. Constant filled by server.
:type task_type: str
:param input:
:type input:
~azure.mgmt.datamigration.models.MigrateOracleAzureDbPostgreSqlSyncTaskInput
:ivar output: An array containing a single validation error response
object
:vartype output:
list[~azure.mgmt.datamigration.models.ValidateOracleAzureDbPostgreSqlSyncTaskOutput]
"""
_validation = {
'errors': {'readonly': True},
'state': {'readonly': True},
'commands': {'readonly': True},
'task_type': {'required': True},
'output': {'readonly': True},
}
_attribute_map = {
'errors': {'key': 'errors', 'type': '[ODataError]'},
'state': {'key': 'state', 'type': 'str'},
'commands': {'key': 'commands', 'type': '[CommandProperties]'},
'client_data': {'key': 'clientData', 'type': '{str}'},
'task_type': {'key': 'taskType', 'type': 'str'},
'input': {'key': 'input', 'type': 'MigrateOracleAzureDbPostgreSqlSyncTaskInput'},
'output': {'key': 'output', 'type': '[ValidateOracleAzureDbPostgreSqlSyncTaskOutput]'},
}
def __init__(self, *, client_data=None, input=None, **kwargs) -> None:
super(ValidateOracleAzureDbForPostgreSqlSyncTaskProperties, self).__init__(client_data=client_data, **kwargs)
self.input = input
self.output = None
self.task_type = 'Validate.Oracle.AzureDbPostgreSql.Sync'
[docs]class ValidateOracleAzureDbPostgreSqlSyncTaskOutput(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.
:ivar validation_errors: Errors associated with a selected database object
:vartype validation_errors:
list[~azure.mgmt.datamigration.models.ReportableException]
"""
_validation = {
'validation_errors': {'readonly': True},
}
_attribute_map = {
'validation_errors': {'key': 'validationErrors', 'type': '[ReportableException]'},
}
def __init__(self, **kwargs) -> None:
super(ValidateOracleAzureDbPostgreSqlSyncTaskOutput, self).__init__(**kwargs)
self.validation_errors = None
[docs]class ValidationError(Model):
"""Description about the errors happen while performing migration validation.
:param text: Error Text
:type text: str
:param severity: Severity of the error. Possible values include:
'Message', 'Warning', 'Error'
:type severity: str or ~azure.mgmt.datamigration.models.Severity
"""
_attribute_map = {
'text': {'key': 'text', 'type': 'str'},
'severity': {'key': 'severity', 'type': 'str'},
}
def __init__(self, *, text: str=None, severity=None, **kwargs) -> None:
super(ValidationError, self).__init__(**kwargs)
self.text = text
self.severity = severity
[docs]class WaitStatistics(Model):
"""Wait statistics gathered during query batch execution.
:param wait_type: Type of the Wait
:type wait_type: str
:param wait_time_ms: Total wait time in millisecond(s) . Default value: 0
.
:type wait_time_ms: float
:param wait_count: Total no. of waits
:type wait_count: long
"""
_attribute_map = {
'wait_type': {'key': 'waitType', 'type': 'str'},
'wait_time_ms': {'key': 'waitTimeMs', 'type': 'float'},
'wait_count': {'key': 'waitCount', 'type': 'long'},
}
def __init__(self, *, wait_type: str=None, wait_time_ms: float=0, wait_count: int=None, **kwargs) -> None:
super(WaitStatistics, self).__init__(**kwargs)
self.wait_type = wait_type
self.wait_time_ms = wait_time_ms
self.wait_count = wait_count