Migrations - Update

服务:

PostgreSQL

API 版本:

2025-08-01

更新现有迁移。 请求正文可以包含迁移定义中存在的一对多可变属性。 某些属性更新启动迁移状态转换。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/migrations/{migrationName}?api-version=2025-08-01

URI 参数

名称	在	必需	类型	说明
migrationName	path	True	string pattern: ^[a-z][a-z0-9]*$	迁移名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	服务器的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

请求正文

名称	类型	说明
properties.cancel	Cancel	指示是否必须为整个迁移触发 cancel。
properties.dbsToCancelMigrationOn	string[]	如果要为特定数据库触发 cancel，请将 'triggerCutover' 设置为 'True' 并设置此数组中特定数据库的名称。
properties.dbsToMigrate	string[]	要迁移的数据库的名称。
properties.dbsToTriggerCutoverOn	string[]	如果要触发特定数据库的直接转换，请将 'triggerCutover' 设置为 'True' 并设置此数组中特定数据库的名称。
properties.migrateRoles	MigrateRolesAndPermissions	指示是否必须迁移角色和权限。
properties.migrationMode	MigrationMode	用于执行迁移的模式：联机或脱机。
properties.migrationWindowStartTimeInUtc	string (date-time)	迁移时段的开始时间 （UTC）。
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	指示目标服务器上的数据库在已存在时是否可以被覆盖。 如果设置为 'False'，则当迁移工作流检测到目标服务器上已存在数据库时，它将等待确认。
properties.secretParameters	MigrationSecretParametersForPatch	迁移机密参数。
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	指示是否在源服务器上设置逻辑复制（如果需要）。
properties.sourceDbServerFullyQualifiedDomainName	string	源服务器的完全限定域名 （FQDN） 或 IP 地址。 此属性是可选的。 如果提供，迁移服务将始终使用它来连接到源服务器。
properties.sourceDbServerResourceId	string	当 'sourceType' 为 'PostgreSQLSingleServer' 时，源数据库服务器资源的标识符。 对于其他源类型，必须将其设置为 ipaddress：port@username 或 hostname：port@username。
properties.startDataMigration	StartDataMigration	指示是否必须立即开始数据迁移。
properties.targetDbServerFullyQualifiedDomainName	string	目标服务器的完全限定域名 （FQDN） 或 IP 地址。 此属性是可选的。 提供后，迁移服务将始终使用它来连接到目标服务器。
properties.triggerCutover	TriggerCutover	指示是否必须为整个迁移触发直接转换。
tags	object	键值对形式的应用程序特定元数据。

响应

名称	类型	说明
200 OK	Migration	Azure作已成功完成。
Other Status Codes	ErrorResponse	意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Update an existing migration.

示例请求

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/migrations/examplemigration?api-version=2025-08-01

{
  "properties": {
    "setupLogicalReplicationOnSourceDbIfNeeded": "True"
  }
}

Java

import com.azure.resourcemanager.postgresqlflexibleserver.models.LogicalReplicationOnSourceServer;
import com.azure.resourcemanager.postgresqlflexibleserver.models.Migration;

