你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Tasks - Get

参考

Service:: Data Migration

API Version:: 2022-03-30-preview

获取任务信息
任务资源是嵌套的仅限代理的资源，表示 DMS (经典) 实例执行的工作。 GET 方法检索有关任务的信息。

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

With optional parameters:

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

URI 参数

名称	在	必需	类型	说明
groupName	path	True	string	资源组的名称
projectName	path	True	string	项目的名称
serviceName	path	True	string	服务名称
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
taskName	path	True	string	任务的名称
api-version	query	True	string	API 的版本
$expand	query		string	展开响应

响应

名称	类型	说明
200 OK	ProjectTask	任务资源
Other Status Codes	ApiError	错误

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Tasks_Get

Sample Request

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.datamigration import DataMigrationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datamigration
# USAGE
    python tasks_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataMigrationManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="fc04246f-04c5-437e-ac5e-206a19e7193f",
    )

    response = client.tasks.get(
        group_name="DmsSdkRg",
        service_name="DmsSdkService",
        project_name="DmsSdkProject",
        task_name="DmsSdkTask",
    )
    print(response)


# x-ms-original-file: specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-03-30-preview/examples/Tasks_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataMigration;
using Azure.ResourceManager.DataMigration.Models;

// Generated from example definition: specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-03-30-preview/examples/Tasks_Get.json
// this example is just showing the usage of "Tasks_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceProjectTaskResource created on azure
// for more information of creating ServiceProjectTaskResource, please refer to the document of ServiceProjectTaskResource
string subscriptionId = "fc04246f-04c5-437e-ac5e-206a19e7193f";
string groupName = "DmsSdkRg";
string serviceName = "DmsSdkService";
string projectName = "DmsSdkProject";
string taskName = "DmsSdkTask";
ResourceIdentifier serviceProjectTaskResourceId = ServiceProjectTaskResource.CreateResourceIdentifier(subscriptionId, groupName, serviceName, projectName, taskName);
ServiceProjectTaskResource serviceProjectTask = client.GetServiceProjectTaskResource(serviceProjectTaskResourceId);

// invoke the operation
ServiceProjectTaskResource result = await serviceProjectTask.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ProjectTaskData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

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

定义

名称	说明
ApiError	错误信息。
AuthenticationType	连接时可能的身份验证类型的枚举
AzureActiveDirectoryApp	Azure Active Directory 应用程序
BackupFileInfo	备份文件的信息
BackupFileStatus	日志备份文件的 Status 枚举。
BackupMode	备份模式的枚举
BackupSetInfo	备份集的信息
BackupType	不同备份类型的枚举。
BlobShare	Blob 容器存储信息。
CommandState	命令的状态。如果已提交，则会忽略这一点。
ConnectToMongoDbTaskProperties	用于验证与 MongoDB 服务器的连接并提供 MongoDB 服务器相关信息的任务的属性
ConnectToSourceMySqlTaskInput	验证 MySQL 数据库连接的任务的输入
ConnectToSourceMySqlTaskProperties	验证 MySQL 数据库连接的任务的属性
ConnectToSourceNonSqlTaskOutput	连接到 MySQL 类型源的输出
ConnectToSourceOracleSyncTaskInput	验证 Oracle 数据库连接的任务的输入
ConnectToSourceOracleSyncTaskOutput	验证 Oracle 数据库连接的任务的输出
ConnectToSourceOracleSyncTaskProperties	用于验证 Oracle 数据库连接的任务的属性
ConnectToSourcePostgreSqlSyncTaskInput	验证与 PostgreSQL 的连接和源服务器要求的任务的输入
ConnectToSourcePostgreSqlSyncTaskOutput	验证与 PostgreSQL 的连接和源服务器要求的任务的输出
ConnectToSourcePostgreSqlSyncTaskProperties	用于验证与 PostgreSQL 服务器的连接的任务的属性以及联机迁移的源服务器要求
ConnectToSourceSqlServerSyncTaskProperties	用于验证联机迁移SQL Server的连接和源服务器要求的任务的属性
ConnectToSourceSqlServerTaskInput	验证与SQL Server的连接并验证源服务器要求的任务的输入
ConnectToSourceSqlServerTaskOutputAgentJobLevel	验证与SQL Server的连接并验证源服务器要求的任务的代理作业级别输出
ConnectToSourceSqlServerTaskOutputDatabaseLevel	验证与SQL Server的连接并验证源服务器要求的任务的数据库级别输出
ConnectToSourceSqlServerTaskOutputLoginLevel	验证与SQL Server的连接并验证源服务器要求的任务的登录级别输出
ConnectToSourceSqlServerTaskOutputTaskLevel	验证与SQL Server的连接并验证源服务器要求的任务的任务级别输出
ConnectToSourceSqlServerTaskProperties	验证与SQL Server的连接并验证源服务器要求的任务的属性
ConnectToTargetAzureDbForMySqlTaskInput	验证与Azure Database for MySQL和目标服务器要求的连接的任务的输入
ConnectToTargetAzureDbForMySqlTaskOutput	验证与Azure Database for MySQL和目标服务器要求的连接的任务的输出
ConnectToTargetAzureDbForMySqlTaskProperties	验证与Azure Database for MySQL和目标服务器要求的连接的任务的属性
ConnectToTargetAzureDbForPostgreSqlSyncTaskInput	验证与Azure Database for PostgreSQL和目标服务器要求的连接的任务的输入
ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput	验证与Azure Database for PostgreSQL和目标服务器要求的连接的任务的输出
ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties	验证与 Azure Database For PostgreSQL 服务器的连接的任务的属性，以及联机迁移的目标服务器要求
ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput	验证与 Oracle 源Azure Database for PostgreSQL和目标服务器要求的连接的任务的输入。
ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput	验证与 Oracle 源Azure Database for PostgreSQL和目标服务器要求的连接的任务的输出。
ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties	验证与 Azure Database For PostgreSQL 服务器的连接的任务的属性，以及 Oracle 源联机迁移的目标服务器要求。
ConnectToTargetSqlDbTaskInput	验证与 SQL DB 的连接和目标服务器要求的任务的输入
ConnectToTargetSqlDbTaskOutput	验证与 SQL DB 的连接和目标服务器要求的任务的输出
ConnectToTargetSqlDbTaskProperties	验证与 SQL DB 的连接和目标服务器要求的任务的属性
ConnectToTargetSqlMISyncTaskInput	验证与 Azure SQL Database 托管实例联机方案的连接的任务的输入。
ConnectToTargetSqlMISyncTaskOutput	验证与数据库托管实例Azure SQL连接的任务的输出。
ConnectToTargetSqlMISyncTaskProperties	验证与数据库托管实例Azure SQL连接的任务的属性
ConnectToTargetSqlMITaskInput	验证与数据库托管实例Azure SQL连接的任务的输入。
ConnectToTargetSqlMITaskOutput	验证与数据库托管实例Azure SQL连接的任务的输出。
ConnectToTargetSqlMITaskProperties	验证与数据库托管实例Azure SQL连接的任务的属性
ConnectToTargetSqlSqlDbSyncTaskInput	验证与Azure SQL DB 和目标服务器要求的连接的任务的输入
ConnectToTargetSqlSqlDbSyncTaskProperties	用于验证与 SQL DB 的连接的任务的属性以及联机迁移的目标服务器要求
createdByType
DatabaseBackupInfo	有关使用现有备份模式时备份文件的信息。
DatabaseCompatLevel	SQL Server数据库兼容性级别的枚举
DatabaseFileInfo	数据库文件特定信息
DatabaseFileType	SQL Server数据库文件类型的枚举
DatabaseMigrationStage	迁移的当前阶段
DatabaseMigrationState	数据库级迁移状态。
DatabaseSchemaMap	每个数据库的架构映射
DatabaseState	SQL Server数据库状态的枚举
DatabaseSummaryResult	迁移中的数据库结果摘要
DatabaseTable	表属性
DataIntegrityValidationResult	基于校验和的数据完整性验证结果的结果
DataItemMigrationSummaryResult	数据项迁移的基本摘要
ExecutionStatistics	有关执行迁移验证时发生的错误的说明
FileShare	包含路径、用户名和密码的文件共享信息。
GetTdeCertificatesSqlTaskInput	获取 Base64 编码格式的 TDE 证书的任务的输入。
GetTdeCertificatesSqlTaskOutput	获取 Base64 编码格式的 TDE 证书的任务的输出。
GetTdeCertificatesSqlTaskProperties	获取 Base64 编码格式的 TDE 证书的任务的属性。
GetUserTablesMySqlTaskInput	为给定的数据库列表收集用户表的任务输入
GetUserTablesMySqlTaskOutput	为给定的数据库列表收集用户表的任务的输出
GetUserTablesMySqlTaskProperties	任务的属性，该任务收集给定数据库列表的用户表
GetUserTablesOracleTaskInput	用于获取提供的 Oracle 架构列表中包含的表列表的任务的输入。
GetUserTablesOracleTaskOutput	获取提供的 Oracle 架构列表中包含的表列表的任务的输出。
GetUserTablesOracleTaskProperties	为给定的 Oracle 架构列表收集用户表的任务的属性
GetUserTablesPostgreSqlTaskInput	任务的输入，该任务获取提供的 PostgreSQL 数据库列表的表列表。
GetUserTablesPostgreSqlTaskOutput	获取提供的 PostgreSQL 数据库列表的表列表的任务的输出。
GetUserTablesPostgreSqlTaskProperties	任务的属性，该任务收集给定数据库列表的用户表
GetUserTablesSqlSyncTaskInput	为给定的数据库列表收集用户表的任务输入
GetUserTablesSqlSyncTaskOutput	为给定的数据库列表收集用户表的任务的输出
GetUserTablesSqlSyncTaskProperties	任务的属性，该任务收集给定数据库列表的用户表
GetUserTablesSqlTaskInput	为给定的数据库列表收集用户表的任务输入
GetUserTablesSqlTaskOutput	为给定的数据库列表收集用户表的任务的输出
GetUserTablesSqlTaskProperties	任务的属性，该任务收集给定数据库列表的用户表
LoginMigrationStage	登录迁移不同阶段的枚举。
LoginType	SMO LoginType 的枚举映射。
MigrateMISyncCompleteCommandInput	用于完成Azure SQL数据库托管实例联机迁移的命令的输入。
MigrateMISyncCompleteCommandOutput	完成Azure SQL数据库托管实例联机迁移的命令的输出。
MigrateMISyncCompleteCommandProperties	完成Azure SQL数据库托管实例联机迁移的命令的属性。
MigrateMongoDbTaskProperties	在 MongoDB 数据源之间迁移数据的任务的属性
MigrateMySqlAzureDbForMySqlOfflineDatabaseInput	脱机 MySQL 用于Azure Database for MySQL迁移任务输入的数据库特定信息
MigrateMySqlAzureDbForMySqlOfflineTaskInput	将 MySQL 数据库迁移到脱机迁移Azure Database for MySQL的任务的输入
MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel
MigrateMySqlAzureDbForMySqlOfflineTaskOutputError
MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel
MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel
MigrateMySqlAzureDbForMySqlOfflineTaskProperties	将 MySQL 数据库迁移到脱机迁移Azure Database for MySQL的任务的属性
MigrateMySqlAzureDbForMySqlSyncDatabaseInput	MySQL 用于Azure Database for MySQL迁移任务输入的数据库特定信息
MigrateMySqlAzureDbForMySqlSyncTaskInput	将 MySQL 数据库迁移到联机迁移Azure Database for MySQL的任务的输入
MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError
MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel
MigrateMySqlAzureDbForMySqlSyncTaskOutputError
MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel
MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel
MigrateMySqlAzureDbForMySqlSyncTaskProperties	将 MySQL 数据库迁移到联机迁移Azure Database for MySQL的任务的属性
MigrateOracleAzureDbForPostgreSqlSyncTaskProperties	将 Oracle 迁移到联机迁移Azure Database for PostgreSQL的任务的属性
MigrateOracleAzureDbPostgreSqlSyncDatabaseInput	Oracle 用于Azure Database for PostgreSQL迁移任务输入的数据库特定信息
MigrateOracleAzureDbPostgreSqlSyncTaskInput	将 Oracle 数据库迁移到联机迁移Azure Database for PostgreSQL的任务的输入
MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError
MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel
MigrateOracleAzureDbPostgreSqlSyncTaskOutputError
MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel
MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel
MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput	PostgreSQL 用于Azure Database for PostgreSQL迁移任务输入的数据库特定信息
MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput	用于迁移的选定表
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput	将 PostgreSQL 数据库迁移到联机迁移Azure Database for PostgreSQL的任务的输入
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel
MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties	将 PostgreSQL 数据库迁移到联机迁移Azure Database for PostgreSQL的任务的属性
MigrateSqlServerSqlDbDatabaseInput	SQL 用于Azure SQL数据库迁移任务输入的数据库特定信息
MigrateSqlServerSqlDbSyncDatabaseInput	SQL 用于Azure SQL数据库同步迁移任务输入的数据库特定信息
MigrateSqlServerSqlDbSyncTaskInput	将本地SQL Server数据库迁移到Azure SQL数据库以联机迁移的任务的输入
MigrateSqlServerSqlDbSyncTaskOutputDatabaseError
MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel
MigrateSqlServerSqlDbSyncTaskOutputError
MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel
MigrateSqlServerSqlDbSyncTaskOutputTableLevel
MigrateSqlServerSqlDbSyncTaskProperties	将本地SQL Server数据库迁移到 Azure SQL 数据库以便联机迁移的任务的属性
MigrateSqlServerSqlDbTaskInput	将本地SQL Server数据库迁移到 Azure SQL 数据库的任务的输入
MigrateSqlServerSqlDbTaskOutputDatabaseLevel
MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult
MigrateSqlServerSqlDbTaskOutputError
MigrateSqlServerSqlDbTaskOutputMigrationLevel
MigrateSqlServerSqlDbTaskOutputTableLevel
MigrateSqlServerSqlDbTaskOutputValidationResult
MigrateSqlServerSqlDbTaskProperties	将本地SQL Server数据库迁移到 Azure SQL 数据库的任务的属性
MigrateSqlServerSqlMIDatabaseInput	SQL 用于Azure SQL数据库托管实例迁移任务输入的数据库特定信息
MigrateSqlServerSqlMISyncTaskInput	将SQL Server数据库迁移到Azure SQL数据库托管实例联机方案的任务的输入。
MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel
MigrateSqlServerSqlMISyncTaskOutputError
MigrateSqlServerSqlMISyncTaskOutputMigrationLevel
MigrateSqlServerSqlMISyncTaskProperties	将SQL Server数据库迁移到Azure SQL数据库托管实例同步方案的任务的属性
MigrateSqlServerSqlMITaskInput	将SQL Server数据库迁移到Azure SQL数据库托管实例的任务的输入。
MigrateSqlServerSqlMITaskOutputAgentJobLevel
MigrateSqlServerSqlMITaskOutputDatabaseLevel
MigrateSqlServerSqlMITaskOutputError
MigrateSqlServerSqlMITaskOutputLoginLevel
MigrateSqlServerSqlMITaskOutputMigrationLevel
MigrateSqlServerSqlMITaskProperties	将SQL Server数据库迁移到Azure SQL数据库托管实例的任务的属性
MigrateSsisTaskInput	将 SSIS 包从 SQL Server 迁移到 Azure SQL 数据库托管实例的任务的输入。
MigrateSsisTaskOutputMigrationLevel
MigrateSsisTaskOutputProjectLevel
MigrateSsisTaskProperties	将 SSIS 包从SQL Server数据库迁移到Azure SQL数据库托管实例的任务的属性。
MigrateSyncCompleteCommandInput	用于完成数据库同步迁移的命令的输入。
MigrateSyncCompleteCommandOutput	完成数据库的同步迁移的命令的输出。
MigrateSyncCompleteCommandProperties	完成数据库同步迁移的命令的属性。
MigrationEligibilityInfo	有关服务器对象的迁移资格的信息
MigrationReportResult	迁移验证报告结果包含用于下载生成的报表的 URL。
MigrationState	迁移的当前状态
MigrationStatus	迁移的当前状态
MigrationValidationDatabaseSummaryResult	迁移验证数据库级别摘要结果
MigrationValidationOptions	迁移后要运行的验证类型
MigrationValidationResult	迁移验证结果
MiSqlConnectionInfo	创建与Azure SQL数据库托管实例的连接所需的属性
MongoDbClusterInfo	描述 MongoDB 数据源
MongoDbClusterType	数据源的类型
MongoDbCollectionInfo	描述 MongoDB 数据库中支持的集合
MongoDbCollectionProgress	描述集合的进度
MongoDbCollectionSettings	描述应如何迁移单个 MongoDB 集合
MongoDbConnectionInfo	描述与 MongoDB 数据源的连接
MongoDbDatabaseInfo	描述 MongoDB 数据源中的数据库
MongoDbDatabaseProgress	描述数据库的进度
MongoDbDatabaseSettings	描述应如何迁移单个 MongoDB 数据库
MongoDbError	描述 MongoDB 迁移期间发生的错误或警告
MongoDbErrorType	错误或警告的类型
MongoDbMigrationProgress	描述整体迁移的进度
MongoDbMigrationSettings	描述应如何执行 MongoDB 数据迁移
MongoDbMigrationState
MongoDbReplication	介绍如何将更改从源复制到目标。默认值为 OneTime。
MongoDbShardKeyField	描述 MongoDB 分片键中的字段引用
MongoDbShardKeyInfo	描述 MongoDB 分片键
MongoDbShardKeyOrder	字段排序
MongoDbShardKeySetting	描述 MongoDB 分片键
MongoDbThrottlingSettings	指定迁移的资源限制
MySqlConnectionInfo	有关连接到 MySQL 服务器的信息
MySqlTargetPlatformType	迁移的目标平台
ObjectType	具有差异的对象的类型。例如 (Table/View/StoredProcedure)
ODataError	OData 格式的错误信息。
OracleConnectionInfo	有关连接到 Oracle 服务器的信息
OrphanedUserInfo	SQL Server 数据库中孤立用户的信息。
PostgreSqlConnectionInfo	有关连接到 PostgreSQL 服务器的信息
ProjectTask	任务资源
QueryAnalysisValidationResult	源和目标之间的查询分析比较结果
QueryExecutionResult	介绍源和目标中执行的查询分析结果
ReplicateMigrationState	用于复制报告的迁移状态的包装器。
ReportableException	所有自定义异常的 Exception 对象
ScenarioSource	源类型的枚举
ScenarioTarget	目标类型的枚举
SchemaComparisonValidationResult	源和目标之间的架构比较结果
SchemaComparisonValidationResultType	有关执行迁移验证时发生的错误的说明
SelectedCertificateInput	要为已启用 TDE 的数据库导出证书的信息。
ServerLevelPermissionsGroup	验证的权限组。这些组将运行一组用于验证用户活动的权限。为正在执行的活动选择权限组。
ServerProperties	MySQL 类型源的服务器属性
Severity	验证错误的严重性
SqlConnectionInfo	有关连接到 SQL 数据库服务器的信息
SqlSourcePlatform	用于连接的服务器平台类型
SsisMigrationInfo	SSIS 存储类型的 SSIS 迁移信息，覆盖策略。
SsisMigrationOverwriteOption	SSIS 对象迁移的覆盖选项，在 DMS 中仅支持忽略和覆盖 (经典) 现在和将来可能会为容器对象添加重用选项
SsisMigrationStage	SSIS 迁移的当前阶段
SsisStoreType	DMS 中支持的源 SSIS 存储类型的枚举 (经典)
StartMigrationScenarioServerRoleResult	服务器角色迁移结果
SyncDatabaseMigrationReportingState	数据库级别联机迁移的不同状态的枚举。
SyncMigrationDatabaseErrorEvent	联机迁移的数据库迁移错误
SyncTableMigrationState	表级别联机迁移的不同状态的枚举。
SystemData
TaskState	任务的状态。如果提交，则忽略此项。
UpdateActionType	比较对象的实际差异的类型，同时执行架构比较
ValidateMigrationInputSqlServerSqlDbSyncTaskProperties	验证 SQL 到Azure SQL数据库同步迁移的迁移输入的任务的属性
ValidateMigrationInputSqlServerSqlMISyncTaskInput	将SQL Server数据库迁移到Azure SQL数据库托管实例联机方案的任务的输入。
ValidateMigrationInputSqlServerSqlMISyncTaskOutput	验证 Azure SQL 数据库托管实例联机迁移的迁移输入的任务的输出
ValidateMigrationInputSqlServerSqlMISyncTaskProperties	验证 SQL 到Azure SQL数据库托管实例同步方案的迁移输入的任务的属性
ValidateMigrationInputSqlServerSqlMITaskInput	验证 SQL 到Azure SQL 托管实例迁移输入的任务的输入
ValidateMigrationInputSqlServerSqlMITaskOutput	验证 SQL 到Azure SQL 托管实例迁移的迁移输入的任务的输出
ValidateMigrationInputSqlServerSqlMITaskProperties	验证 SQL 到数据库Azure SQL迁移输入的任务的属性托管实例
ValidateMongoDbTaskProperties	验证 MongoDB 数据源之间迁移的任务的属性
ValidateOracleAzureDbForPostgreSqlSyncTaskProperties	验证 Oracle 到联机迁移Azure Database for PostgreSQL迁移的任务的属性
ValidateOracleAzureDbPostgreSqlSyncTaskOutput	验证 Oracle 到联机迁移Azure Database for PostgreSQL的迁移输入的任务的输出
ValidateSyncMigrationInputSqlServerTaskInput	验证 SQL 同步迁移的迁移输入的任务的输入
ValidateSyncMigrationInputSqlServerTaskOutput	验证 SQL 同步迁移的迁移输入的任务的输出
ValidationError	有关执行迁移验证时发生的错误的说明
ValidationStatus	验证的当前状态
WaitStatistics	查询批处理执行期间收集的等待统计信息

