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

Microsoft.DBforPostgreSQL flexibleServers/migrations

Bicep 资源定义

可以使用面向以下操作部署 flexibleServers/migrations 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DBforPostgreSQL/flexibleServers/migrations 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers/migrations@2023-03-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    cancel: 'string'
    dbsToCancelMigrationOn: [
      'string'
    ]
    dbsToMigrate: [
      'string'
    ]
    dbsToTriggerCutoverOn: [
      'string'
    ]
    migrationMode: 'string'
    migrationWindowEndTimeInUtc: 'string'
    migrationWindowStartTimeInUtc: 'string'
    overwriteDbsInTarget: 'string'
    secretParameters: {
      adminCredentials: {
        sourceServerPassword: 'string'
        targetServerPassword: 'string'
      }
      sourceServerUsername: 'string'
      targetServerUsername: 'string'
    }
    setupLogicalReplicationOnSourceDbIfNeeded: 'string'
    sourceDbServerFullyQualifiedDomainName: 'string'
    sourceDbServerResourceId: 'string'
    startDataMigration: 'string'
    targetDbServerFullyQualifiedDomainName: 'string'
    triggerCutover: 'string'
  }
}

属性值

flexibleServers/migrations

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为 的资源的符号名称: flexibleServers
properties 迁移资源属性。 MigrationResourceProperties

MigrationResourceProperties

名称 说明
cancel 若要为整个迁移触发取消,需要将此标志作为 True 发送 'False'
'True'
dbsToCancelMigrationOn 如果要为特定数据库触发取消,请发送取消标志为 True,并且此数组中的数据库名称 string[]
dbsToMigrate 要迁移的数据库数 string[]
dbsToTriggerCutoverOn 如果要为特定数据库触发直接转换,请发送 triggerCutover 标志为 True,并且此数组中的数据库名称 string[]
migrationMode 联机和脱机迁移模式有两种类型 “脱机”
'Online'
migrationWindowEndTimeInUtc 迁移时段的结束时间(UTC) string
migrationWindowStartTimeInUtc 迁移时段的开始时间(UTC) 字符串
overwriteDbsInTarget 指示是否可以覆盖目标服务器上的数据库(如果已存在)。 如果设置为 False,则迁移工作流将等待确认(如果检测到数据库已存在)。 'False'
'True'
secretParameters 迁移机密参数 MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded 指示是否根据需要设置 LogicalReplicationOnSourceDb 'False'
'True'
sourceDbServerFullyQualifiedDomainName 源服务器完全限定的域名或 IP。 它是一个可选值,如果客户提供,dms 将始终使用它进行连接 字符串
sourceDbServerResourceId 源数据库服务器的 ResourceId 字符串
startDataMigration 指示数据迁移是否应立即开始 'False'
'True'
targetDbServerFullyQualifiedDomainName 目标服务器完全限定的域名或 IP。 它是一个可选值,如果客户提供,dms 将始终使用它进行连接 字符串
triggerCutover 若要为整个迁移触发直接转换,需要将此标志作为 True 发送 'False'
'True'

MigrationSecretParameters

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

AdminCredentials

名称 说明
sourceServerPassword 源服务器的密码。 字符串 (必需)
targetServerPassword 目标服务器的密码。 字符串 (必需)

ARM 模板资源定义

可以使用面向以下操作部署 flexibleServers/migrations 资源类型:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DBforPostgreSQL/flexibleServers/migrations 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "cancel": "string",
    "dbsToCancelMigrationOn": [ "string" ],
    "dbsToMigrate": [ "string" ],
    "dbsToTriggerCutoverOn": [ "string" ],
    "migrationMode": "string",
    "migrationWindowEndTimeInUtc": "string",
    "migrationWindowStartTimeInUtc": "string",
    "overwriteDbsInTarget": "string",
    "secretParameters": {
      "adminCredentials": {
        "sourceServerPassword": "string",
        "targetServerPassword": "string"
      },
      "sourceServerUsername": "string",
      "targetServerUsername": "string"
    },
    "setupLogicalReplicationOnSourceDbIfNeeded": "string",
    "sourceDbServerFullyQualifiedDomainName": "string",
    "sourceDbServerResourceId": "string",
    "startDataMigration": "string",
    "targetDbServerFullyQualifiedDomainName": "string",
    "triggerCutover": "string"
  }
}

属性值

flexibleServers/migrations

名称 说明 Value
type 资源类型 'Microsoft.DBforPostgreSQL/flexibleServers/migrations'
apiVersion 资源 API 版本 “2023-03-01-preview”
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。
字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties 迁移资源属性。 MigrationResourceProperties

MigrationResourceProperties