/**
 * Samples for Migrations Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/MigrationsUpdate.
     * json
     */
    /**
     * Sample code: Update an existing migration.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void
        updateAnExistingMigration(com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        Migration resource = manager.migrations().getWithResponse("exampleresourcegroup", "exampleserver",
            "examplemigration", com.azure.core.util.Context.NONE).getValue();
        resource.update().withSetupLogicalReplicationOnSourceDbIfNeeded(LogicalReplicationOnSourceServer.TRUE).apply();
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python migrations_update.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 = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.migrations.update(
        resource_group_name="exampleresourcegroup",
        server_name="exampleserver",
        migration_name="examplemigration",
        parameters={"properties": {"setupLogicalReplicationOnSourceDbIfNeeded": "True"}},
    )
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/MigrationsUpdate.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

Go

package armpostgresqlflexibleservers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresqlflexibleservers/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e96c24570a484cff13d153fb472f812878866a39/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/MigrationsUpdate.json
func ExampleMigrationsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMigrationsClient().Update(ctx, "exampleresourcegroup", "exampleserver", "examplemigration", armpostgresqlflexibleservers.MigrationResourceForPatch{
		Properties: &armpostgresqlflexibleservers.MigrationPropertiesForPatch{
			SetupLogicalReplicationOnSourceDbIfNeeded: to.Ptr(armpostgresqlflexibleservers.LogicalReplicationOnSourceServerTrue),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Migration = armpostgresqlflexibleservers.Migration{
	// 	Name: to.Ptr("examplemigration"),
	// 	Type: to.Ptr("Microsoft.DBForPostgreSql/flexibleServers/migrations"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBForPostgreSql/flexibleServers/exampletarget/migrations/examplemigration"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armpostgresqlflexibleservers.MigrationProperties{
	// 		CurrentStatus: &armpostgresqlflexibleservers.MigrationStatus{
	// 			CurrentSubStateDetails: &armpostgresqlflexibleservers.MigrationSubstateDetails{
	// 				CurrentSubState: to.Ptr(armpostgresqlflexibleservers.MigrationSubstatePerformingPreRequisiteSteps),
	// 			},
	// 			Error: to.Ptr(""),
	// 			State: to.Ptr(armpostgresqlflexibleservers.MigrationStateInProgress),
	// 		},
	// 		DbsToMigrate: []*string{
	// 			to.Ptr("exampledatabase1"),
	// 			to.Ptr("exampledatabase2"),
	// 			to.Ptr("exampledatabase3"),
	// 			to.Ptr("exampledatabase4")},
	// 			MigrateRoles: to.Ptr(armpostgresqlflexibleservers.MigrateRolesAndPermissionsFalse),
	// 			MigrationID: to.Ptr("d3ceacbb-a5fd-43dc-a9db-6022b5154856"),
	// 			MigrationWindowStartTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-06-01T20:30:22.123Z"); return t}()),
	// 			OverwriteDbsInTarget: to.Ptr(armpostgresqlflexibleservers.OverwriteDatabasesOnTargetServerFalse),
	// 			SetupLogicalReplicationOnSourceDbIfNeeded: to.Ptr(armpostgresqlflexibleservers.LogicalReplicationOnSourceServerTrue),
	// 			SourceDbServerMetadata: &armpostgresqlflexibleservers.DbServerMetadata{
	// 				Location: to.Ptr("eastus"),
	// 				SKU: &armpostgresqlflexibleservers.ServerSKU{
	// 					Name: to.Ptr("B_Gen5_2"),
	// 					Tier: to.Ptr(armpostgresqlflexibleservers.SKUTier("Basic")),
	// 				},
	// 				StorageMb: to.Ptr[int32](1024),
	// 				Version: to.Ptr("10"),
	// 			},
	// 			SourceDbServerResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBForPostgreSql/servers/examplesource"),
	// 			StartDataMigration: to.Ptr(armpostgresqlflexibleservers.StartDataMigrationFalse),
	// 			TargetDbServerMetadata: &armpostgresqlflexibleservers.DbServerMetadata{
	// 				Location: to.Ptr("eastus"),
	// 				SKU: &armpostgresqlflexibleservers.ServerSKU{
	// 					Name: to.Ptr("Standard_D4ds_v5"),
	// 					Tier: to.Ptr(armpostgresqlflexibleservers.SKUTierGeneralPurpose),
	// 				},
	// 				StorageMb: to.Ptr[int32](2048),
	// 				Version: to.Ptr("17"),
	// 			},
	// 			TargetDbServerResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBForPostgreSql/flexibleServers/exampletarget"),
	// 			TriggerCutover: to.Ptr(armpostgresqlflexibleservers.TriggerCutoverFalse),
	// 		},
	// 	}
}

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

JavaScript

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Updates an existing migration. The request body can contain one to many of the mutable properties present in the migration definition. Certain property updates initiate migration state transitions.
 *
 * @summary Updates an existing migration. The request body can contain one to many of the mutable properties present in the migration definition. Certain property updates initiate migration state transitions.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/MigrationsUpdate.json
 */
