通过

你当前正在访问 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@2024-08-01' = {
  location: 'string'
  name: 'string'
  properties: {
    cancel: 'string'
    dbsToCancelMigrationOn: [
      'string'
    ]
    dbsToMigrate: [
      'string'
    ]
    dbsToTriggerCutoverOn: [
      'string'
    ]
    migrateRoles: 'string'
    migrationInstanceResourceId: 'string'
    migrationMode: 'string'
    migrationOption: 'string'
    migrationWindowEndTimeInUtc: 'string'
    migrationWindowStartTimeInUtc: 'string'
    overwriteDbsInTarget: 'string'
    secretParameters: {
      adminCredentials: {
        sourceServerPassword: 'string'
        targetServerPassword: 'string'
      }
      sourceServerUsername: 'string'
      targetServerUsername: 'string'
    }
    setupLogicalReplicationOnSourceDbIfNeeded: 'string'
    sourceDbServerFullyQualifiedDomainName: 'string'
    sourceDbServerResourceId: 'string'
    sourceType: 'string'
    sslMode: 'string'
    startDataMigration: 'string'
    targetDbServerFullyQualifiedDomainName: 'string'
    triggerCutover: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AdminCredentials

名字 描述 价值
sourceServerPassword 源服务器的密码。 字符串

约束：
敏感值。 以安全参数的形式传入。 （必需）
targetServerPassword 目标服务器的密码。 字符串

约束：
敏感值。 以安全参数的形式传入。 （必需）

Microsoft.DBforPostgreSQL/flexibleServers/migrations

名字 描述 价值
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
模式 = ^[a-z][a-z0-9]*$ （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：flexibleServers
性能 迁移资源属性。 MigrationResourceProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

MigrationResourceProperties

名字 描述 价值
取消 若要为整个迁移触发取消，需要将此标志作为 True 发送 “False”
“True”
dbsToCancelMigrationOn 如果想要为特定数据库触发取消，请将取消标志作为 True 和此数组中的数据库名称发送 string[]
dbsToMigrate 要迁移的数据库数 string[]
dbsToTriggerCutoverOn 如果想要为特定数据库触发直接转换，请将 triggerCutover 标志作为 True 和此数组中的数据库名称发送 string[]
migrateRoles 若要迁移角色和权限，需要将此标志作为 True 发送 “False”
“True”
migrationInstanceResourceId 专用终结点迁移实例的 ResourceId 字符串
migrationMode 联机和脱机迁移模式有两种类型 “脱机”
“Online”
migrationOption 这表示迁移支持的迁移选项 “Migrate”
“Validate”
“ValidateAndMigrate”
migrationWindowEndTimeInUtc 用于迁移窗口的 UTC 结束时间 字符串
migrationWindowStartTimeInUtc 迁移窗口的 UTC 开始时间 字符串
overwriteDbsInTarget 指示是否可以覆盖目标服务器上的数据库（如果已存在）。 如果设置为 False，则迁移工作流将等待确认（如果检测到数据库已存在）。 “False”
“True”
secretParameters 迁移机密参数 MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded 指示是否需要设置 LogicalReplicationOnSourceDb “False”
“True”
sourceDbServerFullyQualifiedDomainName 源服务器完全限定的域名（FQDN）或 IP 地址。 它是一个可选值，如果客户提供它，迁移服务将始终使用它进行连接 字符串
sourceDbServerResourceId 如果 sourceType 为 PostgreSQLSingleServer，则源数据库服务器的 ResourceId。 对于其他源类型，应为 ipaddress：port@username 或 hostname：port@username 字符串
sourceType 迁移源服务器类型：OnPremises、AWS、GCP、AzureVM、PostgreSQLSingleServer、AWS_RDS、AWS_AURORA、AWS_EC2、GCP_CloudSQL、GCP_AlloyDB、GCP_Compute 或 EDB “AWS”
“AWS_AURORA”
“AWS_EC2”
“AWS_RDS”
“AzureVM”
“EDB”
“GCP”
“GCP_AlloyDB”
“GCP_CloudSQL”
“GCP_Compute”
“OnPremises”
“PostgreSQLSingleServer”
sslMode 用于迁移的 SSL 模式。 PostgreSQLSingleServer 的默认 SSL 模式为 VerifyFull，并且首选其他源类型 “Prefer”
“Require”
“VerifyCA”
“VerifyFull”
startDataMigration 指示数据迁移是否应立即开始 “False”
“True”
targetDbServerFullyQualifiedDomainName 目标服务器完全限定的域名（FQDN）或 IP 地址。 它是一个可选值，如果客户提供它，迁移服务将始终使用它进行连接 字符串
triggerCutover 若要触发整个迁移的直接转换，需要将此标志作为 True 发送 “False”
“True”

MigrationSecretParameters

名字 描述 价值
adminCredentials 源服务器和目标服务器的管理员凭据 AdminCredentials （必需）
sourceServerUsername 获取或设置源服务器的用户名。 此用户不需要是管理员。 字符串
targetServerUsername 获取或设置目标服务器的用户名。 此用户不需要是管理员。 字符串

TrackedResourceTags

名字 描述 价值

ARM 模板资源定义

可以使用目标操作部署 flexibleServers/migrations 资源类型：

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

资源格式

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

{
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations",
  "apiVersion": "2024-08-01",
  "name": "string",
  "location": "string",
  "properties": {
    "cancel": "string",
    "dbsToCancelMigrationOn": [ "string" ],
    "dbsToMigrate": [ "string" ],
    "dbsToTriggerCutoverOn": [ "string" ],
    "migrateRoles": "string",
    "migrationInstanceResourceId": "string",
    "migrationMode": "string",
    "migrationOption": "string",
    "migrationWindowEndTimeInUtc": "string",
    "migrationWindowStartTimeInUtc": "string",
    "overwriteDbsInTarget": "string",
    "secretParameters": {
      "adminCredentials": {
        "sourceServerPassword": "string",
        "targetServerPassword": "string"
      },
      "sourceServerUsername": "string",
      "targetServerUsername": "string"
    },
    "setupLogicalReplicationOnSourceDbIfNeeded": "string",
    "sourceDbServerFullyQualifiedDomainName": "string",
    "sourceDbServerResourceId": "string",
    "sourceType": "string",
    "sslMode": "string",
    "startDataMigration": "string",
    "targetDbServerFullyQualifiedDomainName": "string",
    "triggerCutover": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AdminCredentials

名字 描述 价值
sourceServerPassword 源服务器的密码。 字符串

约束：
敏感值。 以安全参数的形式传入。 （必需）
targetServerPassword 目标服务器的密码。 字符串

约束：
敏感值。 以安全参数的形式传入。 （必需）

Microsoft.DBforPostgreSQL/flexibleServers/migrations

名字 描述 价值
apiVersion API 版本 '2024-08-01'
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
模式 = ^[a-z][a-z0-9]*$ （必需）
性能 迁移资源属性。 MigrationResourceProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.DBforPostgreSQL/flexibleServers/migrations”

MigrationResourceProperties

名字 描述 价值
取消 若要为整个迁移触发取消，需要将此标志作为 True 发送 “False”
“True”
dbsToCancelMigrationOn 如果想要为特定数据库触发取消，请将取消标志作为 True 和此数组中的数据库名称发送 string[]
dbsToMigrate 要迁移的数据库数 string[]
dbsToTriggerCutoverOn 如果想要为特定数据库触发直接转换，请将 triggerCutover 标志作为 True 和此数组中的数据库名称发送 string[]
migrateRoles 若要迁移角色和权限，需要将此标志作为 True 发送 “False”
“True”
migrationInstanceResourceId 专用终结点迁移实例的 ResourceId 字符串
migrationMode 联机和脱机迁移模式有两种类型 “脱机”
“Online”
migrationOption 这表示迁移支持的迁移选项 “Migrate”
“Validate”
“ValidateAndMigrate”
migrationWindowEndTimeInUtc 用于迁移窗口的 UTC 结束时间 字符串
migrationWindowStartTimeInUtc 迁移窗口的 UTC 开始时间 字符串
overwriteDbsInTarget 指示是否可以覆盖目标服务器上的数据库（如果已存在）。 如果设置为 False，则迁移工作流将等待确认（如果检测到数据库已存在）。 “False”
“True”
secretParameters 迁移机密参数 MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded 指示是否需要设置 LogicalReplicationOnSourceDb “False”
“True”
sourceDbServerFullyQualifiedDomainName 源服务器完全限定的域名（FQDN）或 IP 地址。 它是一个可选值，如果客户提供它，迁移服务将始终使用它进行连接 字符串
sourceDbServerResourceId 如果 sourceType 为 PostgreSQLSingleServer，则源数据库服务器的 ResourceId。 对于其他源类型，应为 ipaddress：port@username 或 hostname：port@username 字符串
sourceType 迁移源服务器类型：OnPremises、AWS、GCP、AzureVM、PostgreSQLSingleServer、AWS_RDS、AWS_AURORA、AWS_EC2、GCP_CloudSQL、GCP_AlloyDB、GCP_Compute 或 EDB “AWS”
“AWS_AURORA”
“AWS_EC2”
“AWS_RDS”
“AzureVM”
“EDB”
“GCP”
“GCP_AlloyDB”
“GCP_CloudSQL”
“GCP_Compute”
“OnPremises”
“PostgreSQLSingleServer”
sslMode 用于迁移的 SSL 模式。 PostgreSQLSingleServer 的默认 SSL 模式为 VerifyFull，并且首选其他源类型 “Prefer”
“Require”
“VerifyCA”
“VerifyFull”
startDataMigration 指示数据迁移是否应立即开始 “False”
“True”
targetDbServerFullyQualifiedDomainName 目标服务器完全限定的域名（FQDN）或 IP 地址。 它是一个可选值，如果客户提供它，迁移服务将始终使用它进行连接 字符串
triggerCutover 若要触发整个迁移的直接转换，需要将此标志作为 True 发送 “False”
“True”

MigrationSecretParameters

名字 描述 价值
adminCredentials 源服务器和目标服务器的管理员凭据 AdminCredentials （必需）
sourceServerUsername 获取或设置源服务器的用户名。 此用户不需要是管理员。 字符串
targetServerUsername 获取或设置目标服务器的用户名。 此用户不需要是管理员。 字符串

TrackedResourceTags

名字 描述 价值

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 flexibleServers/migrations 资源类型：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2024-08-01"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      cancel = "string"
      dbsToCancelMigrationOn = [
        "string"
      ]
      dbsToMigrate = [
        "string"
      ]
      dbsToTriggerCutoverOn = [
        "string"
      ]
      migrateRoles = "string"
      migrationInstanceResourceId = "string"
      migrationMode = "string"
      migrationOption = "string"
      migrationWindowEndTimeInUtc = "string"
      migrationWindowStartTimeInUtc = "string"
      overwriteDbsInTarget = "string"
      secretParameters = {
        adminCredentials = {
          sourceServerPassword = "string"
          targetServerPassword = "string"
        }
        sourceServerUsername = "string"
        targetServerUsername = "string"
      }
      setupLogicalReplicationOnSourceDbIfNeeded = "string"
      sourceDbServerFullyQualifiedDomainName = "string"
      sourceDbServerResourceId = "string"
      sourceType = "string"
      sslMode = "string"
      startDataMigration = "string"
      targetDbServerFullyQualifiedDomainName = "string"
      triggerCutover = "string"
    }
  })
  tags = {
    {customized property} = "string"
  }
}