名称 说明
cancel 若要为整个迁移触发取消,我们需要将此标志发送为 True 'False'
“True”
dbsToCancelMigrationOn 如果要为特定数据库触发取消,请在此数组中发送取消标志为 True 和数据库名称 string[]
dbsToMigrate 要迁移的数据库数 string[]
dbsToTriggerCutoverOn 如果要为特定数据库触发直接转换,请发送 triggerCutover 标志作为 True,并且此数组中的数据库名称 string[]
migrationMode 有两种类型的迁移模式联机和脱机 “脱机”
“Online”
migrationWindowEndTimeInUtc 迁移时段的 UTC 结束时间 string
migrationWindowStartTimeInUtc 迁移时段的 UTC 开始时间 字符串
overwriteDbsInTarget 指示是否可以覆盖目标服务器上的数据库(如果已存在)。 如果设置为 False,则迁移工作流将等待确认(如果检测到数据库已存在)。 'False'
“True”
secretParameters 迁移机密参数 MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded 指示是否根据需要设置 LogicalReplicationOnSourceDb 'False'
“True”
sourceDbServerFullyQualifiedDomainName 源服务器完全限定的域名或 ip。 它是一个可选值,如果客户提供该值,dms 将始终使用它进行连接 string
sourceDbServerResourceId 源数据库服务器的 ResourceId 字符串
startDataMigration 指示数据迁移是否应立即开始 'False'
'True'
targetDbServerFullyQualifiedDomainName 目标服务器完全限定的域名或 IP。 它是一个可选值,如果客户提供,dms 将始终使用它进行连接 字符串
triggerCutover 若要为整个迁移触发直接转换,需要将此标志作为 True 发送 'False'
'True'

MigrationSecretParameters

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

AdminCredentials

名称 说明
sourceServerPassword 源服务器的密码。 字符串 (必需)
targetServerPassword 目标服务器的密码。 字符串 (必需)

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 flexibleServers/migrations 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DBforPostgreSQL/flexibleServers/migrations 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2023-03-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      cancel = "string"
      dbsToCancelMigrationOn = [
        "string"
      ]
      dbsToMigrate = [
        "string"
      ]
      dbsToTriggerCutoverOn = [
        "string"
      ]
      migrationMode = "string"
      migrationWindowEndTimeInUtc = "string"
      migrationWindowStartTimeInUtc = "string"
      overwriteDbsInTarget = "string"
      secretParameters = {
        adminCredentials = {
          sourceServerPassword = "string"
          targetServerPassword = "string"
        }
        sourceServerUsername = "string"
        targetServerUsername = "string"
      }
      setupLogicalReplicationOnSourceDbIfNeeded = "string"
      sourceDbServerFullyQualifiedDomainName = "string"
      sourceDbServerResourceId = "string"
      startDataMigration = "string"
      targetDbServerFullyQualifiedDomainName = "string"
      triggerCutover = "string"
    }
  })
}

属性值

flexibleServers/migrations

名称 说明 Value
type 资源类型 “Microsoft.DBforPostgreSQL/flexibleServers/migrations@2023-03-01-preview”
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型为 的资源的 ID: flexibleServers
标记 资源标记。 标记名称和值的字典。
properties 迁移资源属性。 MigrationResourceProperties

MigrationResourceProperties

名称 说明
cancel 若要为整个迁移触发取消,需要将此标志作为 True 发送 “False”
“True”
dbsToCancelMigrationOn 如果要为特定数据库触发取消,请发送取消标志为 True,并且此数组中的数据库名称 string[]
dbsToMigrate 要迁移的数据库数 string[]
dbsToTriggerCutoverOn 如果要为特定数据库触发直接转换,请发送 triggerCutover 标志为 True,并且此数组中的数据库名称 string[]
migrationMode 联机和脱机迁移模式有两种类型 “脱机”
“Online”
migrationWindowEndTimeInUtc 迁移时段的结束时间(UTC) 字符串
migrationWindowStartTimeInUtc 迁移时段的开始时间(UTC) 字符串
overwriteDbsInTarget 指示是否可以覆盖目标服务器上的数据库(如果已存在)。 如果设置为 False,则迁移工作流将等待确认(如果检测到数据库已存在)。 “False”
“True”
secretParameters 迁移机密参数 MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded 指示是否根据需要设置 LogicalReplicationOnSourceDb “False”
“True”
sourceDbServerFullyQualifiedDomainName 源服务器完全限定的域名或 ip。 它是一个可选值,如果客户提供该值,dms 将始终使用它进行连接 string
sourceDbServerResourceId 源数据库服务器的 ResourceId 字符串
startDataMigration 指示数据迁移是否应立即开始 “False”
“True”
targetDbServerFullyQualifiedDomainName 目标服务器完全限定的域名或 ip。 它是一个可选值,如果客户提供该值,dms 将始终使用它进行连接 string
triggerCutover 若要触发整个迁移的直接转换,我们需要将此标志发送为 True “False”
“True”

MigrationSecretParameters

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

AdminCredentials

名称 说明
sourceServerPassword 源服务器的密码。 字符串 (必需)
targetServerPassword 目标服务器的密码。 字符串 (必需)