async function updateAnExistingMigration() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "exampleresourcegroup";
  const serverName = "exampleserver";
  const migrationName = "examplemigration";
  const parameters = {
    setupLogicalReplicationOnSourceDbIfNeeded: "True",
  };
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.migrations.update(
    resourceGroupName,
    serverName,
    migrationName,
    parameters,
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.PostgreSql.FlexibleServers.Models;
using Azure.ResourceManager.PostgreSql.FlexibleServers;

// Generated from example definition: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/MigrationsUpdate.json
// this example is just showing the usage of "Migrations_Update" 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 PostgreSqlMigrationResource created on azure
// for more information of creating PostgreSqlMigrationResource, please refer to the document of PostgreSqlMigrationResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "exampleresourcegroup";
string serverName = "exampleserver";
string migrationName = "examplemigration";
ResourceIdentifier postgreSqlMigrationResourceId = PostgreSqlMigrationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, migrationName);
PostgreSqlMigrationResource postgreSqlMigration = client.GetPostgreSqlMigrationResource(postgreSqlMigrationResourceId);

// invoke the operation
PostgreSqlMigrationPatch patch = new PostgreSqlMigrationPatch
{
    SetupLogicalReplicationOnSourceDbIfNeeded = PostgreSqlMigrationLogicalReplicationOnSourceDb.True,
};
PostgreSqlMigrationResource result = await postgreSqlMigration.UpdateAsync(patch);

// 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
PostgreSqlMigrationData 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

示例响应

状态代码:

200

{
  "name": "examplemigration",
  "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBForPostgreSql/flexibleServers/exampletarget/migrations/examplemigration",
  "location": "eastus",
  "properties": {
    "currentStatus": {
      "currentSubStateDetails": {
        "currentSubState": "PerformingPreRequisiteSteps"
      },
      "error": "",
      "state": "InProgress"
    },
    "dbsToMigrate": [
      "exampledatabase1",
      "exampledatabase2",
      "exampledatabase3",
      "exampledatabase4"
    ],
    "migrateRoles": "False",
    "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856",
    "migrationWindowStartTimeInUtc": "2025-06-01T20:30:22.123456Z",
    "overwriteDbsInTarget": "False",
    "setupLogicalReplicationOnSourceDbIfNeeded": "True",
    "sourceDbServerMetadata": {
      "location": "eastus",
      "sku": {
        "name": "B_Gen5_2",
        "tier": "Basic"
      },
      "storageMb": 1024,
      "version": "10"
    },
    "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBForPostgreSql/servers/examplesource",
    "startDataMigration": "False",
    "targetDbServerMetadata": {
      "location": "eastus",
      "sku": {
        "name": "Standard_D4ds_v5",
        "tier": "GeneralPurpose"
      },
      "storageMb": 2048,
      "version": "17"
    },
    "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBForPostgreSql/flexibleServers/exampletarget",
    "triggerCutover": "False"
  }
}

定义