ApiError

错误信息。

名称	类型	说明
error	ODataError	OData 格式的错误信息
systemData	SystemData	与资源的创建和上次修改相关的元数据。

AuthenticationType

连接时可能的身份验证类型的枚举

名称	类型	说明
ActiveDirectoryIntegrated	string
ActiveDirectoryPassword	string
None	string
SqlAuthentication	string
WindowsAuthentication	string

AzureActiveDirectoryApp

Azure Active Directory 应用程序

名称	类型	说明
appKey	string	用于向 Azure Active Directory 应用程序进行身份验证的密钥
applicationId	string	Azure Active Directory 应用程序的应用程序 ID
ignoreAzurePermissions	boolean	忽略在 AAD 应用上检查 Azure 权限
tenantId	string	客户的租户 ID

BackupFileInfo

备份文件的信息

名称	类型	说明
familySequenceNumber	integer	备份集中备份文件的序列号
fileLocation	string	共享文件夹中备份文件的位置
status	BackupFileStatus	迁移期间备份文件的状态

BackupFileStatus

日志备份文件的 Status 枚举。

名称	类型	说明
Arrived	string
Cancelled	string
Queued	string
Restored	string
Restoring	string
Uploaded	string
Uploading	string

BackupMode

备份模式的枚举

名称	类型	说明
CreateBackup	string
ExistingBackup	string

BackupSetInfo

备份集的信息

名称	类型	说明
backupFinishedDate	string	备份操作完成的日期和时间
backupSetId	string	备份文件集的 ID
backupStartDate	string	备份操作开始的日期和时间
backupType	BackupType	不同备份类型的枚举
databaseName	string	备份集所属的数据库的名称
firstLsn	string	备份文件的第一个日志序列号
isBackupRestored	boolean	备份集是否还原
lastLsn	string	备份文件的最后一个日志序列号
lastModifiedTime	string	共享位置中备份文件的上次修改时间
listOfBackupFiles	BackupFileInfo[]	备份集中的文件列表

BackupType

不同备份类型的枚举。

名称	类型	说明
Database	string
DifferentialDatabase	string
DifferentialFile	string
DifferentialPartial	string
File	string
Partial	string
TransactionLog	string

BlobShare

Blob 容器存储信息。

名称	类型	说明
sasUri	string	Azure 存储帐户容器的 SAS URI。

CommandState

命令的状态。如果已提交，则会忽略这一点。

名称	类型	说明
Accepted	string
Failed	string
Running	string
Succeeded	string
Unknown	string

ConnectToMongoDbTaskProperties

用于验证与 MongoDB 服务器的连接并提供 MongoDB 服务器相关信息的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果已提交，则会忽略这一点。
input	MongoDbConnectionInfo	描述与 MongoDB 数据源的连接
output	MongoDbClusterInfo[]	包含单个 MongoDbClusterInfo 对象的数组
state	TaskState	任务的状态。如果已提交，则会忽略这一点。
taskType	string: Connect.MongoDb	任务类型。

ConnectToSourceMySqlTaskInput

验证 MySQL 数据库连接的任务的输入

名称	类型	默认值	说明
checkPermissionsGroup	ServerLevelPermissionsGroup		用于验证的权限组
isOfflineMigration	boolean	False	指示迁移是否脱机的标志
sourceConnectionInfo	MySqlConnectionInfo		有关连接到 MySQL 源的信息
targetPlatform	MySqlTargetPlatformType		迁移的目标平台

ConnectToSourceMySqlTaskProperties

验证 MySQL 数据库连接的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果已提交，则会忽略这一点。
input	ConnectToSourceMySqlTaskInput	任务输入
output	ConnectToSourceNonSqlTaskOutput[]	任务输出。如果已提交，则会忽略这一点。
state	TaskState	任务的状态。如果已提交，则会忽略这一点。
taskType	string: ConnectToSource.MySql	任务类型。

ConnectToSourceNonSqlTaskOutput

连接到 MySQL 类型源的输出

名称	类型	说明
databases	string[]	服务器上的数据库列表
id	string	结果标识符
serverProperties	ServerProperties	服务器属性
sourceServerBrandVersion	string	服务器品牌版本
validationErrors	ReportableException[]	与任务关联的验证错误

ConnectToSourceOracleSyncTaskInput

验证 Oracle 数据库连接的任务的输入

名称	类型	说明
sourceConnectionInfo	OracleConnectionInfo	有关连接到 Oracle 源的信息

ConnectToSourceOracleSyncTaskOutput

验证 Oracle 数据库连接的任务的输出

名称	类型	说明
databases	string[]	源服务器上的架构列表
sourceServerBrandVersion	string	源服务器品牌版本
sourceServerVersion	string	源服务器的版本
validationErrors	ReportableException[]	与任务关联的验证错误

ConnectToSourceOracleSyncTaskProperties

用于验证 Oracle 数据库连接的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果已提交，则会忽略这一点。
input	ConnectToSourceOracleSyncTaskInput	任务输入
output	ConnectToSourceOracleSyncTaskOutput[]	任务输出。如果已提交，则会忽略这一点。
state	TaskState	任务的状态。如果已提交，则会忽略这一点。
taskType	string: ConnectToSource.Oracle.Sync	任务类型。

ConnectToSourcePostgreSqlSyncTaskInput

验证与 PostgreSQL 的连接和源服务器要求的任务的输入

名称	类型	说明
sourceConnectionInfo	PostgreSqlConnectionInfo	源 PostgreSQL 服务器的连接信息

ConnectToSourcePostgreSqlSyncTaskOutput

验证与 PostgreSQL 的连接和源服务器要求的任务的输出

名称	类型	说明
databases	string[]	源服务器上的数据库列表
id	string	结果标识符
sourceServerBrandVersion	string	源服务器品牌版本
sourceServerVersion	string	源服务器的版本
validationErrors	ReportableException[]	与任务关联的验证错误

ConnectToSourcePostgreSqlSyncTaskProperties

用于验证与 PostgreSQL 服务器的连接的任务的属性以及联机迁移的源服务器要求

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果已提交，则会忽略这一点。
input	ConnectToSourcePostgreSqlSyncTaskInput	任务输入
output	ConnectToSourcePostgreSqlSyncTaskOutput[]	任务输出。如果已提交，则会忽略这一点。
state	TaskState	任务的状态。如果已提交，则会忽略这一点。
taskType	string: ConnectToSource.PostgreSql.Sync	任务类型。

ConnectToSourceSqlServerSyncTaskProperties

用于验证联机迁移SQL Server的连接和源服务器要求的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果已提交，则会忽略这一点。
input	ConnectToSourceSqlServerTaskInput	任务输入
output	ConnectToSourceSqlServerTaskOutput[]: ConnectToSourceSqlServerTaskOutputAgentJobLevel[] ConnectToSourceSqlServerTaskOutputDatabaseLevel[] ConnectToSourceSqlServerTaskOutputLoginLevel[] ConnectToSourceSqlServerTaskOutputTaskLevel[]	任务输出。如果已提交，则会忽略这一点。
state	TaskState	任务的状态。如果已提交，则会忽略这一点。
taskType	string: ConnectToSource.SqlServer.Sync	任务类型。

ConnectToSourceSqlServerTaskInput

验证与SQL Server的连接并验证源服务器要求的任务的输入

名称	类型	默认值	说明
checkPermissionsGroup	ServerLevelPermissionsGroup		用于验证的权限组
collectAgentJobs	boolean	False	指示是否从源服务器收集代理作业的标志。
collectDatabases	boolean	True	是否从源服务器收集数据库的标志。
collectLogins	boolean	False	指示是否从源服务器收集登录名的标志。
collectTdeCertificateInfo	boolean	False	指示是否从源服务器收集 TDE 证书名称的标志。
encryptedKeyForSecureFields	string		安全字段的加密密钥
sourceConnectionInfo	SqlConnectionInfo		源SQL Server的连接信息
validateSsisCatalogOnly	boolean	False	指示是否在源服务器上可访问 SSIS 目录的标志。

ConnectToSourceSqlServerTaskOutputAgentJobLevel

验证与SQL Server的连接并验证源服务器要求的任务的代理作业级别输出

名称	类型	说明
id	string	结果标识符
isEnabled	boolean	原始代理作业的状态。
jobCategory	string	代理作业的类型。
jobOwner	string	代理作业的所有者
lastExecutedOn	string	UTC 上次执行代理作业的日期和时间。
migrationEligibility	MigrationEligibilityInfo	有关代理作业的迁移资格的信息。
name	string	代理作业名称
resultType	string: AgentJobLevelOutput	结果类型 - 数据库级别或任务级别
validationErrors	ReportableException[]	验证错误

ConnectToSourceSqlServerTaskOutputDatabaseLevel

验证与SQL Server的连接并验证源服务器要求的任务的数据库级别输出

名称	类型	说明
compatibilityLevel	DatabaseCompatLevel	SQL Server数据库的兼容性级别
databaseFiles	DatabaseFileInfo[]	数据库文件列表
databaseState	DatabaseState	数据库的状态
id	string	结果标识符
name	string	数据库名称
resultType	string: DatabaseLevelOutput	结果类型 - 数据库级别或任务级别
sizeMB	number	文件的大小（以 MB 为单位）