属性值

AdminCredentials

名字 描述 价值
sourceServerPassword 源服务器的密码。 字符串

约束：
敏感值。 以安全参数的形式传入。 （必需）
targetServerPassword 目标服务器的密码。 字符串

约束：
敏感值。 以安全参数的形式传入。 （必需）

Microsoft.DBforPostgreSQL/flexibleServers/migrations

名字 描述 价值
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
模式 = ^[a-z][a-z0-9]*$ （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：flexibleServers
性能 迁移资源属性。 MigrationResourceProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.DBforPostgreSQL/flexibleServers/migrations@2024-08-01”

MigrationResourceProperties

名字 描述 价值
取消 若要为整个迁移触发取消，需要将此标志作为 True 发送 “False”
“True”
dbsToCancelMigrationOn 如果想要为特定数据库触发取消，请将取消标志作为 True 和此数组中的数据库名称发送 string[]
dbsToMigrate 要迁移的数据库数 string[]
dbsToTriggerCutoverOn 如果想要为特定数据库触发直接转换，请将 triggerCutover 标志作为 True 和此数组中的数据库名称发送 string[]
migrateRoles 若要迁移角色和权限，需要将此标志作为 True 发送 “False”
“True”
migrationInstanceResourceId 专用终结点迁移实例的 ResourceId 字符串
migrationMode 联机和脱机迁移模式有两种类型 “脱机”
“Online”
migrationOption 这表示迁移支持的迁移选项 “Migrate”
“Validate”
“ValidateAndMigrate”
migrationWindowEndTimeInUtc 用于迁移窗口的 UTC 结束时间 字符串
migrationWindowStartTimeInUtc 迁移窗口的 UTC 开始时间 字符串
overwriteDbsInTarget 指示是否可以覆盖目标服务器上的数据库（如果已存在）。 如果设置为 False，则迁移工作流将等待确认（如果检测到数据库已存在）。 “False”
“True”
secretParameters 迁移机密参数 MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded 指示是否需要设置 LogicalReplicationOnSourceDb “False”
“True”
sourceDbServerFullyQualifiedDomainName 源服务器完全限定的域名（FQDN）或 IP 地址。 它是一个可选值，如果客户提供它，迁移服务将始终使用它进行连接 字符串
sourceDbServerResourceId 如果 sourceType 为 PostgreSQLSingleServer，则源数据库服务器的 ResourceId。 对于其他源类型，应为 ipaddress：port@username 或 hostname：port@username 字符串
sourceType 迁移源服务器类型：OnPremises、AWS、GCP、AzureVM、PostgreSQLSingleServer、AWS_RDS、AWS_AURORA、AWS_EC2、GCP_CloudSQL、GCP_AlloyDB、GCP_Compute 或 EDB “AWS”
“AWS_AURORA”
“AWS_EC2”
“AWS_RDS”
“AzureVM”
“EDB”
“GCP”
“GCP_AlloyDB”
“GCP_CloudSQL”
“GCP_Compute”
“OnPremises”
“PostgreSQLSingleServer”
sslMode 用于迁移的 SSL 模式。 PostgreSQLSingleServer 的默认 SSL 模式为 VerifyFull，并且首选其他源类型 “Prefer”
“Require”
“VerifyCA”
“VerifyFull”
startDataMigration 指示数据迁移是否应立即开始 “False”
“True”
targetDbServerFullyQualifiedDomainName 目标服务器完全限定的域名（FQDN）或 IP 地址。 它是一个可选值，如果客户提供它，迁移服务将始终使用它进行连接 字符串
triggerCutover 若要触发整个迁移的直接转换，需要将此标志作为 True 发送 “False”
“True”

MigrationSecretParameters

名字 描述 价值
adminCredentials 源服务器和目标服务器的管理员凭据 AdminCredentials （必需）
sourceServerUsername 获取或设置源服务器的用户名。 此用户不需要是管理员。 字符串
targetServerUsername 获取或设置目标服务器的用户名。 此用户不需要是管理员。 字符串

TrackedResourceTags

名字 描述 价值