名称	说明
AdminCredentials	源服务器和目标服务器的管理员用户的凭据。
AdminCredentialsForPatch	源服务器和目标服务器的管理员用户的凭据。
Cancel	指示是否必须为整个迁移触发 cancel。
createdByType	创建资源的标识的类型。
DatabaseMigrationState	数据库的迁移状态。
DbLevelValidationStatus	数据库的验证状态摘要。
DbServerMetadata	数据库服务器元数据。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
LogicalReplicationOnSourceServer	指示是否在源服务器上设置逻辑复制（如果需要）。
MigrateRolesAndPermissions	指示是否必须迁移角色和权限。
Migration	迁移的属性。
MigrationDatabaseState	数据库的迁移状态。
MigrationMode	用于执行迁移的模式：联机或脱机。
MigrationOption	迁移支持的选项
MigrationResourceForPatch	Migration.
MigrationSecretParameters	迁移机密参数。
MigrationSecretParametersForPatch	迁移机密参数。
MigrationState	迁移状态。
MigrationStatus	迁移状态。
MigrationSubstate	迁移的子状态。
MigrationSubstateDetails	迁移子状态的详细信息。
OverwriteDatabasesOnTargetServer	指示目标服务器上的数据库在已存在时是否可以被覆盖。 如果设置为 'False'，则当迁移工作流检测到目标服务器上已存在数据库时，它将等待确认。
ServerSku	计算服务器的信息。
SkuTier	分配给服务器的计算层。
SourceType	用于迁移的源服务器类型：ApsaraDB_RDS、AWS、AWS_AURORA、AWS_EC2、AWS_RDS、AzureVM、Crunchy_PostgreSQL、Digital_Ocean_Droplets、Digital_Ocean_PostgreSQL、EDB、EDB_Oracle_Server、EDB_PostgreSQL、GCP、GCP_AlloyDB、GCP_CloudSQL、GCP_Compute、Heroku_PostgreSQL、Huawei_Compute、Huawei_RDS、OnPremises、PostgreSQLCosmosDB、PostgreSQLFlexibleServer、PostgreSQLSingleServer 或 Supabase_PostgreSQL
SslMode	迁移使用的 SSL 模式。 “PostgreSQLSingleServer”的默认 SSL 模式为“VerifyFull”。 其他源类型的默认 SSL 模式为 'Prefer'。
StartDataMigration	指示是否必须立即开始数据迁移。
systemData	与创建和上次修改资源相关的元数据。
TriggerCutover	指示是否必须为整个迁移触发直接转换。
ValidationDetails	迁移验证的详细信息。
ValidationMessage	验证消息对象。
ValidationState	迁移的验证状态。
ValidationSummaryItem	验证摘要对象。

AdminCredentials

对象

源服务器和目标服务器的管理员用户的凭据。

名称	类型	说明
sourceServerPassword	string (password)	源服务器用户的密码。
targetServerPassword	string (password)	目标服务器用户的密码。

AdminCredentialsForPatch

对象

源服务器和目标服务器的管理员用户的凭据。

名称	类型	说明
sourceServerPassword	string (password)	源服务器用户的密码。
targetServerPassword	string (password)	目标服务器用户的密码。

Cancel

枚举

指示是否必须为整个迁移触发 cancel。

值	说明
True
False

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DatabaseMigrationState

对象

数据库的迁移状态。

名称	类型	说明
appliedChanges	integer (int32)	Change Data Capture applied changes 计数器。
cdcDeleteCounter	integer (int32)	更改 Data Capture 删除计数器。
cdcInsertCounter	integer (int32)	更改 Data Capture 插入计数器。
cdcUpdateCounter	integer (int32)	更改 Data Capture 更新计数器。
databaseName	string	数据库的名称。
endedOn	string (date-time)	迁移状态的结束时间。
fullLoadCompletedTables	integer (int32)	数据库迁移期间加载的表数。
fullLoadErroredTables	integer (int32)	在数据库迁移过程中遇到错误的表数。
fullLoadLoadingTables	integer (int32)	数据库迁移期间加载的表数。
fullLoadQueuedTables	integer (int32)	排队等待数据库迁移的表数。
incomingChanges	integer (int32)	Change Data Capture 传入更改计数器。
latency	integer (int32)	联机阶段源和目标之间的滞后（以秒为单位）。
message	string	迁移状态的错误消息（如果有）。
migrationOperation	string	数据库的迁移作。
migrationState	MigrationDatabaseState	数据库的迁移状态。
startedOn	string (date-time)	迁移状态的开始时间。

DbLevelValidationStatus

对象

数据库的验证状态摘要。

名称	类型	说明
databaseName	string	数据库的名称。
endedOn	string (date-time)	数据库级别验证的结束时间。
startedOn	string (date-time)	数据库级别验证的开始时间。
summary	ValidationSummaryItem[]	数据库级别验证摘要。

DbServerMetadata

对象

数据库服务器元数据。