ConnectToSourceSqlServerTaskOutputLoginLevel

验证与SQL Server的连接并验证源服务器要求的任务的登录级别输出

名称	类型	说明
defaultDatabase	string	登录名的默认数据库。
id	string	结果标识符
isEnabled	boolean	登录的状态。
loginType	LoginType	登录类型。
migrationEligibility	MigrationEligibilityInfo	有关迁移登录资格的信息。
name	string	登录名。
resultType	string: LoginLevelOutput	结果类型 - 数据库级别或任务级别

ConnectToSourceSqlServerTaskOutputTaskLevel

验证与SQL Server的连接并验证源服务器要求的任务的任务级别输出

名称	类型	说明
agentJobs	object	将代理作业作为从代理作业名称映射到 ID 的源。
databaseTdeCertificateMapping	object	从数据库名称映射到 TDE 证书名称（如果适用）
databases	object	源数据库作为从数据库名称到数据库 ID 的映射
id	string	结果标识符
logins	object	源登录名作为从登录名到登录 ID 的映射。
resultType	string: TaskLevelOutput	结果类型 - 数据库级别或任务级别
sourceServerBrandVersion	string	源服务器品牌版本
sourceServerVersion	string	源服务器版本
validationErrors	ReportableException[]	验证错误

ConnectToSourceSqlServerTaskProperties

验证与SQL Server的连接并验证源服务器要求的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果已提交，则会忽略这一点。
input	ConnectToSourceSqlServerTaskInput	任务输入
output	ConnectToSourceSqlServerTaskOutput[]: ConnectToSourceSqlServerTaskOutputAgentJobLevel[] ConnectToSourceSqlServerTaskOutputDatabaseLevel[] ConnectToSourceSqlServerTaskOutputLoginLevel[] ConnectToSourceSqlServerTaskOutputTaskLevel[]	任务输出。如果已提交，则会忽略这一点。
state	TaskState	任务的状态。如果已提交，则会忽略这一点。
taskId	string	任务 ID
taskType	string: ConnectToSource.SqlServer	任务类型。

ConnectToTargetAzureDbForMySqlTaskInput

验证与Azure Database for MySQL和目标服务器要求的连接的任务的输入

名称	类型	默认值	说明
isOfflineMigration	boolean	False	指示迁移是否脱机的标志
sourceConnectionInfo	MySqlConnectionInfo		源 MySQL 服务器的连接信息
targetConnectionInfo	MySqlConnectionInfo		目标Azure Database for MySQL服务器的连接信息

ConnectToTargetAzureDbForMySqlTaskOutput

验证与Azure Database for MySQL和目标服务器要求的连接的任务的输出

名称	类型	说明
databases	string[]	目标服务器上的数据库列表
id	string	结果标识符
serverVersion	string	目标服务器的版本
targetServerBrandVersion	string	目标服务器品牌版本
validationErrors	ReportableException[]	与任务关联的验证错误

ConnectToTargetAzureDbForMySqlTaskProperties

验证与Azure Database for MySQL和目标服务器要求的连接的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	ConnectToTargetAzureDbForMySqlTaskInput	任务输入
output	ConnectToTargetAzureDbForMySqlTaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: ConnectToTarget.AzureDbForMySql	任务类型。

ConnectToTargetAzureDbForPostgreSqlSyncTaskInput

验证与Azure Database for PostgreSQL和目标服务器要求的连接的任务的输入

名称	类型	说明
sourceConnectionInfo	PostgreSqlConnectionInfo	源 PostgreSQL 服务器的连接信息
targetConnectionInfo	PostgreSqlConnectionInfo	目标Azure Database for PostgreSQL服务器的连接信息

ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput

验证与Azure Database for PostgreSQL和目标服务器要求的连接的任务的输出

名称	类型	说明
databases	string[]	目标服务器上的数据库列表
id	string	结果标识符
targetServerBrandVersion	string	目标服务器品牌版本
targetServerVersion	string	目标服务器的版本
validationErrors	ReportableException[]	与任务关联的验证错误

ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties

验证与 Azure Database For PostgreSQL 服务器的连接的任务的属性，以及联机迁移的目标服务器要求

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	ConnectToTargetAzureDbForPostgreSqlSyncTaskInput	任务输入
output	ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: ConnectToTarget.AzureDbForPostgreSql.Sync	任务类型。

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput

验证与 Oracle 源Azure Database for PostgreSQL和目标服务器要求的连接的任务的输入。

名称	类型	说明
targetConnectionInfo	PostgreSqlConnectionInfo	目标Azure Database for PostgreSQL服务器的连接信息

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput

验证与 Oracle 源Azure Database for PostgreSQL和目标服务器要求的连接的任务的输出。

名称	类型	说明
databaseSchemaMap	DatabaseSchemaMap[]	每个数据库的架构映射
databases	string[]	目标服务器上的数据库列表
targetServerBrandVersion	string	目标服务器品牌版本
targetServerVersion	string	目标服务器的版本
validationErrors	ReportableException[]	与任务关联的验证错误

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties

验证与 Azure Database For PostgreSQL 服务器的连接的任务的属性，以及 Oracle 源联机迁移的目标服务器要求。

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput	任务输入
output	ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync	任务类型。

ConnectToTargetSqlDbTaskInput

验证与 SQL DB 的连接和目标服务器要求的任务的输入

名称	类型	说明
queryObjectCounts	boolean	指示是否查询目标服务器上每个数据库的对象计数的布尔标志
targetConnectionInfo	SqlConnectionInfo	目标 SQL DB 的连接信息

ConnectToTargetSqlDbTaskOutput

验证与 SQL DB 的连接和目标服务器要求的任务的输出

名称	类型	说明
databases	object	源数据库作为从数据库名称映射到数据库 ID
id	string	结果标识符
targetServerBrandVersion	string	目标服务器品牌版本
targetServerVersion	string	目标服务器的版本

ConnectToTargetSqlDbTaskProperties

验证与 SQL DB 的连接和目标服务器要求的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
createdOn	string	创建任务时采用 UTC 格式的 DateTime
errors	ODataError[]	错误数组。如果已提交，则会忽略这一点。
input	ConnectToTargetSqlDbTaskInput	任务输入
output	ConnectToTargetSqlDbTaskOutput[]	任务输出。如果已提交，则会忽略这一点。
state	TaskState	任务的状态。如果已提交，则会忽略这一点。
taskType	string: ConnectToTarget.SqlDb	任务类型。

ConnectToTargetSqlMISyncTaskInput

验证与 Azure SQL Database 托管实例联机方案的连接的任务的输入。

名称	类型	说明
azureApp	AzureActiveDirectoryApp	Azure Active Directory 应用程序 DMS (经典) 实例将用于连接到 Azure SQL 数据库托管实例和 Azure 存储帐户的目标实例
targetConnectionInfo	MiSqlConnectionInfo	Azure SQL 数据库托管实例的连接信息

ConnectToTargetSqlMISyncTaskOutput

验证与数据库托管实例Azure SQL连接的任务的输出。

名称	类型	说明
targetServerBrandVersion	string	目标服务器品牌版本
targetServerVersion	string	目标服务器版本
validationErrors	ReportableException[]	验证错误

ConnectToTargetSqlMISyncTaskProperties

验证与数据库托管实例Azure SQL连接的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	ConnectToTargetSqlMISyncTaskInput	任务输入
output	ConnectToTargetSqlMISyncTaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: ConnectToTarget.AzureSqlDbMI.Sync.LRS	任务类型。

ConnectToTargetSqlMITaskInput

验证与数据库托管实例Azure SQL连接的任务的输入。

名称	类型	默认值	说明
collectAgentJobs	boolean	True	指示是否从目标 SQL MI 服务器收集代理作业的标志。
collectLogins	boolean	True	指示是否从目标 SQL MI 服务器收集登录名的标志。
targetConnectionInfo	SqlConnectionInfo		目标SQL Server的连接信息
validateSsisCatalogOnly	boolean	False	指示是否在目标 SQL MI 服务器上可访问 SSIS 目录的标志。

ConnectToTargetSqlMITaskOutput

验证与数据库托管实例Azure SQL连接的任务的输出。

名称	类型	说明
agentJobs	string[]	目标服务器上的代理作业列表。
id	string	结果标识符
logins	string[]	目标服务器上的登录名列表。
targetServerBrandVersion	string	目标服务器品牌版本
targetServerVersion	string	目标服务器版本
validationErrors	ReportableException[]	验证错误

ConnectToTargetSqlMITaskProperties

验证与数据库托管实例Azure SQL连接的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	ConnectToTargetSqlMITaskInput	任务输入
output	ConnectToTargetSqlMITaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: ConnectToTarget.AzureSqlDbMI	任务类型。

ConnectToTargetSqlSqlDbSyncTaskInput

验证与Azure SQL DB 和目标服务器要求的连接的任务的输入

名称	类型	说明
sourceConnectionInfo	SqlConnectionInfo	源SQL Server的连接信息
targetConnectionInfo	SqlConnectionInfo	目标 SQL DB 的连接信息

ConnectToTargetSqlSqlDbSyncTaskProperties

用于验证与 SQL DB 的连接的任务的属性以及联机迁移的目标服务器要求

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	ConnectToTargetSqlSqlDbSyncTaskInput	任务输入
output	ConnectToTargetSqlDbTaskOutput[]	任务输出。如果已提交，则会忽略这一点。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: ConnectToTarget.SqlDb.Sync	任务类型。

createdByType

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DatabaseBackupInfo

有关使用现有备份模式时备份文件的信息。

名称	类型	说明
backupFiles	string[]	当前数据库的备份文件列表。
backupFinishDate	string	备份操作完成的日期和时间。
backupType	BackupType	备份类型。
databaseName	string	数据库名称。
familyCount	integer	备份集中的文件数。
isCompressed	boolean	备份集是否已压缩
isDamaged	boolean	数据库在备份时已损坏，但尽管出错，但请求继续备份操作。
position	integer	文件中当前数据库备份的位置。

DatabaseCompatLevel

SQL Server数据库兼容性级别的枚举

名称	类型	说明
CompatLevel100	string
CompatLevel110	string
CompatLevel120	string
CompatLevel130	string
CompatLevel140	string
CompatLevel80	string
CompatLevel90	string

DatabaseFileInfo

数据库文件特定信息

名称	类型	说明
databaseName	string	数据库的名称
fileType	DatabaseFileType	数据库文件类型
id	string	数据库文件的唯一标识符
logicalName	string	文件的逻辑名称
physicalFullName	string	文件的操作系统完整路径
restoreFullName	string	建议用于还原的文件的完整路径
sizeMB	number	文件的大小（以 MB 为单位）

DatabaseFileType

SQL Server数据库文件类型的枚举

名称	类型	说明
Filestream	string
Fulltext	string
Log	string
NotSupported	string
Rows	string

DatabaseMigrationStage

迁移的当前阶段

名称	类型	说明
Backup	string
Completed	string
FileCopy	string
Initialize	string
None	string
Restore	string

DatabaseMigrationState

数据库级迁移状态。

名称	类型	说明
CANCELLED	string
COMPLETED	string
CUTOVER_START	string
FAILED	string
FULL_BACKUP_UPLOAD_START	string
INITIAL	string
LOG_SHIPPING_START	string
POST_CUTOVER_COMPLETE	string
UNDEFINED	string
UPLOAD_LOG_FILES_START	string

DatabaseSchemaMap

每个数据库的架构映射

名称	类型	说明
database	string
schemas	string[]

DatabaseState

SQL Server数据库状态的枚举

名称	类型	说明
Copying	string
Emergency	string
Offline	string
OfflineSecondary	string
Online	string
Recovering	string
RecoveryPending	string
Restoring	string
Suspect	string

DatabaseSummaryResult

迁移中的数据库结果摘要

名称	类型	说明
endedOn	string	迁移结束时间
errorPrefix	string	用于查询项的所有错误的通配符字符串前缀
itemsCompletedCount	integer	成功完成的项数
itemsCount	integer	项数
name	string	项的名称
resultPrefix	string	用于查询项目的所有子结果的通配符字符串前缀
sizeMB	number	数据库的大小（以 MB 为单位）
startedOn	string	迁移开始时间
state	MigrationState	迁移的当前状态
statusMessage	string	状态消息

DatabaseTable

表属性

名称	类型	说明
hasRows	boolean	指示表是否为空
name	string	表的架构限定名称

DataIntegrityValidationResult

基于校验和的数据完整性验证结果的结果

名称	类型	说明
failedObjects	object	源对和目标对的失败表名称列表
validationErrors	ValidationError	执行数据完整性验证时发生的错误列表

DataItemMigrationSummaryResult

数据项迁移的基本摘要

名称	类型	说明
endedOn	string	迁移结束时间
errorPrefix	string	用于查询项的所有错误的通配符字符串前缀
itemsCompletedCount	integer	成功完成的项数
itemsCount	integer	项数
name	string	项的名称
resultPrefix	string	用于查询项目的所有子结果的通配符字符串前缀
startedOn	string	迁移开始时间
state	MigrationState	迁移的当前状态
statusMessage	string	状态消息

ExecutionStatistics

有关执行迁移验证时发生的错误的说明

名称	类型	说明
cpuTimeMs	number	查询执行的 CPU 时间（以毫秒为单位 (s) ）
elapsedTimeMs	number	执行查询 () 所花费的时间（以毫秒为单位）
executionCount	integer	错误。查询执行的
hasErrors	boolean	指示查询是否导致错误
sqlErrors	string[]	SQL 错误列表
waitStats	<string, WaitStatistics>	sql 查询执行等待类型和相应统计信息的字典

FileShare

包含路径、用户名和密码的文件共享信息。

名称	类型	说明
password	string	用于连接到共享位置的密码凭据。
path	string	此共享的文件夹路径。
userName	string	用于连接到共享位置的用户名凭据

GetTdeCertificatesSqlTaskInput

获取 Base64 编码格式的 TDE 证书的任务的输入。

名称	类型	说明
backupFileShare	FileShare	要用于临时存储文件的文件共享的文件共享的备份信息。
connectionInfo	SqlConnectionInfo	SQL Server的连接信息
selectedCertificates	SelectedCertificateInput[]	包含用于加密导出证书的证书名称和相应密码的列表。

GetTdeCertificatesSqlTaskOutput

获取 Base64 编码格式的 TDE 证书的任务的输出。

名称	类型	说明
base64EncodedCertificates	object	从证书名称映射到 base 64 编码格式。
validationErrors	ReportableException[]	验证错误

GetTdeCertificatesSqlTaskProperties

获取 Base64 编码格式的 TDE 证书的任务的属性。

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	GetTdeCertificatesSqlTaskInput	任务输入
output	GetTdeCertificatesSqlTaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: GetTDECertificates.Sql	任务类型。

GetUserTablesMySqlTaskInput

为给定的数据库列表收集用户表的任务输入

名称	类型	说明
connectionInfo	MySqlConnectionInfo	SQL Server的连接信息
selectedDatabases	string[]	要为其收集表的数据库名称列表

GetUserTablesMySqlTaskOutput

为给定的数据库列表收集用户表的任务的输出

名称	类型	说明
databasesToTables	object	从数据库名称映射到表列表
id	string	结果标识符
validationErrors	ReportableException[]	验证错误

GetUserTablesMySqlTaskProperties

任务的属性，该任务收集给定数据库列表的用户表

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	GetUserTablesMySqlTaskInput	任务输入
output	GetUserTablesMySqlTaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: GetUserTablesMySql	任务类型。

GetUserTablesOracleTaskInput