名称	类型	说明
location	string	数据库服务器的位置。
sku	ServerSku	数据库服务器的计算层和大小。 对于 Azure Database for PostgreSQL 单一服务器，此对象为空。
storageMb	integer (int32)	数据库服务器的存储大小（以 MB 为单位）。
version	string	PostgreSQL 数据库引擎的主要版本。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

LogicalReplicationOnSourceServer

枚举

指示是否在源服务器上设置逻辑复制（如果需要）。

值	说明
True
False

MigrateRolesAndPermissions

枚举

指示是否必须迁移角色和权限。

值	说明
True
False

Migration

对象

迁移的属性。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	资源所在的地理位置
name	string	资源的名称
properties.cancel	Cancel	指示是否必须为整个迁移触发 cancel。
properties.currentStatus	MigrationStatus	迁移的当前状态。
properties.dbsToCancelMigrationOn	string[]	如果要为特定数据库触发 cancel，请将 'triggerCutover' 设置为 'True' 并设置此数组中特定数据库的名称。
properties.dbsToMigrate	string[]	要迁移的数据库的名称。
properties.dbsToTriggerCutoverOn	string[]	如果要触发特定数据库的直接转换，请将 'triggerCutover' 设置为 'True' 并设置此数组中特定数据库的名称。
properties.migrateRoles	MigrateRolesAndPermissions	指示是否必须迁移角色和权限。
properties.migrationId	string	迁移的标识符。
properties.migrationInstanceResourceId	string (arm-id)	私有终端节点迁移实例的标识符。
properties.migrationMode	MigrationMode	用于执行迁移的模式：联机或脱机。
properties.migrationOption	MigrationOption	迁移的支持选项。
properties.migrationWindowEndTimeInUtc	string (date-time)	迁移时段的结束时间 （UTC）。
properties.migrationWindowStartTimeInUtc	string (date-time)	迁移时段的开始时间 （UTC）。
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	指示目标服务器上的数据库在已存在时是否可以被覆盖。 如果设置为 'False'，则当迁移工作流检测到目标服务器上已存在数据库时，它将等待确认。
properties.secretParameters	MigrationSecretParameters	迁移机密参数。
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	指示是否在源服务器上设置逻辑复制（如果需要）。
properties.sourceDbServerFullyQualifiedDomainName	string	源服务器的完全限定域名 （FQDN） 或 IP 地址。 此属性是可选的。 如果提供，迁移服务将始终使用它来连接到源服务器。
properties.sourceDbServerMetadata	DbServerMetadata	源数据库服务器的元数据。
properties.sourceDbServerResourceId	string	当 'sourceType' 为 'PostgreSQLSingleServer' 时，源数据库服务器资源的标识符。 对于其他源类型，必须将其设置为 ipaddress：port@username 或 hostname：port@username。
properties.sourceType	SourceType	用于迁移的源服务器类型：ApsaraDB_RDS、AWS、AWS_AURORA、AWS_EC2、AWS_RDS、AzureVM、Crunchy_PostgreSQL、Digital_Ocean_Droplets、Digital_Ocean_PostgreSQL、EDB、EDB_Oracle_Server、EDB_PostgreSQL、GCP、GCP_AlloyDB、GCP_CloudSQL、GCP_Compute、Heroku_PostgreSQL、Huawei_Compute、Huawei_RDS、OnPremises、PostgreSQLCosmosDB、PostgreSQLFlexibleServer、PostgreSQLSingleServer 或 Supabase_PostgreSQL
properties.sslMode	SslMode	迁移使用的 SSL 模式。 “PostgreSQLSingleServer”的默认 SSL 模式为“VerifyFull”。 其他源类型的默认 SSL 模式为 'Prefer'。
properties.startDataMigration	StartDataMigration	指示是否必须立即开始数据迁移。
properties.targetDbServerFullyQualifiedDomainName	string	目标服务器的完全限定域名 （FQDN） 或 IP 地址。 此属性是可选的。 提供后，迁移服务将始终使用它来连接到目标服务器。
properties.targetDbServerMetadata	DbServerMetadata	目标数据库服务器的元数据。
properties.targetDbServerResourceId	string	目标数据库服务器资源的标识符。
properties.triggerCutover	TriggerCutover	指示是否必须为整个迁移触发直接转换。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

MigrationDatabaseState

枚举

数据库的迁移状态。

值	说明
InProgress
WaitingForCutoverTrigger
Failed
Canceled
Succeeded
Canceling

MigrationMode

枚举

用于执行迁移的模式：联机或脱机。

值	说明
Offline
Online

MigrationOption

枚举

迁移支持的选项

值	说明
Validate
Migrate
ValidateAndMigrate

MigrationResourceForPatch

对象

Migration.

名称	类型	说明
properties.cancel	Cancel	指示是否必须为整个迁移触发 cancel。
properties.dbsToCancelMigrationOn	string[]	如果要为特定数据库触发 cancel，请将 'triggerCutover' 设置为 'True' 并设置此数组中特定数据库的名称。
properties.dbsToMigrate	string[]	要迁移的数据库的名称。
properties.dbsToTriggerCutoverOn	string[]	如果要触发特定数据库的直接转换，请将 'triggerCutover' 设置为 'True' 并设置此数组中特定数据库的名称。
properties.migrateRoles	MigrateRolesAndPermissions	指示是否必须迁移角色和权限。
properties.migrationMode	MigrationMode	用于执行迁移的模式：联机或脱机。
properties.migrationWindowStartTimeInUtc	string (date-time)	迁移时段的开始时间 （UTC）。
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	指示目标服务器上的数据库在已存在时是否可以被覆盖。 如果设置为 'False'，则当迁移工作流检测到目标服务器上已存在数据库时，它将等待确认。
properties.secretParameters	MigrationSecretParametersForPatch	迁移机密参数。
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	指示是否在源服务器上设置逻辑复制（如果需要）。
properties.sourceDbServerFullyQualifiedDomainName	string	源服务器的完全限定域名 （FQDN） 或 IP 地址。 此属性是可选的。 如果提供，迁移服务将始终使用它来连接到源服务器。
properties.sourceDbServerResourceId	string	当 'sourceType' 为 'PostgreSQLSingleServer' 时，源数据库服务器资源的标识符。 对于其他源类型，必须将其设置为 ipaddress：port@username 或 hostname：port@username。
properties.startDataMigration	StartDataMigration	指示是否必须立即开始数据迁移。
properties.targetDbServerFullyQualifiedDomainName	string	目标服务器的完全限定域名 （FQDN） 或 IP 地址。 此属性是可选的。 提供后，迁移服务将始终使用它来连接到目标服务器。
properties.triggerCutover	TriggerCutover	指示是否必须为整个迁移触发直接转换。
tags	object	键值对形式的应用程序特定元数据。

MigrationSecretParameters

对象

迁移机密参数。

名称	类型	说明
adminCredentials	AdminCredentials (password)	源服务器和目标服务器的管理员用户的凭据。
sourceServerUsername	string	获取或设置源服务器的用户名称。 此用户不需要是管理员。
targetServerUsername	string	获取或设置目标服务器的用户名称。 此用户不需要是管理员。

MigrationSecretParametersForPatch

对象

迁移机密参数。

名称	类型	说明
adminCredentials	AdminCredentialsForPatch (password)	源服务器和目标服务器的管理员用户的凭据。
sourceServerUsername	string	获取或设置源服务器的用户名称。 此用户不需要是管理员。
targetServerUsername	string	获取或设置目标服务器的用户名称。 此用户不需要是管理员。

MigrationState

枚举

迁移状态。

值	说明
InProgress
WaitingForUserAction
Canceled
Failed
Succeeded
ValidationFailed
CleaningUp

MigrationStatus

对象

迁移状态。

名称	类型	说明
currentSubStateDetails	MigrationSubstateDetails	当前迁移子状态详细信息。
error	string	迁移状态的错误消息（如果有）。
state	MigrationState	迁移状态。

MigrationSubstate

枚举

迁移的子状态。