用于获取提供的 Oracle 架构列表中包含的表列表的任务的输入。

名称	类型	说明
connectionInfo	OracleConnectionInfo	有关连接到 Oracle 源的信息
selectedSchemas	string[]	要为其收集表的 Oracle 架构列表

GetUserTablesOracleTaskOutput

获取提供的 Oracle 架构列表中包含的表列表的任务的输出。

名称	类型	说明
schemaName	string	此结果适用于的架构
tables	DatabaseTable[]	为此架构找到的有效表的列表
validationErrors	ReportableException[]	与任务关联的验证错误

GetUserTablesOracleTaskProperties

为给定的 Oracle 架构列表收集用户表的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	GetUserTablesOracleTaskInput	任务输入
output	GetUserTablesOracleTaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: GetUserTablesOracle	任务类型。

GetUserTablesPostgreSqlTaskInput

任务的输入，该任务获取提供的 PostgreSQL 数据库列表的表列表。

名称	类型	说明
connectionInfo	PostgreSqlConnectionInfo	有关连接到 PostgreSQL 源的信息
selectedDatabases	string[]	要为其收集表的 PostgreSQL 数据库列表

GetUserTablesPostgreSqlTaskOutput

获取提供的 PostgreSQL 数据库列表的表列表的任务的输出。

名称	类型	说明
databaseName	string	此结果所针对的数据库
tables	DatabaseTable[]	为此数据库找到的有效表的列表
validationErrors	ReportableException[]	与任务关联的验证错误

GetUserTablesPostgreSqlTaskProperties

任务的属性，该任务收集给定数据库列表的用户表

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	GetUserTablesPostgreSqlTaskInput	任务输入
output	GetUserTablesPostgreSqlTaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: GetUserTablesPostgreSql	任务类型。

GetUserTablesSqlSyncTaskInput

为给定的数据库列表收集用户表的任务输入

名称	类型	说明
selectedSourceDatabases	string[]	要为其收集表的源数据库名称列表
selectedTargetDatabases	string[]	要为其收集表的目标数据库名称列表
sourceConnectionInfo	SqlConnectionInfo	SQL Server的连接信息
targetConnectionInfo	SqlConnectionInfo	SQL DB 的连接信息

GetUserTablesSqlSyncTaskOutput

为给定的数据库列表收集用户表的任务的输出

名称	类型	说明
databasesToSourceTables	object	从数据库名称映射到源表列表
databasesToTargetTables	object	从数据库名称映射到目标表列表
tableValidationErrors	object	从数据库名称映射到验证错误列表
validationErrors	ReportableException[]	验证错误

GetUserTablesSqlSyncTaskProperties

任务的属性，该任务收集给定数据库列表的用户表

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	GetUserTablesSqlSyncTaskInput	任务输入
output	GetUserTablesSqlSyncTaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: GetUserTables.AzureSqlDb.Sync	任务类型。

GetUserTablesSqlTaskInput

为给定的数据库列表收集用户表的任务输入

名称	类型	说明
connectionInfo	SqlConnectionInfo	SQL Server的连接信息
encryptedKeyForSecureFields	string	安全字段的加密密钥
selectedDatabases	string[]	要为其收集表的数据库名称列表

GetUserTablesSqlTaskOutput

为给定的数据库列表收集用户表的任务的输出

名称	类型	说明
databasesToTables	object	从数据库名称映射到表列表
id	string	结果标识符
validationErrors	ReportableException[]	验证错误

GetUserTablesSqlTaskProperties

任务的属性，该任务收集给定数据库列表的用户表

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	GetUserTablesSqlTaskInput	任务输入
output	GetUserTablesSqlTaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskId	string	任务 ID
taskType	string: GetUserTables.Sql	任务类型。

LoginMigrationStage

登录迁移不同阶段的枚举。

名称	类型	说明
AssignRoleMembership	string
AssignRoleOwnership	string
Completed	string
EstablishObjectPermissions	string
EstablishServerPermissions	string
EstablishUserMapping	string
Initialize	string
LoginMigration	string
None	string

LoginType

SMO LoginType 的枚举映射。

名称	类型	说明
AsymmetricKey	string
Certificate	string
ExternalGroup	string
ExternalUser	string
SqlLogin	string
WindowsGroup	string
WindowsUser	string

MigrateMISyncCompleteCommandInput

用于完成Azure SQL数据库托管实例联机迁移的命令的输入。

名称	类型	说明
sourceDatabaseName	string	托管实例数据库的名称

MigrateMISyncCompleteCommandOutput

完成Azure SQL数据库托管实例联机迁移的命令的输出。

名称	类型	说明
errors	ReportableException[]	命令执行期间发生的错误列表

MigrateMISyncCompleteCommandProperties

完成Azure SQL数据库托管实例联机迁移的命令的属性。

名称	类型	说明
commandType	string: Migrate.SqlServer.AzureDbSqlMi.Complete	命令类型。
errors	ODataError[]	错误数组。如果已提交，则会忽略这一点。
input	MigrateMISyncCompleteCommandInput	命令输入
output	MigrateMISyncCompleteCommandOutput	命令输出。如果已提交，则会忽略这一点。
state	CommandState	命令的状态。如果已提交，则会忽略这一点。

MigrateMongoDbTaskProperties

在 MongoDB 数据源之间迁移数据的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	MongoDbMigrationSettings	描述应如何执行 MongoDB 数据迁移
output	MongoDbProgress[]: MongoDbCollectionProgress[] MongoDbDatabaseProgress[] MongoDbMigrationProgress[]	MongoDB 迁移输出的基类
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: Migrate.MongoDb	任务类型。

MigrateMySqlAzureDbForMySqlOfflineDatabaseInput

脱机 MySQL 用于Azure Database for MySQL迁移任务输入的数据库特定信息

名称	类型	说明
name	string	数据库的名称
tableMap	object	源表到目标表的映射
targetDatabaseName	string	目标数据库的名称。注意：在开始迁移之前，目标数据库将被截断。

MigrateMySqlAzureDbForMySqlOfflineTaskInput

将 MySQL 数据库迁移到脱机迁移Azure Database for MySQL的任务的输入

名称	类型	默认值	说明
encryptedKeyForSecureFields	string		安全字段的加密密钥
makeSourceServerReadOnly	boolean	False	用于将源服务器设置为只读的设置
optionalAgentSettings	object		用于在迁移期间微调数据传输速率的可选参数
selectedDatabases	MigrateMySqlAzureDbForMySqlOfflineDatabaseInput[]		要迁移的数据库
sourceConnectionInfo	MySqlConnectionInfo		源 MySQL 的连接信息
startedOn	string		用于指定迁移开始时间的参数
targetConnectionInfo	MySqlConnectionInfo		目标Azure Database for MySQL的连接信息

MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel

名称	类型	说明
databaseName	string	数据库的名称
endedOn	string	迁移结束时间
errorCount	integer	数据库/对象错误数。
errorPrefix	string	用于查询项的所有错误的通配符字符串前缀
exceptionsAndWarnings	ReportableException[]	迁移异常和警告。
id	string	结果标识符
lastStorageUpdate	string	上次更新存储的时间
message	string	迁移进度消息
numberOfObjects	integer	对象数
numberOfObjectsCompleted	integer	成功完成的对象数
objectSummary	<string, DataItemMigrationSummaryResult>	迁移中的对象结果摘要
resultPrefix	string	用于查询项目的所有子结果的通配符字符串前缀
resultType	string: DatabaseLevelOutput	结果类型
stage	DatabaseMigrationStage	此数据库处于的迁移阶段
startedOn	string	迁移开始时间
state	MigrationState	迁移的当前状态
statusMessage	string	状态消息

MigrateMySqlAzureDbForMySqlOfflineTaskOutputError

名称	类型	说明
error	ReportableException	迁移错误
id	string	异常的唯一标识符
resultType	string: ErrorOutput	结果类型

MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel

名称	类型	说明
databaseSummary	<string, DatabaseSummaryResult>	迁移中的数据库结果摘要
databases	object	所选数据库作为从数据库名称到数据库 ID 的映射
durationInSeconds	integer	任务执行的持续时间（以秒为单位）。
endedOn	string	迁移结束时间
exceptionsAndWarnings	ReportableException[]	迁移异常和警告。
id	string	结果标识符
lastStorageUpdate	string	上次更新存储的时间
message	string	迁移进度消息
migrationReportResult	MigrationReportResult	迁移报告结果提供用于下载迁移报告的唯一 URL。
resultType	string: MigrationLevelOutput	结果类型
sourceServerBrandVersion	string	源服务器品牌版本
sourceServerVersion	string	源服务器版本
startedOn	string	迁移开始时间
status	MigrationStatus	迁移的当前状态
statusMessage	string	迁移状态消息
targetServerBrandVersion	string	目标服务器品牌版本
targetServerVersion	string	目标服务器版本

MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel

名称	类型	说明
endedOn	string	迁移结束时间
errorPrefix	string	用于查询项的所有错误的通配符字符串前缀
id	string	结果标识符
itemsCompletedCount	integer	成功完成的项数
itemsCount	integer	项数
lastStorageUpdate	string	上次更新存储的时间
objectName	string	项的名称
resultPrefix	string	用于查询项目的所有子结果的通配符字符串前缀
resultType	string: TableLevelOutput	结果类型
startedOn	string	迁移开始时间
state	MigrationState	迁移的当前状态
statusMessage	string	状态消息

MigrateMySqlAzureDbForMySqlOfflineTaskProperties

将 MySQL 数据库迁移到脱机迁移Azure Database for MySQL的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	MigrateMySqlAzureDbForMySqlOfflineTaskInput	任务输入
isCloneable	boolean	任务是否可以克隆
output	MigrateMySqlAzureDbForMySqlOfflineTaskOutput[]: MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel[] MigrateMySqlAzureDbForMySqlOfflineTaskOutputError[] MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel[] MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskId	string	任务 ID
taskType	string: Migrate.MySql.AzureDbForMySql	任务类型。

MigrateMySqlAzureDbForMySqlSyncDatabaseInput

MySQL 用于Azure Database for MySQL迁移任务输入的数据库特定信息

名称	类型	说明
migrationSetting	object	优化迁移行为的迁移设置
name	string	数据库的名称
sourceSetting	object	用于优化源终结点迁移行为的源设置
tableMap	object	源表到目标表的映射
targetDatabaseName	string	目标数据库的名称。注意：在开始迁移之前，目标数据库将被截断。
targetSetting	object	用于优化目标终结点迁移行为的目标设置

MigrateMySqlAzureDbForMySqlSyncTaskInput

将 MySQL 数据库迁移到联机迁移Azure Database for MySQL的任务的输入

名称	类型	说明
selectedDatabases	MigrateMySqlAzureDbForMySqlSyncDatabaseInput[]	要迁移的数据库
sourceConnectionInfo	MySqlConnectionInfo	源 MySQL 的连接信息
targetConnectionInfo	MySqlConnectionInfo	目标Azure Database for MySQL的连接信息

MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError

名称	类型	说明
errorMessage	string	错误消息
events	SyncMigrationDatabaseErrorEvent[]	错误事件列表。
id	string	结果标识符
resultType	string: DatabaseLevelErrorOutput	结果类型

MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel

名称	类型	说明
appliedChanges	integer	已应用的更改数
cdcDeleteCounter	integer	cdc 删除次数
cdcInsertCounter	integer	cdc 插入次数
cdcUpdateCounter	integer	cdc 更新数
databaseName	string	数据库的名称
endedOn	string	迁移结束时间
fullLoadCompletedTables	integer	完全加载中完成的表数
fullLoadErroredTables	integer	完全加载时出错的表数
fullLoadLoadingTables	integer	完全加载中加载的表数
fullLoadQueuedTables	integer	完全加载中排队的表数
id	string	结果标识符
incomingChanges	integer	传入更改数
initializationCompleted	boolean	指示初始加载 (完全加载) 是否已完成
latency	integer	CDC 应用延迟
migrationState	SyncDatabaseMigrationReportingState	此数据库处于的迁移状态
resultType	string: DatabaseLevelOutput	结果类型
startedOn	string	迁移开始时间

MigrateMySqlAzureDbForMySqlSyncTaskOutputError

名称	类型	说明
error	ReportableException	迁移错误
id	string	结果标识符
resultType	string: ErrorOutput	结果类型

MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel

名称	类型	说明
endedOn	string	迁移结束时间
id	string	结果标识符
resultType	string: MigrationLevelOutput	结果类型
sourceServer	string	源服务器名称
sourceServerVersion	string	源服务器版本
startedOn	string	迁移开始时间
targetServer	string	目标服务器名称
targetServerVersion	string	目标服务器版本

MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel

名称	类型	说明
cdcDeleteCounter	string	应用的删除次数
cdcInsertCounter	string	应用的插入次数
cdcUpdateCounter	string	应用的更新数
dataErrorsCounter	integer	发生的数据错误数
databaseName	string	数据库的名称
fullLoadEndedOn	string	完全加载结束时间
fullLoadEstFinishTime	string	估计完成完整负载
fullLoadStartedOn	string	完全加载开始时间
fullLoadTotalRows	integer	完全加载中应用的行数
id	string	结果标识符
lastModifiedTime	string	上次修改目标时间
resultType	string: TableLevelOutput	结果类型
state	SyncTableMigrationState	表迁移的当前状态
tableName	string	表名称
totalChangesApplied	integer	已应用的更改总数

MigrateMySqlAzureDbForMySqlSyncTaskProperties

将 MySQL 数据库迁移到联机迁移Azure Database for MySQL的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	MigrateMySqlAzureDbForMySqlSyncTaskInput	任务输入
output	MigrateMySqlAzureDbForMySqlSyncTaskOutput[]: MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError[] MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel[] MigrateMySqlAzureDbForMySqlSyncTaskOutputError[] MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel[] MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: Migrate.MySql.AzureDbForMySql.Sync	任务类型。

MigrateOracleAzureDbForPostgreSqlSyncTaskProperties

将 Oracle 迁移到联机迁移Azure Database for PostgreSQL的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	MigrateOracleAzureDbPostgreSqlSyncTaskInput	任务输入
output	MigrateOracleAzureDbPostgreSqlSyncTaskOutput[]: MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError[] MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel[] MigrateOracleAzureDbPostgreSqlSyncTaskOutputError[] MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel[] MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: Migrate.Oracle.AzureDbForPostgreSql.Sync	任务类型。

MigrateOracleAzureDbPostgreSqlSyncDatabaseInput

Oracle 用于Azure Database for PostgreSQL迁移任务输入的数据库特定信息

名称	类型	说明
caseManipulation	string	如何处理对象名称大小写：Preserve 或 ToLower
migrationSetting	object	用于优化迁移行为的迁移设置
name	string	迁移管道的名称
schemaName	string	源架构的名称
sourceSetting	object	用于优化源终结点迁移行为的源设置
tableMap	object	源表到目标表的映射
targetDatabaseName	string	目标数据库的名称。注意：在开始迁移之前，目标数据库将被截断。
targetSetting	object	用于优化目标终结点迁移行为的目标设置

MigrateOracleAzureDbPostgreSqlSyncTaskInput

将 Oracle 数据库迁移到联机迁移Azure Database for PostgreSQL的任务的输入

名称	类型	说明
selectedDatabases	MigrateOracleAzureDbPostgreSqlSyncDatabaseInput[]	要迁移的数据库
sourceConnectionInfo	OracleConnectionInfo	源 Oracle 的连接信息
targetConnectionInfo	PostgreSqlConnectionInfo	目标Azure Database for PostgreSQL的连接信息

MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError

名称	类型	说明
errorMessage	string	错误消息
events	SyncMigrationDatabaseErrorEvent[]	错误事件列表。
id	string	结果标识符
resultType	string: DatabaseLevelErrorOutput	结果类型

MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel

名称	类型	说明
appliedChanges	integer	应用的更改数
cdcDeleteCounter	integer	cdc 删除数
cdcInsertCounter	integer	cdc 插入次数
cdcUpdateCounter	integer	cdc 更新数
databaseName	string	数据库的名称
endedOn	string	迁移结束时间
fullLoadCompletedTables	integer	完全加载中完成的表数
fullLoadErroredTables	integer	完全加载时出错的表数
fullLoadLoadingTables	integer	满载加载的表数
fullLoadQueuedTables	integer	完全加载中排队的表数
id	string	结果标识符
incomingChanges	integer	传入更改数
initializationCompleted	boolean	指示初始加载 (完整负载) 是否已完成
latency	integer	CDC 应用延迟
migrationState	SyncDatabaseMigrationReportingState	此数据库处于的迁移状态
resultType	string: DatabaseLevelOutput	结果类型
startedOn	string	迁移开始时间

MigrateOracleAzureDbPostgreSqlSyncTaskOutputError

名称	类型	说明
error	ReportableException	迁移错误
id	string	结果标识符
resultType	string: ErrorOutput	结果类型

MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel

名称	类型	说明
endedOn	string	迁移结束时间
id	string	结果标识符
resultType	string: MigrationLevelOutput	结果类型
sourceServer	string	源服务器名称
sourceServerVersion	string	源服务器版本
startedOn	string	迁移开始时间
targetServer	string	目标服务器名称
targetServerVersion	string	目标服务器版本

MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel

名称	类型	说明
cdcDeleteCounter	integer	应用的删除次数
cdcInsertCounter	integer	应用的插入数
cdcUpdateCounter	integer	应用的更新数
dataErrorsCounter	integer	发生的数据错误数
databaseName	string	数据库的名称
fullLoadEndedOn	string	满载结束时间
fullLoadEstFinishTime	string	估计完成完整负载
fullLoadStartedOn	string	满载开始时间
fullLoadTotalRows	integer	完全加载中应用的行数
id	string	结果标识符
lastModifiedTime	string	上次修改目标时间
resultType	string: TableLevelOutput	结果类型
state	SyncTableMigrationState	表迁移的当前状态
tableName	string	表名称
totalChangesApplied	integer	应用的更改总数

MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput

PostgreSQL 用于Azure Database for PostgreSQL迁移任务输入的数据库特定信息

名称	类型	说明
id	string	结果标识符
migrationSetting		用于优化迁移行为的迁移设置
name	string	数据库的名称
selectedTables	MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput[]	选择用于迁移的表
sourceSetting	object	用于优化源终结点迁移行为的源设置
targetDatabaseName	string	目标数据库的名称。注意：在开始迁移之前，目标数据库将被截断。
targetSetting	object	用于优化目标终结点迁移行为的目标设置

MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput

用于迁移的选定表

名称	类型	说明
name	string	要迁移的表的名称

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput

将 PostgreSQL 数据库迁移到联机迁移Azure Database for PostgreSQL的任务的输入

名称	类型	说明
encryptedKeyForSecureFields	string	安全字段的加密密钥
selectedDatabases	MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput[]	要迁移的数据库
sourceConnectionInfo	PostgreSqlConnectionInfo	源 PostgreSQL 的连接信息
startedOn	string	迁移开始时间
targetConnectionInfo	PostgreSqlConnectionInfo	目标Azure Database for PostgreSQL的连接信息

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError

名称	类型	说明
errorMessage	string	错误消息
events	SyncMigrationDatabaseErrorEvent[]	错误事件列表。
id	string	结果标识符
resultType	string: DatabaseLevelErrorOutput	结果类型

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel

名称	类型	说明
appliedChanges	integer	应用的更改数
cdcDeleteCounter	integer	cdc 删除数
cdcInsertCounter	integer	cdc 插入次数
cdcUpdateCounter	integer	cdc 更新数
databaseName	string	数据库的名称
endedOn	string	迁移结束时间
fullLoadCompletedTables	integer	完全加载中完成的表数
fullLoadErroredTables	integer	完全加载时出错的表数
fullLoadLoadingTables	integer	满载加载的表数
fullLoadQueuedTables	integer	完全加载中排队的表数
id	string	结果标识符
incomingChanges	integer	传入更改数
initializationCompleted	boolean	指示初始加载 (完整负载) 是否已完成
latency	integer	CDC 应用延迟
migrationState	SyncDatabaseMigrationReportingState	此数据库处于的迁移状态
resultType	string: DatabaseLevelOutput	结果类型
startedOn	string	迁移开始时间

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError

名称	类型	说明
error	ReportableException	迁移错误
events	SyncMigrationDatabaseErrorEvent[]	错误事件列表
id	string	结果标识符
resultType	string: ErrorOutput	结果类型

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel

名称	类型	说明
databaseCount	number	要包含的数据库数
endedOn	string	迁移结束时间
id	string	结果标识符
resultType	string: MigrationLevelOutput	结果类型
sourceServer	string	源服务器名称
sourceServerType	ScenarioSource	源服务器类型。
sourceServerVersion	string	源服务器版本
startedOn	string	迁移开始时间
state	ReplicateMigrationState	迁移状态
targetServer	string	目标服务器名称
targetServerType	ScenarioTarget	目标服务器类型。
targetServerVersion	string	目标服务器版本

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel

名称	类型	说明
cdcDeleteCounter	integer	应用的删除次数
cdcInsertCounter	integer	应用的插入数
cdcUpdateCounter	integer	应用的更新数
dataErrorsCounter	integer	发生的数据错误数
databaseName	string	数据库的名称
fullLoadEndedOn	string	满载结束时间
fullLoadEstFinishTime	string	估计完成完整负载
fullLoadStartedOn	string	满载开始时间
fullLoadTotalRows	integer	完全加载中应用的行数
id	string	结果标识符
lastModifiedTime	string	上次修改目标时间
resultType	string: TableLevelOutput	结果类型
state	SyncTableMigrationState	表迁移的当前状态
tableName	string	表名称
totalChangesApplied	integer	应用的更改总数

MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties

将 PostgreSQL 数据库迁移到联机迁移Azure Database for PostgreSQL的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
createdOn	string	创建任务时采用 UTC 格式的 DateTime
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput	任务输入
isCloneable	boolean	任务是否可以克隆
output	MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput[]: MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError[] MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel[] MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError[] MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel[] MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskId	string	任务 ID
taskType	string: Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2	任务类型。

MigrateSqlServerSqlDbDatabaseInput

SQL 用于Azure SQL数据库迁移任务输入的数据库特定信息

名称	类型	说明
id	string	数据库的 ID
makeSourceDbReadOnly	boolean	是否在迁移前将数据库设置为只读
name	string	数据库的名称
schemaSetting	object	为数据库架构迁移选择的设置。
tableMap	object	源表到目标表的映射
targetDatabaseName	string	目标数据库的名称。注意：在开始迁移之前，目标数据库将被截断。

MigrateSqlServerSqlDbSyncDatabaseInput

SQL 用于Azure SQL数据库同步迁移任务输入的数据库特定信息

名称	类型	说明
id	string	数据库的唯一标识符
migrationSetting	object	优化迁移行为的迁移设置
name	string	数据库的名称
schemaName	string	要迁移的架构名称
sourceSetting	object	用于优化源终结点迁移行为的源设置
tableMap	object	源表到目标表的映射
targetDatabaseName	string	目标数据库名称
targetSetting	object	用于优化目标终结点迁移行为的目标设置

MigrateSqlServerSqlDbSyncTaskInput

将本地SQL Server数据库迁移到Azure SQL数据库以联机迁移的任务的输入

名称	类型	说明
selectedDatabases	MigrateSqlServerSqlDbSyncDatabaseInput[]	要迁移的数据库
sourceConnectionInfo	SqlConnectionInfo	有关连接到源的信息
targetConnectionInfo	SqlConnectionInfo	有关连接到目标的信息
validationOptions	MigrationValidationOptions	验证选项

MigrateSqlServerSqlDbSyncTaskOutputDatabaseError

名称	类型	说明
errorMessage	string	错误消息
events	SyncMigrationDatabaseErrorEvent[]	错误事件列表。
id	string	结果标识符
resultType	string: DatabaseLevelErrorOutput	结果类型

MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel

名称	类型	说明
appliedChanges	integer	已应用的更改数
cdcDeleteCounter	integer	cdc 删除次数
cdcInsertCounter	integer	cdc 插入次数
cdcUpdateCounter	integer	cdc 更新数
databaseName	string	数据库的名称
endedOn	string	迁移结束时间
fullLoadCompletedTables	integer	完全加载中完成的表数
fullLoadErroredTables	integer	完全加载时出错的表数
fullLoadLoadingTables	integer	完全加载中加载的表数
fullLoadQueuedTables	integer	完全加载中排队的表数
id	string	结果标识符
incomingChanges	integer	传入更改数
initializationCompleted	boolean	指示初始加载 (完全加载) 是否已完成
latency	integer	CDC 应用延迟
migrationState	SyncDatabaseMigrationReportingState	此数据库处于的迁移状态
resultType	string: DatabaseLevelOutput	结果类型
startedOn	string	迁移开始时间

MigrateSqlServerSqlDbSyncTaskOutputError

名称	类型	说明
error	ReportableException	迁移错误
id	string	结果标识符
resultType	string: ErrorOutput	结果类型

MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel

名称	类型	说明
databaseCount	integer	数据库计数
endedOn	string	迁移结束时间
id	string	结果标识符
resultType	string: MigrationLevelOutput	结果类型
sourceServer	string	源服务器名称
sourceServerVersion	string	源服务器版本
startedOn	string	迁移开始时间
targetServer	string	目标服务器名称
targetServerVersion	string	目标服务器版本

MigrateSqlServerSqlDbSyncTaskOutputTableLevel

名称	类型	说明
cdcDeleteCounter	integer	应用的删除次数
cdcInsertCounter	integer	应用的插入次数
cdcUpdateCounter	integer	应用的更新数
dataErrorsCounter	integer	发生的数据错误数
databaseName	string	数据库的名称
fullLoadEndedOn	string	完全加载结束时间
fullLoadEstFinishTime	string	估计完成完整负载
fullLoadStartedOn	string	完全加载开始时间
fullLoadTotalRows	integer	完全加载中应用的行数
id	string	结果标识符
lastModifiedTime	string	上次修改目标时间
resultType	string: TableLevelOutput	结果类型
state	SyncTableMigrationState	表迁移的当前状态
tableName	string	表名称
totalChangesApplied	integer	已应用的更改总数

MigrateSqlServerSqlDbSyncTaskProperties

将本地SQL Server数据库迁移到 Azure SQL 数据库以便联机迁移的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	MigrateSqlServerSqlDbSyncTaskInput	任务输入
output	MigrateSqlServerSqlDbSyncTaskOutput[]: MigrateSqlServerSqlDbSyncTaskOutputDatabaseError[] MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel[] MigrateSqlServerSqlDbSyncTaskOutputError[] MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel[] MigrateSqlServerSqlDbSyncTaskOutputTableLevel[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: Migrate.SqlServer.AzureSqlDb.Sync	任务类型。

MigrateSqlServerSqlDbTaskInput

将本地SQL Server数据库迁移到 Azure SQL 数据库的任务的输入

名称	类型	说明
encryptedKeyForSecureFields	string	安全字段的加密密钥
selectedDatabases	MigrateSqlServerSqlDbDatabaseInput[]	要迁移的数据库
sourceConnectionInfo	SqlConnectionInfo	有关连接到源的信息
startedOn	string	相对于开始迁移时的 UTC 日期和时间
targetConnectionInfo	SqlConnectionInfo	有关连接到目标的信息
validationOptions	MigrationValidationOptions	用于启用各种迁移后验证的选项。可用选项，1.) 数据完整性检查：在迁移后基于源表和目标表的比较执行校验和，以确保数据的正确性。 2 架构验证：在源表和目标表之间执行彻底的架构比较，并提供源数据库和目标数据库之间的差异列表，3.) 查询分析：执行从查询计划缓存或查询存储自动选取的一组查询并执行它们，并比较源数据库和目标数据库之间的执行时间。

MigrateSqlServerSqlDbTaskOutputDatabaseLevel

名称	类型	说明
databaseName	string	项的名称
endedOn	string	迁移结束时间
errorCount	integer	数据库/对象错误数。
errorPrefix	string	用于查询项的所有错误的通配符字符串前缀
exceptionsAndWarnings	ReportableException[]	迁移异常和警告。
id	string	结果标识符
message	string	迁移进度消息
numberOfObjects	integer	对象数
numberOfObjectsCompleted	integer	成功完成的对象数
objectSummary	<string, DataItemMigrationSummaryResult>	迁移中的对象结果摘要
resultPrefix	string	用于查询项的所有子结果的通配符字符串前缀
resultType	string: DatabaseLevelOutput	结果类型
stage	DatabaseMigrationStage	此数据库处于的迁移阶段
startedOn	string	迁移开始时间
state	MigrationState	迁移的当前状态
statusMessage	string	状态消息

MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult

名称	类型	说明
dataIntegrityValidationResult	DataIntegrityValidationResult	在迁移的源表和目标表之间提供数据完整性验证结果。
endedOn	string	验证结束时间
id	string	结果标识符
migrationId	string	迁移标识符
queryAnalysisValidationResult	QueryAnalysisValidationResult	源数据库和目标数据库之间的某些查询执行结果的结果
resultType	string: MigrationDatabaseLevelValidationOutput	结果类型
schemaValidationResult	SchemaComparisonValidationResult	提供源数据库和目标数据库之间的架构比较结果
sourceDatabaseName	string	源数据库的名称
startedOn	string	验证开始时间
status	ValidationStatus	数据库级别的当前验证状态
targetDatabaseName	string	目标数据库的名称

MigrateSqlServerSqlDbTaskOutputError

名称	类型	说明
error	ReportableException	迁移错误
id	string	异常的唯一标识符
resultType	string: ErrorOutput	结果类型

MigrateSqlServerSqlDbTaskOutputMigrationLevel

名称	类型	说明
databaseSummary	<string, DatabaseSummaryResult>	迁移中的数据库结果摘要
databases	object	所选数据库作为从数据库名称到数据库 ID 的映射
durationInSeconds	integer	任务执行的持续时间（以秒为单位）。
endedOn	string	迁移结束时间
exceptionsAndWarnings	ReportableException[]	迁移异常和警告。
id	string	结果标识符
message	string	迁移进度消息
migrationReportResult	MigrationReportResult	迁移报告结果提供用于下载迁移报告的唯一 URL。
migrationValidationResult	MigrationValidationResult: MigrateSqlServerSqlDbTaskOutputValidationResult	迁移验证结果
resultType	string: MigrationLevelOutput	结果类型
sourceServerBrandVersion	string	源服务器品牌版本
sourceServerVersion	string	源服务器版本
startedOn	string	迁移开始时间
status	MigrationStatus	迁移的当前状态
statusMessage	string	迁移状态消息
targetServerBrandVersion	string	目标服务器品牌版本
targetServerVersion	string	目标服务器版本

MigrateSqlServerSqlDbTaskOutputTableLevel