值	说明
PerformingPreRequisiteSteps
WaitingForLogicalReplicationSetupRequestOnSourceDB
WaitingForDBsToMigrateSpecification
WaitingForTargetDBOverwriteConfirmation
WaitingForDataMigrationScheduling
WaitingForDataMigrationWindow
MigratingData
WaitingForCutoverTrigger
CompletingMigration
Completed
CancelingRequestedDBMigrations
ValidationInProgress

MigrationSubstateDetails

对象

迁移子状态的详细信息。

名称	类型	说明
currentSubState	MigrationSubstate	迁移的子状态。
dbDetails	<string,  DatabaseMigrationState>
validationDetails	ValidationDetails	迁移验证的详细信息。

OverwriteDatabasesOnTargetServer

枚举

指示目标服务器上的数据库在已存在时是否可以被覆盖。 如果设置为 'False'，则当迁移工作流检测到目标服务器上已存在数据库时，它将等待确认。

值	说明
True
False

ServerSku

对象

计算服务器的信息。

名称	类型	说明
name	string	数据库服务器的计算层和大小。 对于 Azure Database for PostgreSQL 单一服务器，此对象为空。
tier	SkuTier	分配给服务器的计算层。

SkuTier

枚举

分配给服务器的计算层。

值	说明
Burstable
GeneralPurpose
MemoryOptimized

SourceType

枚举

用于迁移的源服务器类型：ApsaraDB_RDS、AWS、AWS_AURORA、AWS_EC2、AWS_RDS、AzureVM、Crunchy_PostgreSQL、Digital_Ocean_Droplets、Digital_Ocean_PostgreSQL、EDB、EDB_Oracle_Server、EDB_PostgreSQL、GCP、GCP_AlloyDB、GCP_CloudSQL、GCP_Compute、Heroku_PostgreSQL、Huawei_Compute、Huawei_RDS、OnPremises、PostgreSQLCosmosDB、PostgreSQLFlexibleServer、PostgreSQLSingleServer 或 Supabase_PostgreSQL

值	说明
OnPremises
AWS
GCP
AzureVM
PostgreSQLSingleServer
AWS_RDS
AWS_AURORA
AWS_EC2
GCP_CloudSQL
GCP_AlloyDB
GCP_Compute
EDB
EDB_Oracle_Server
EDB_PostgreSQL
PostgreSQLFlexibleServer
PostgreSQLCosmosDB
Huawei_RDS
Huawei_Compute
Heroku_PostgreSQL
Crunchy_PostgreSQL
ApsaraDB_RDS
Digital_Ocean_Droplets
Digital_Ocean_PostgreSQL
Supabase_PostgreSQL

SslMode

枚举

迁移使用的 SSL 模式。 “PostgreSQLSingleServer”的默认 SSL 模式为“VerifyFull”。 其他源类型的默认 SSL 模式为 'Prefer'。

值	说明
Prefer
Require
VerifyCA
VerifyFull

StartDataMigration

枚举

指示是否必须立即开始数据迁移。

值	说明
True
False

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳 （UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

TriggerCutover

枚举

指示是否必须为整个迁移触发直接转换。

值	说明
True
False

ValidationDetails

对象

迁移验证的详细信息。

名称	类型	说明
dbLevelValidationDetails	DbLevelValidationStatus[]	服务器级别验证的详细信息。
serverLevelValidationDetails	ValidationSummaryItem[]	服务器级别验证的详细信息。
status	ValidationState	迁移的验证状态。
validationEndTimeInUtc	string (date-time)	验证的结束时间 （UTC）。
validationStartTimeInUtc	string (date-time)	验证的开始时间 （UTC）。

ValidationMessage

对象

验证消息对象。

名称	类型	说明
message	string	验证消息字符串。
state	ValidationState	验证消息的严重性。

ValidationState

枚举

迁移的验证状态。

值	说明
Failed
Succeeded
Warning

ValidationSummaryItem

对象

验证摘要对象。

名称	类型	说明
messages	ValidationMessage[]	验证消息。
state	ValidationState	迁移的验证状态。
type	string	验证类型。