名称	类型	说明
endedOn	string	迁移结束时间
errorPrefix	string	用于查询项的所有错误的通配符字符串前缀
id	string	结果标识符
itemsCompletedCount	integer	成功完成的项目数
itemsCount	integer	项数
objectName	string	项的名称
resultPrefix	string	用于查询项的所有子结果的通配符字符串前缀
resultType	string: TableLevelOutput	结果类型
startedOn	string	迁移开始时间
state	MigrationState	迁移的当前状态
statusMessage	string	状态消息

MigrateSqlServerSqlDbTaskOutputValidationResult

名称	类型	说明
id	string	结果标识符
migrationId	string	迁移标识符
resultType	string: MigrationValidationOutput	结果类型
status	ValidationStatus	迁移级别的当前验证状态。数据库验证结果状态的状态将在此处聚合。
summaryResults	<string, MigrationValidationDatabaseSummaryResult>	每个数据库的验证摘要结果

MigrateSqlServerSqlDbTaskProperties

将本地SQL Server数据库迁移到 Azure SQL 数据库的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
createdOn	string	创建任务时采用 UTC 格式的 DateTime
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	MigrateSqlServerSqlDbTaskInput	任务输入
isCloneable	boolean	任务是否可以克隆
output	MigrateSqlServerSqlDbTaskOutput[]: MigrateSqlServerSqlDbTaskOutputDatabaseLevel[] MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult[] MigrateSqlServerSqlDbTaskOutputError[] MigrateSqlServerSqlDbTaskOutputMigrationLevel[] MigrateSqlServerSqlDbTaskOutputTableLevel[] MigrateSqlServerSqlDbTaskOutputValidationResult[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskId	string	任务 ID
taskType	string: Migrate.SqlServer.SqlDb	任务类型。

MigrateSqlServerSqlMIDatabaseInput

SQL 用于Azure SQL数据库托管实例迁移任务输入的数据库特定信息

名称	类型	说明
backupFilePaths	string[]	现有备份时要使用的备份文件列表。
backupFileShare	FileShare	用于备份此数据库的备份文件共享信息。
id	string	数据库的 ID
name	string	数据库的名称
restoreDatabaseName	string	目标数据库的名称

MigrateSqlServerSqlMISyncTaskInput

将SQL Server数据库迁移到Azure SQL数据库托管实例联机方案的任务的输入。

名称	类型	说明
azureApp	AzureActiveDirectoryApp	Azure Active Directory 应用程序 DMS (经典) 实例将用于连接到 Azure SQL 数据库托管实例和 Azure 存储帐户的目标实例
backupFileShare	FileShare	备份所有选定数据库的文件共享信息。
numberOfParallelDatabaseMigrations	number	要并行启动的数据库迁移数
selectedDatabases	MigrateSqlServerSqlMIDatabaseInput[]	要迁移的数据库
sourceConnectionInfo	SqlConnectionInfo	源SQL Server的连接信息
storageResourceId	string	存储的完全限定 resourceId
targetConnectionInfo	MiSqlConnectionInfo	Azure SQL 数据库托管实例的连接信息

MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel

名称	类型	说明
activeBackupSets	BackupSetInfo[]	当前处于活动状态的备份集 (正在上传或还原)
containerName	string	在将备份复制到的 Azure 存储帐户中创建的容器的名称
endedOn	string	数据库迁移结束时间
errorPrefix	string	用于查询此数据库的错误的前缀字符串
exceptionsAndWarnings	ReportableException[]	迁移异常和警告
fullBackupSetInfo	BackupSetInfo	完整备份集的详细信息
id	string	结果标识符
isFullBackupRestored	boolean	是否已将完整备份应用于目标数据库
lastRestoredBackupSetInfo	BackupSetInfo	上次应用的备份集信息
migrationState	DatabaseMigrationState	数据库的当前状态
resultType	string: DatabaseLevelOutput	结果类型
sourceDatabaseName	string	数据库的名称
startedOn	string	数据库迁移开始时间

MigrateSqlServerSqlMISyncTaskOutputError

名称	类型	说明
error	ReportableException	迁移错误
id	string	异常的唯一标识符
resultType	string: ErrorOutput	结果类型

MigrateSqlServerSqlMISyncTaskOutputMigrationLevel

名称	类型	说明
databaseCount	integer	数据库计数
databaseErrorCount	integer	数据库级错误数
endedOn	string	迁移结束时间
id	string	结果标识符
resultType	string: MigrationLevelOutput	结果类型
sourceServerBrandVersion	string	源服务器品牌版本
sourceServerName	string	源服务器名称
sourceServerVersion	string	源服务器版本
startedOn	string	迁移开始时间
state	MigrationState	迁移的当前状态
targetServerBrandVersion	string	目标服务器品牌版本
targetServerName	string	目标服务器名称
targetServerVersion	string	目标服务器版本

MigrateSqlServerSqlMISyncTaskProperties

将SQL Server数据库迁移到Azure SQL数据库托管实例同步方案的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
createdOn	string	创建任务时采用 UTC 格式的 DateTime
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	MigrateSqlServerSqlMISyncTaskInput	任务输入
output	MigrateSqlServerSqlMISyncTaskOutput[]: MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel[] MigrateSqlServerSqlMISyncTaskOutputError[] MigrateSqlServerSqlMISyncTaskOutputMigrationLevel[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: Migrate.SqlServer.AzureSqlDbMI.Sync.LRS	任务类型。

MigrateSqlServerSqlMITaskInput

将SQL Server数据库迁移到Azure SQL数据库托管实例的任务的输入。

名称	类型	说明
aadDomainName	string	联合 Azure AD 采用“contoso.com”格式的 Azure Active Directory 域名或托管域的“contoso.onmicrosoft.com”格式，仅当选择了 Windows 登录名时才需要
backupBlobShare	BlobShare	用于存储备份文件的 Azure 存储帐户容器的 SAS URI。
backupFileShare	FileShare	备份所有选定数据库的文件共享信息。
backupMode	BackupMode	备份模式，用于指定是使用现有备份还是创建新备份。如果使用现有备份，则需要在 selectedDatabases 中提供备份文件路径。
encryptedKeyForSecureFields	string	安全字段的加密密钥
selectedAgentJobs	string[]	要迁移的代理作业。
selectedDatabases	MigrateSqlServerSqlMIDatabaseInput[]	要迁移的数据库
selectedLogins	string[]	要迁移的登录名。
sourceConnectionInfo	SqlConnectionInfo	有关连接到源的信息
startedOn	string	相对于开始迁移时的 UTC 日期和时间
targetConnectionInfo	SqlConnectionInfo	有关连接到目标的信息

MigrateSqlServerSqlMITaskOutputAgentJobLevel

名称	类型	说明
endedOn	string	迁移结束时间
exceptionsAndWarnings	ReportableException[]	每个作业的迁移错误和警告
id	string	结果标识符
isEnabled	boolean	原始代理作业的状态。
message	string	迁移进度消息
name	string	代理作业名称。
resultType	string: AgentJobLevelOutput	结果类型
startedOn	string	迁移开始时间
state	MigrationState	迁移的当前状态

MigrateSqlServerSqlMITaskOutputDatabaseLevel

名称	类型	说明
databaseName	string	数据库的名称
endedOn	string	迁移结束时间
exceptionsAndWarnings	ReportableException[]	迁移异常和警告
id	string	结果标识符
message	string	迁移进度消息
resultType	string: DatabaseLevelOutput	结果类型
sizeMB	number	数据库的大小（以 MB 为单位）
stage	DatabaseMigrationStage	迁移的当前阶段
startedOn	string	迁移开始时间
state	MigrationState	迁移的当前状态

MigrateSqlServerSqlMITaskOutputError

名称	类型	说明
error	ReportableException	迁移错误
id	string	异常的唯一标识符
resultType	string: ErrorOutput	结果类型

MigrateSqlServerSqlMITaskOutputLoginLevel

名称	类型	说明
endedOn	string	登录迁移结束时间
exceptionsAndWarnings	ReportableException[]	每个登录名的登录迁移错误和警告
id	string	结果标识符
loginName	string	登录名。
message	string	登录迁移进度消息
resultType	string: LoginLevelOutput	结果类型
stage	LoginMigrationStage	登录的当前阶段
startedOn	string	登录迁移开始时间
state	MigrationState	登录的当前状态

MigrateSqlServerSqlMITaskOutputMigrationLevel

名称	类型	说明
agentJobs	object	所选代理作业作为从名称映射到 ID 的
databases	object	所选数据库作为从数据库名称到数据库 ID 的映射
endedOn	string	迁移结束时间
exceptionsAndWarnings	ReportableException[]	迁移异常和警告。
id	string	结果标识符
logins	object	所选登录名作为从名称映射到 id
message	string	迁移进度消息
orphanedUsersInfo	OrphanedUserInfo[]	孤立用户列表。
resultType	string: MigrationLevelOutput	结果类型
serverRoleResults	<string, StartMigrationScenarioServerRoleResult>	服务器角色迁移结果的映射。
sourceServerBrandVersion	string	源服务器品牌版本
sourceServerVersion	string	源服务器版本
startedOn	string	迁移开始时间
state	MigrationState	迁移的当前状态
status	MigrationStatus	迁移的当前状态
targetServerBrandVersion	string	目标服务器品牌版本
targetServerVersion	string	目标服务器版本

MigrateSqlServerSqlMITaskProperties

将SQL Server数据库迁移到Azure SQL数据库托管实例的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
createdOn	string	创建任务时采用 UTC 格式的 DateTime
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	MigrateSqlServerSqlMITaskInput	任务输入
isCloneable	boolean	任务是否可以克隆
output	MigrateSqlServerSqlMITaskOutput[]: MigrateSqlServerSqlMITaskOutputAgentJobLevel[] MigrateSqlServerSqlMITaskOutputDatabaseLevel[] MigrateSqlServerSqlMITaskOutputError[] MigrateSqlServerSqlMITaskOutputLoginLevel[] MigrateSqlServerSqlMITaskOutputMigrationLevel[]	任务输出。如果提交，则忽略此项。
parentTaskId	string	父任务 ID
state	TaskState	任务的状态。如果提交，则忽略此项。
taskId	string	任务 ID
taskType	string: Migrate.SqlServer.AzureSqlDbMI	任务类型。

MigrateSsisTaskInput

将 SSIS 包从 SQL Server 迁移到 Azure SQL 数据库托管实例的任务的输入。

名称	类型	说明
sourceConnectionInfo	SqlConnectionInfo	有关连接到源的信息
ssisMigrationInfo	SsisMigrationInfo	SSIS 包迁移信息。
targetConnectionInfo	SqlConnectionInfo	有关连接到目标的信息

MigrateSsisTaskOutputMigrationLevel

名称	类型	说明
endedOn	string	迁移结束时间
exceptionsAndWarnings	ReportableException[]	迁移异常和警告。
id	string	结果标识符
message	string	迁移进度消息
resultType	string: MigrationLevelOutput	结果类型
sourceServerBrandVersion	string	源服务器品牌版本
sourceServerVersion	string	源服务器版本
stage	SsisMigrationStage	SSIS 迁移阶段。
startedOn	string	迁移开始时间
status	MigrationStatus	迁移的当前状态
targetServerBrandVersion	string	目标服务器品牌版本
targetServerVersion	string	目标服务器版本

MigrateSsisTaskOutputProjectLevel

名称	类型	说明
endedOn	string	迁移结束时间
exceptionsAndWarnings	ReportableException[]	迁移异常和警告
folderName	string	文件夹的名称
id	string	结果标识符
message	string	迁移进度消息
projectName	string	项目的名称
resultType	string: SsisProjectLevelOutput	结果类型
stage	SsisMigrationStage	SSIS 迁移阶段。
startedOn	string	迁移开始时间
state	MigrationState	迁移的当前状态

MigrateSsisTaskProperties

将 SSIS 包从SQL Server数据库迁移到Azure SQL数据库托管实例的任务的属性。

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	MigrateSsisTaskInput	任务输入
output	MigrateSsisTaskOutput[]: MigrateSsisTaskOutputMigrationLevel[] MigrateSsisTaskOutputProjectLevel[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: Migrate.Ssis	任务类型。

MigrateSyncCompleteCommandInput

用于完成数据库同步迁移的命令的输入。

名称	类型	说明
commitTimeStamp	string	要完成的时间戳
databaseName	string	数据库的名称

MigrateSyncCompleteCommandOutput

完成数据库的同步迁移的命令的输出。

名称	类型	说明
errors	ReportableException[]	命令执行期间发生的错误列表
id	string	结果标识符

MigrateSyncCompleteCommandProperties

完成数据库同步迁移的命令的属性。

名称	类型	说明
commandId	string	命令 ID
commandType	string: Migrate.Sync.Complete.Database	命令类型。
errors	ODataError[]	错误数组。如果已提交，则会忽略这一点。
input	MigrateSyncCompleteCommandInput	命令输入
output	MigrateSyncCompleteCommandOutput	命令输出。如果已提交，则会忽略这一点。
state	CommandState	命令的状态。如果已提交，则会忽略这一点。

MigrationEligibilityInfo

有关服务器对象的迁移资格的信息

名称	类型	说明
isEligibleForMigration	boolean	对象是否有资格迁移。
validationMessages	string[]	有关服务器对象的资格失败的信息。

MigrationReportResult

迁移验证报告结果包含用于下载生成的报表的 URL。

名称	类型	说明
id	string	迁移验证结果标识符
reportUrl	string	报表的 URL。

MigrationState

迁移的当前状态

名称	类型	说明
Completed	string
Failed	string
InProgress	string
None	string
Skipped	string
Stopped	string
Warning	string

MigrationStatus

迁移的当前状态

名称	类型	说明
Completed	string
CompletedWithWarnings	string
Configured	string
Connecting	string
Default	string
Error	string
Running	string
SelectLogins	string
SourceAndTargetSelected	string
Stopped	string

MigrationValidationDatabaseSummaryResult

迁移验证数据库级别摘要结果

名称	类型	说明
endedOn	string	验证结束时间
id	string	结果标识符
migrationId	string	迁移标识符
sourceDatabaseName	string	源数据库的名称
startedOn	string	验证开始时间
status	ValidationStatus	数据库级别的当前验证状态
targetDatabaseName	string	目标数据库的名称

MigrationValidationOptions

迁移后要运行的验证类型

名称	类型	说明
enableDataIntegrityValidation	boolean	允许对所选数据库/表在源和目标之间执行基于校验和的数据完整性验证。
enableQueryAnalysisValidation	boolean	允许通过从源数据库中检索查询并在目标中执行查询来执行快速智能的查询分析。对于提取的查询，结果将包含源数据库和目标数据库中的执行统计信息。
enableSchemaValidation	boolean	允许比较源和目标之间的架构信息。

MigrationValidationResult

迁移验证结果

名称	类型	说明
id	string	迁移验证结果标识符
migrationId	string	迁移标识符
status	ValidationStatus	迁移级别的当前验证状态。数据库验证结果状态的状态将在此处聚合。
summaryResults	<string, MigrationValidationDatabaseSummaryResult>	每个数据库的验证摘要结果

MiSqlConnectionInfo

创建与Azure SQL数据库托管实例的连接所需的属性

名称	类型	说明
managedInstanceResourceId	string	Azure SQL数据库托管实例的资源 ID
password	string	密码凭据。
type	string: MiSqlConnectionInfo	连接信息的类型
userName	string	用户名

MongoDbClusterInfo

描述 MongoDB 数据源

名称	类型	说明
databases	MongoDbDatabaseInfo[]	群集中非系统数据库的列表
supportsSharding	boolean	群集是否支持分片集合
type	MongoDbClusterType	数据源的类型
version	string	格式为 x.y.z 的数据源版本 (例如 3.6.7) 。如果 Type 为 BlobContainer，则不使用。

MongoDbClusterType

数据源的类型

名称	类型	说明
BlobContainer	string
CosmosDb	string
MongoDb	string

MongoDbCollectionInfo

描述 MongoDB 数据库中支持的集合

名称	类型	说明
averageDocumentSize	integer	平均文档大小;如果平均大小未知，则为 -1
dataSize	integer	估计的总数据大小（以字节为单位），如果大小未知，则为 -1。
databaseName	string	包含集合的数据库的名称
documentCount	integer	估计的文档总数;如果文档计数未知，则为 -1
isCapped	boolean	集合是否为带上限的集合 (即它是否具有固定大小并充当圆形缓冲区)
isSystemCollection	boolean	集合是否为系统集合
isView	boolean	集合是否为另一个集合的视图
name	string	数据库或集合的不限定名称
qualifiedName	string	数据库或集合的限定名称。对于集合，这是数据库限定的名称。
shardKey	MongoDbShardKeyInfo	集合上的分片键;如果集合未分片，则为 null
supportsSharding	boolean	数据库是否启用了分片。请注意，如有必要，迁移任务将在目标上启用分片。
viewOf	string	如果 IsView 为 true，则为此视图的集合的名称

MongoDbCollectionProgress

描述集合的进度

名称	类型	说明
bytesCopied	integer	复制阶段复制的文档字节数
documentsCopied	integer	复制阶段复制的文档数
elapsedTime	string	格式为 [ddd.] 的已用时间hh：mm：ss[.fffffff] (即 TimeSpan 格式)
errors	<string, MongoDbError>	针对当前对象发生的错误和警告。键是错误代码。
eventsPending	integer	等待重播的 oplog 事件数
eventsReplayed	integer	到目前为止重播的 oplog 事件数
lastEventTime	string	收到的最后一个 oplog 事件的时间戳;如果尚未收到 oplog 事件，则为 null
lastReplayTime	string	上次重播的 oplog 事件的时间戳;如果尚未重播 oplog 事件，则为 null
name	string	进度对象的名称。对于集合，这是未限定的集合名称。对于数据库，这是数据库名称。对于整体迁移，此值为 null。
qualifiedName	string	进度对象的限定名称。对于集合，这是数据库限定的名称。对于数据库，这是数据库名称。对于整体迁移，此值为 null。
resultType	string: Collection	进度对象的类型
state	MongoDbMigrationState
totalBytes	integer	复制阶段开始时源上的文档字节总数;如果总大小未知，则为 -1
totalDocuments	integer	复制阶段开始时源上的文档总数;如果总计数未知，则为 -1

MongoDbCollectionSettings

描述应如何迁移单个 MongoDB 集合

名称	类型	说明
canDelete	boolean	是否允许迁移程序在执行迁移过程中删除目标集合。默认值为 true。
shardKey	MongoDbShardKeySetting	描述 MongoDB 分片键
targetRUs	integer	应在 CosmosDB 目标上配置的 RU，或 null 以使用默认值。这对非 CosmosDB 目标没有影响。

MongoDbConnectionInfo

描述与 MongoDB 数据源的连接

名称	类型	默认值	说明
additionalSettings	string		其他连接设置
authentication	AuthenticationType		用于连接的身份验证类型
connectionString	string		MongoDB 连接字符串或 Blob 容器 URL。用户名和密码可以在此处指定，也可以在 userName 和 password 属性中指定
dataSource	string		数据源
encryptConnection	boolean		是否加密连接
enforceSSL	boolean
password	string		密码凭据。
port	integer		服务器的端口
serverBrandVersion	string		服务器品牌版本
serverName	string		服务器的名称
serverVersion	string		服务器版本
trustServerCertificate	boolean	False	是否信任服务器证书
type	string		连接信息的类型
userName	string		用户名

MongoDbDatabaseInfo

描述 MongoDB 数据源中的数据库

名称	类型	说明
averageDocumentSize	integer	平均文档大小;如果平均大小未知，则为 -1
collections	MongoDbCollectionInfo[]	MongoDB 数据库中支持的集合列表
dataSize	integer	估计的总数据大小（以字节为单位），如果大小未知，则为 -1。
documentCount	integer	估计的文档总数;如果文档计数未知，则为 -1
name	string	数据库或集合的不限定名称
qualifiedName	string	数据库或集合的限定名称。对于集合，这是数据库限定的名称。
supportsSharding	boolean	数据库是否启用了分片。请注意，如有必要，迁移任务将在目标上启用分片。

MongoDbDatabaseProgress

描述数据库的进度

名称	类型	说明
bytesCopied	integer	复制阶段复制的文档字节数
collections	object	数据库中集合的进度。键是集合的不限定名称
documentsCopied	integer	复制阶段复制的文档数
elapsedTime	string	格式为 [ddd.] 的已用时间hh：mm：ss[.fffffff] (即 TimeSpan 格式)
errors	<string, MongoDbError>	针对当前对象发生的错误和警告。键是错误代码。
eventsPending	integer	等待重播的 oplog 事件数
eventsReplayed	integer	到目前为止重播的 oplog 事件数
lastEventTime	string	收到的最后一个 oplog 事件的时间戳;如果尚未收到 oplog 事件，则为 null
lastReplayTime	string	上次重播的 oplog 事件的时间戳;如果尚未重播 oplog 事件，则为 null
name	string	进度对象的名称。对于集合，这是未限定的集合名称。对于数据库，这是数据库名称。对于整体迁移，此值为 null。
qualifiedName	string	进度对象的限定名称。对于集合，这是数据库限定的名称。对于数据库，这是数据库名称。对于整体迁移，此值为 null。
resultType	string: Database	进度对象的类型
state	MongoDbMigrationState
totalBytes	integer	复制阶段开始时源上的文档字节总数;如果总大小未知，则为 -1
totalDocuments	integer	复制阶段开始时源上的文档总数;如果总计数未知，则为 -1

MongoDbDatabaseSettings

描述应如何迁移单个 MongoDB 数据库

名称	类型	说明
collections	<string, MongoDbCollectionSettings>	要迁移到目标的源数据库上的集合。键是集合的不限定名称。
targetRUs	integer	应在 CosmosDB 目标上配置的 RU，或 null 以使用默认值;如果不应为数据库预配吞吐量，则为 0。这对非 CosmosDB 目标没有影响。

MongoDbError

描述 MongoDB 迁移期间发生的错误或警告

名称	类型	说明
code	string	描述错误或警告的非本地化、计算机可读代码
count	integer	错误或警告发生的次数
message	string	描述错误或警告的本地化的人工可读消息
type	MongoDbErrorType	错误或警告的类型

MongoDbErrorType

错误或警告的类型

名称	类型	说明
Error	string
ValidationError	string
Warning	string

MongoDbMigrationProgress

描述整体迁移的进度

名称	类型	说明
bytesCopied	integer	复制阶段复制的文档字节数
databases	<string, MongoDbDatabaseProgress>	迁移中数据库的进度。键是数据库的名称
documentsCopied	integer	复制阶段复制的文档数
elapsedTime	string	采用 [ddd.] 格式的已用时间hh：mm：ss[.fffffff] (，即 TimeSpan 格式)
errors	<string, MongoDbError>	当前对象发生的错误和警告。键是错误代码。
eventsPending	integer	等待重播的 oplog 事件数
eventsReplayed	integer	到目前为止重播的 oplog 事件数
lastEventTime	string	收到最后一个 oplog 事件的时间戳;如果尚未收到任何 oplog 事件，则为 null
lastReplayTime	string	重播的最后一个 oplog 事件的时间戳;如果尚未重播 oplog 事件，则为 null
name	string	进度对象的名称。对于集合，这是非限定集合名称。对于数据库，这是数据库名称。对于整体迁移，此值为 null。
qualifiedName	string	进度对象的限定名称。对于集合，这是数据库限定的名称。对于数据库，这是数据库名称。对于整体迁移，此值为 null。
resultType	string: Migration	进度对象的类型
state	MongoDbMigrationState
totalBytes	integer	复制阶段开始时源上的文档字节总数;如果总大小未知，则为 -1
totalDocuments	integer	复制阶段开始时源上的文档总数;如果总计数未知，则为 -1

MongoDbMigrationSettings

描述应如何执行 MongoDB 数据迁移

名称	类型	说明
boostRUs	integer	如果在初始迁移期间降低) （从 10,000 到 1,000,000），则集合对 CosmosDB 目标的 RU 限制将暂时增加到 (，或者使用默认提升 (（通常为最大) ）为 0，或为 null 以不提升 RU。此设置对非 CosmosDB 目标没有影响。
databases	<string, MongoDbDatabaseSettings>	要迁移到目标的源群集上的数据库。键是数据库的名称。
replication	MongoDbReplication	描述如何将更改从源复制到目标。默认值为 OneTime。
source	MongoDbConnectionInfo	用于连接到源群集的设置
target	MongoDbConnectionInfo	用于连接到目标群集的设置
throttling	MongoDbThrottlingSettings	用于限制迁移的资源使用情况的设置

MongoDbMigrationState

名称	类型	说明
Canceled	string
Complete	string
Copying	string
Failed	string
Finalizing	string
InitialReplay	string
Initializing	string
NotStarted	string
Replaying	string
Restarting	string
ValidatingInput	string

MongoDbReplication

介绍如何将更改从源复制到目标。默认值为 OneTime。

名称	类型	说明
Continuous	string
Disabled	string
OneTime	string

MongoDbShardKeyField

描述 MongoDB 分片键中的字段引用

名称	类型	说明
name	string	字段的名称
order	MongoDbShardKeyOrder	字段排序

MongoDbShardKeyInfo

描述 MongoDB 分片键

名称	类型	说明
fields	MongoDbShardKeyField[]	分片键中的字段
isUnique	boolean	分片键是否唯一

MongoDbShardKeyOrder

字段排序

名称	类型	说明
Forward	string
Hashed	string
Reverse	string

MongoDbShardKeySetting

描述 MongoDB 分片键

名称	类型	说明
fields	MongoDbShardKeyField[]	分片键中的字段
isUnique	boolean	分片键是否唯一

MongoDbThrottlingSettings

指定迁移的资源限制

名称	类型	说明
maxParallelism	integer	最大工作项数 (例如集合副本) 将并行处理
minFreeCpu	integer	迁移程序将尝试避免使用的 CPU 时间百分比，从 0 到 100
minFreeMemoryMb	integer	迁移程序将尝试避免使用的 RAM 的兆字节数

MySqlConnectionInfo

有关连接到 MySQL 服务器的信息

名称	类型	默认值	说明
additionalSettings	string		其他连接设置
authentication	AuthenticationType		用于连接的身份验证类型
dataSource	string		数据源
encryptConnection	boolean	True	是否加密连接
password	string		密码凭据。
port	integer		服务器的端口
serverName	string		服务器的名称
type	string: MySqlConnectionInfo		连接信息的类型
userName	string		用户名

MySqlTargetPlatformType

迁移的目标平台

名称	类型	说明
AzureDbForMySQL	string
SqlServer	string

ObjectType

具有差异的对象的类型。例如 (Table/View/StoredProcedure)

名称	类型	说明
Function	string
StoredProcedures	string
Table	string
User	string
View	string

ODataError

OData 格式的错误信息。

名称	类型	说明
code	string	错误的计算机可读说明，例如“InvalidRequest”或“InternalServerError”
details	ODataError[]	导致此错误的内部错误
message	string	错误的可读说明

OracleConnectionInfo

有关连接到 Oracle 服务器的信息

名称	类型	说明
authentication	AuthenticationType	用于连接的身份验证类型
dataSource	string	EZConnect 或 TNSName 连接字符串。
password	string	密码凭据。
port	integer	服务器的端口
serverName	string	服务器的名称
serverVersion	string	服务器版本
type	string: OracleConnectionInfo	连接信息的类型
userName	string	用户名

OrphanedUserInfo

SQL Server 数据库中孤立用户的信息。

名称	类型	说明
databaseName	string	用户的父数据库
name	string	孤立用户的名称

PostgreSqlConnectionInfo

有关连接到 PostgreSQL 服务器的信息

名称	类型	默认值	说明
additionalSettings	string		其他连接设置
authentication	AuthenticationType		用于连接的身份验证类型
dataSource	string		数据源
databaseName	string		数据库的名称
encryptConnection	boolean	True	是否加密连接
password	string		密码凭据。
port	integer		服务器的端口
serverBrandVersion	string		服务器品牌版本
serverName	string		服务器的名称
serverVersion	string		服务器版本
trustServerCertificate	boolean	False	是否信任服务器证书
type	string: PostgreSqlConnectionInfo		连接信息的类型
userName	string		用户名

ProjectTask

任务资源

名称	类型	说明
etag	string	HTTP 强实体标记值。如果已提交，则会忽略这一点。
id	string	资源 ID。
name	string	资源名称。
properties	ProjectTaskProperties: ConnectToMongoDbTaskProperties ConnectToSourceMySqlTaskProperties ConnectToSourceOracleSyncTaskProperties ConnectToSourcePostgreSqlSyncTaskProperties ConnectToSourceSqlServerSyncTaskProperties ConnectToSourceSqlServerTaskProperties ConnectToTargetAzureDbForMySqlTaskProperties ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties ConnectToTargetSqlDbTaskProperties ConnectToTargetSqlMISyncTaskProperties ConnectToTargetSqlMITaskProperties ConnectToTargetSqlSqlDbSyncTaskProperties GetTdeCertificatesSqlTaskProperties GetUserTablesMySqlTaskProperties GetUserTablesOracleTaskProperties GetUserTablesPostgreSqlTaskProperties GetUserTablesSqlSyncTaskProperties GetUserTablesSqlTaskProperties MigrateMongoDbTaskProperties MigrateMySqlAzureDbForMySqlOfflineTaskProperties MigrateMySqlAzureDbForMySqlSyncTaskProperties MigrateOracleAzureDbForPostgreSqlSyncTaskProperties MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties MigrateSqlServerSqlDbSyncTaskProperties MigrateSqlServerSqlDbTaskProperties MigrateSqlServerSqlMISyncTaskProperties MigrateSqlServerSqlMITaskProperties MigrateSsisTaskProperties ValidateMigrationInputSqlServerSqlDbSyncTaskProperties ValidateMigrationInputSqlServerSqlMISyncTaskProperties ValidateMigrationInputSqlServerSqlMITaskProperties ValidateMongoDbTaskProperties ValidateOracleAzureDbForPostgreSqlSyncTaskProperties	自定义任务属性
systemData	SystemData	与资源的创建和上次修改相关的元数据。
type	string	资源类型。

QueryAnalysisValidationResult

源和目标之间的查询分析比较结果

名称	类型	说明
queryResults	QueryExecutionResult	源和目标中执行的查询及其执行结果的列表
validationErrors	ValidationError	执行过程中的错误

QueryExecutionResult

介绍源和目标中执行的查询分析结果

名称	类型	说明
queryText	string	从源服务器检索的查询文本
sourceResult	ExecutionStatistics	来自源的查询分析结果
statementsInBatch	integer	总计编号。批处理中的语句的
targetResult	ExecutionStatistics	来自目标的查询分析结果

ReplicateMigrationState

用于复制报告的迁移状态的包装器。

名称	类型	说明
ACTION_REQUIRED	string
COMPLETE	string
FAILED	string
PENDING	string
UNDEFINED	string
VALIDATING	string

ReportableException

所有自定义异常的 Exception 对象

名称	类型	说明
actionableMessage	string	此异常的可操作步骤
filePath	string	发生异常的文件的路径
hResult	integer	分配给特定异常的编码数字值
lineNumber	string	发生异常的行号
message	string	错误消息
stackTrace	string	堆栈跟踪

ScenarioSource

源类型的枚举

名称	类型	说明
Access	string
DB2	string
MongoDB	string
MySQL	string
MySQLRDS	string
Oracle	string
PostgreSQL	string
PostgreSQLRDS	string
SQL	string
SQLRDS	string
Sybase	string

ScenarioTarget

目标类型的枚举

名称	类型	说明
AzureDBForMySql	string
AzureDBForPostgresSQL	string
MongoDB	string
SQLDB	string
SQLDW	string
SQLMI	string
SQLServer	string

SchemaComparisonValidationResult

源和目标之间的架构比较结果

名称	类型	说明
schemaDifferences	SchemaComparisonValidationResultType	源数据库和目标数据库之间的架构差异列表
sourceDatabaseObjectCount	object	源数据库对象的计数
targetDatabaseObjectCount	object	目标数据库对象的计数
validationErrors	ValidationError	执行架构比较验证时发生的错误列表

SchemaComparisonValidationResultType

有关执行迁移验证时发生的错误的说明

名称	类型	说明
objectName	string	具有差异的对象的名称
objectType	ObjectType	具有差异的对象的类型。例如 (Table/View/StoredProcedure)
updateAction	UpdateActionType	针对目标更新操作类型

SelectedCertificateInput

要为已启用 TDE 的数据库导出证书的信息。

名称	类型	说明
certificateName	string	要导出的证书的名称。
password	string	用于加密导出证书的密码。

ServerLevelPermissionsGroup

验证的权限组。这些组将运行一组用于验证用户活动的权限。为正在执行的活动选择权限组。

名称	类型	说明
Default	string
MigrationFromMySQLToAzureDBForMySQL	string
MigrationFromSqlServerToAzureDB	string
MigrationFromSqlServerToAzureMI	string
MigrationFromSqlServerToAzureVM	string

ServerProperties

MySQL 类型源的服务器属性

名称	类型	说明
serverDatabaseCount	integer	服务器中的数据库数
serverEdition	string	数据库服务器的版本
serverName	string	服务器的名称
serverOperatingSystemVersion	string	操作系统的版本
serverPlatform	string	服务器平台的名称
serverVersion	string	数据库服务器的版本

Severity

验证错误的严重性

名称	类型	说明
Error	string
Message	string
Warning	string

SqlConnectionInfo

有关连接到 SQL 数据库服务器的信息

名称	类型	默认值	说明
additionalSettings	string		其他连接设置
authentication	AuthenticationType		用于连接的身份验证类型
dataSource	string		格式为 Protocol：MachineName\SQLServerInstanceName，PortNumber 的数据源
encryptConnection	boolean	True	是否加密连接
password	string		密码凭据。
platform	SqlSourcePlatform		用于连接的服务器平台类型
port	integer		服务器的端口
resourceId	string		表示由 Azure 资源提供程序表示的 HTTP 资源的 ID。
serverBrandVersion	string		服务器品牌版本
serverName	string		服务器的名称
serverVersion	string		服务器版本
trustServerCertificate	boolean	False	是否信任服务器证书
type	string: SqlConnectionInfo		连接信息的类型
userName	string		用户名

SqlSourcePlatform

用于连接的服务器平台类型

名称	类型	说明
SqlOnPrem	string

SsisMigrationInfo

SSIS 存储类型的 SSIS 迁移信息，覆盖策略。

名称	类型	说明
environmentOverwriteOption	SsisMigrationOverwriteOption	SSIS 环境迁移的覆盖选项
projectOverwriteOption	SsisMigrationOverwriteOption	SSIS 项目迁移的覆盖选项
ssisStoreType	SsisStoreType	源的 SSIS 存储类型，目前在 DMS 中仅支持 SSIS 目录 (经典)

SsisMigrationOverwriteOption

SSIS 对象迁移的覆盖选项，在 DMS 中仅支持忽略和覆盖 (经典) 现在和将来可能会为容器对象添加重用选项

名称	类型	说明
Ignore	string
Overwrite	string

SsisMigrationStage

SSIS 迁移的当前阶段

名称	类型	说明
Completed	string
InProgress	string
Initialize	string
None	string

SsisStoreType

DMS 中支持的源 SSIS 存储类型的枚举 (经典)

名称	类型	说明
SsisCatalog	string

StartMigrationScenarioServerRoleResult

服务器角色迁移结果

名称	类型	说明
exceptionsAndWarnings	ReportableException[]	迁移异常和警告。
name	string	服务器角色的名称。
state	MigrationState	迁移的当前状态

SyncDatabaseMigrationReportingState

数据库级别联机迁移的不同状态的枚举。

名称	类型	说明
BACKUP_COMPLETED	string
BACKUP_IN_PROGRESS	string
CANCELLED	string
CANCELLING	string
COMPLETE	string
COMPLETING	string
CONFIGURING	string
FAILED	string
INITIALIAZING	string
READY_TO_COMPLETE	string
RESTORE_COMPLETED	string
RESTORE_IN_PROGRESS	string
RUNNING	string
STARTING	string
UNDEFINED	string
VALIDATING	string
VALIDATION_COMPLETE	string
VALIDATION_FAILED	string

SyncMigrationDatabaseErrorEvent

联机迁移的数据库迁移错误

名称	类型	说明
eventText	string	事件文本。
eventTypeString	string	事件类型。
timestampString	string	timestamp 的字符串值。

SyncTableMigrationState

表级别联机迁移的不同状态的枚举。

名称	类型	说明
BEFORE_LOAD	string
CANCELED	string
COMPLETED	string
ERROR	string
FAILED	string
FULL_LOAD	string

SystemData

名称	类型	说明
createdAt	string
createdBy	string
createdByType	createdByType
lastModifiedAt	string
lastModifiedBy	string
lastModifiedByType	createdByType

TaskState

任务的状态。如果提交，则忽略此项。

名称	类型	说明
Canceled	string
Failed	string
FailedInputValidation	string
Faulted	string
Queued	string
Running	string
Succeeded	string
Unknown	string

UpdateActionType

比较对象的实际差异的类型，同时执行架构比较

名称	类型	说明
AddedOnTarget	string
ChangedOnTarget	string
DeletedOnTarget	string

ValidateMigrationInputSqlServerSqlDbSyncTaskProperties

验证 SQL 到Azure SQL数据库同步迁移的迁移输入的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	ValidateSyncMigrationInputSqlServerTaskInput	任务输入
output	ValidateSyncMigrationInputSqlServerTaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: ValidateMigrationInput.SqlServer.SqlDb.Sync	任务类型。

ValidateMigrationInputSqlServerSqlMISyncTaskInput

将SQL Server数据库迁移到Azure SQL数据库托管实例联机方案的任务的输入。

名称	类型	说明
azureApp	AzureActiveDirectoryApp	Azure Active Directory 应用程序 DMS (经典) 实例将用于连接到 Azure SQL 数据库托管实例和 Azure 存储帐户的目标实例
backupFileShare	FileShare	备份所有选定数据库的文件共享信息。
selectedDatabases	MigrateSqlServerSqlMIDatabaseInput[]	要迁移的数据库
sourceConnectionInfo	SqlConnectionInfo	源SQL Server的连接信息
storageResourceId	string	存储的完全限定 resourceId
targetConnectionInfo	MiSqlConnectionInfo	Azure SQL 数据库托管实例的连接信息

ValidateMigrationInputSqlServerSqlMISyncTaskOutput

验证 Azure SQL 数据库托管实例联机迁移的迁移输入的任务的输出

名称	类型	说明
id	string	数据库标识符
name	string	数据库的名称
validationErrors	ReportableException[]	与所选数据库对象关联的错误

ValidateMigrationInputSqlServerSqlMISyncTaskProperties

验证 SQL 到Azure SQL数据库托管实例同步方案的迁移输入的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	ValidateMigrationInputSqlServerSqlMISyncTaskInput	任务输入
output	ValidateMigrationInputSqlServerSqlMISyncTaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS	任务类型。

ValidateMigrationInputSqlServerSqlMITaskInput

验证 SQL 到Azure SQL 托管实例迁移输入的任务的输入

名称	类型	说明
backupBlobShare	BlobShare	用于存储备份文件的 Azure 存储帐户容器的 SAS URI。
backupFileShare	FileShare	备份所有选定数据库的文件共享信息。
backupMode	BackupMode	备份模式，用于指定是使用现有备份还是创建新备份。
selectedDatabases	MigrateSqlServerSqlMIDatabaseInput[]	要迁移的数据库
selectedLogins	string[]	要迁移的登录名
sourceConnectionInfo	SqlConnectionInfo	有关连接到源的信息
targetConnectionInfo	SqlConnectionInfo	有关连接到目标的信息

ValidateMigrationInputSqlServerSqlMITaskOutput

验证 SQL 到Azure SQL 托管实例迁移的迁移输入的任务的输出

名称	类型	说明
backupFolderErrors	ReportableException[]	与 BackupFolder 路径关联的错误
backupShareCredentialsErrors	ReportableException[]	与备份共享用户名和密码凭据关联的错误
backupStorageAccountErrors	ReportableException[]	与提供的存储帐户关联的错误。
databaseBackupInfo	DatabaseBackupInfo	有关使用现有备份模式时的备份文件的信息。
existingBackupErrors	ReportableException[]	与现有备份文件关联的错误。
id	string	结果标识符
name	string	数据库的名称
restoreDatabaseNameErrors	ReportableException[]	与 RestoreDatabaseName 关联的错误

ValidateMigrationInputSqlServerSqlMITaskProperties

验证 SQL 到数据库Azure SQL迁移输入的任务的属性托管实例

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	ValidateMigrationInputSqlServerSqlMITaskInput	任务输入
output	ValidateMigrationInputSqlServerSqlMITaskOutput[]	任务输出。如果提交，则忽略此项。
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: ValidateMigrationInput.SqlServer.AzureSqlDbMI	任务类型。

ValidateMongoDbTaskProperties

验证 MongoDB 数据源之间迁移的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	MongoDbMigrationSettings	描述应如何执行 MongoDB 数据迁移
output	MongoDbMigrationProgress[]	包含单个 MongoDbMigrationProgress 对象的数组
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: Validate.MongoDb	任务类型。

ValidateOracleAzureDbForPostgreSqlSyncTaskProperties

验证 Oracle 到联机迁移Azure Database for PostgreSQL迁移的任务的属性

名称	类型	说明
clientData	object	用于将元数据信息附加到任务的客户端数据的键值对
commands	CommandProperties[]: MigrateMISyncCompleteCommandProperties[] MigrateSyncCompleteCommandProperties[]	命令属性数组。
errors	ODataError[]	错误数组。如果提交，则忽略此项。
input	MigrateOracleAzureDbPostgreSqlSyncTaskInput	将 Oracle 数据库迁移到联机迁移Azure Database for PostgreSQL的任务的输入
output	ValidateOracleAzureDbPostgreSqlSyncTaskOutput[]	包含单个验证错误响应对象的数组
state	TaskState	任务的状态。如果提交，则忽略此项。
taskType	string: Validate.Oracle.AzureDbPostgreSql.Sync	任务类型。

ValidateOracleAzureDbPostgreSqlSyncTaskOutput

验证 Oracle 到联机迁移Azure Database for PostgreSQL的迁移输入的任务的输出

名称	类型	说明
validationErrors	ReportableException[]	与所选数据库对象关联的错误

ValidateSyncMigrationInputSqlServerTaskInput

验证 SQL 同步迁移的迁移输入的任务的输入

名称	类型	说明
selectedDatabases	MigrateSqlServerSqlDbSyncDatabaseInput[]	要迁移的数据库
sourceConnectionInfo	SqlConnectionInfo	有关连接到源 SQL Server 的信息
targetConnectionInfo	SqlConnectionInfo	有关连接到目标的信息

ValidateSyncMigrationInputSqlServerTaskOutput

验证 SQL 同步迁移的迁移输入的任务的输出

名称	类型	说明
id	string	数据库标识符
name	string	数据库的名称
validationErrors	ReportableException[]	与所选数据库对象关联的错误

ValidationError

有关执行迁移验证时发生的错误的说明

名称	类型	说明
severity	Severity	错误的严重性
text	string	错误文本

ValidationStatus

验证的当前状态

名称	类型	说明
Completed	string
CompletedWithIssues	string
Default	string
Failed	string
InProgress	string
Initialized	string
NotStarted	string
Stopped	string

WaitStatistics

查询批处理执行期间收集的等待统计信息

名称	类型	默认值	说明
waitCount	integer		总计编号。等待数
waitTimeMs	number	0	总等待时间（以毫秒 (秒) 为单位）
waitType	string		等待的类型

Share via

Tasks - Get

URI 参数

响应

安全性

azure_auth

Scopes

示例

Tasks_Get

Sample Request

Sample Response

定义

ApiError

AuthenticationType

AzureActiveDirectoryApp

BackupFileInfo

BackupFileStatus

BackupMode

BackupSetInfo

BackupType

BlobShare

CommandState

ConnectToMongoDbTaskProperties

ConnectToSourceMySqlTaskInput

ConnectToSourceMySqlTaskProperties

ConnectToSourceNonSqlTaskOutput

ConnectToSourceOracleSyncTaskInput

ConnectToSourceOracleSyncTaskOutput

ConnectToSourceOracleSyncTaskProperties

ConnectToSourcePostgreSqlSyncTaskInput

ConnectToSourcePostgreSqlSyncTaskOutput

ConnectToSourcePostgreSqlSyncTaskProperties

ConnectToSourceSqlServerSyncTaskProperties

ConnectToSourceSqlServerTaskInput

ConnectToSourceSqlServerTaskOutputAgentJobLevel

ConnectToSourceSqlServerTaskOutputDatabaseLevel

ConnectToSourceSqlServerTaskOutputLoginLevel

ConnectToSourceSqlServerTaskOutputTaskLevel

ConnectToSourceSqlServerTaskProperties

ConnectToTargetAzureDbForMySqlTaskInput

ConnectToTargetAzureDbForMySqlTaskOutput

ConnectToTargetAzureDbForMySqlTaskProperties

ConnectToTargetAzureDbForPostgreSqlSyncTaskInput

ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput

ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput

ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties

ConnectToTargetSqlDbTaskInput

ConnectToTargetSqlDbTaskOutput

ConnectToTargetSqlDbTaskProperties

ConnectToTargetSqlMISyncTaskInput

ConnectToTargetSqlMISyncTaskOutput

ConnectToTargetSqlMISyncTaskProperties

ConnectToTargetSqlMITaskInput

ConnectToTargetSqlMITaskOutput

ConnectToTargetSqlMITaskProperties

ConnectToTargetSqlSqlDbSyncTaskInput

ConnectToTargetSqlSqlDbSyncTaskProperties

createdByType

DatabaseBackupInfo

DatabaseCompatLevel

DatabaseFileInfo

DatabaseFileType

DatabaseMigrationStage

DatabaseMigrationState

DatabaseSchemaMap

DatabaseState

DatabaseSummaryResult

DatabaseTable

DataIntegrityValidationResult

DataItemMigrationSummaryResult

ExecutionStatistics

FileShare

GetTdeCertificatesSqlTaskInput

GetTdeCertificatesSqlTaskOutput

GetTdeCertificatesSqlTaskProperties

GetUserTablesMySqlTaskInput

GetUserTablesMySqlTaskOutput

GetUserTablesMySqlTaskProperties