共用方式為

Microsoft.DBforPostgreSQL 彈性伺服器/移轉 2024-08-01

  • 發行項

Bicep 資源定義

彈性伺服器/移轉資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DBforPostgreSQL/flexibleServers/migrations 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers/migrations@2024-08-01' = {
  parent: resourceSymbolicName
  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

名字 描述 價值
位置 資源所在的地理位置 字串 （必要）
名字 資源名稱 字串

約束：
模式 = ^[a-z][a-z0-9]*$ （必要）
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱：彈性伺服器
性能 移轉資源屬性。 MigrationResourceProperties
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

MigrationResourceProperties

名字 描述 價值
取消 若要觸發取消整個移轉，我們需要將此旗標傳送為 True 'False'
'True'
dbsToCancelMigrationOn 當您想要針對特定資料庫觸發取消時，請將取消旗標傳送為 True，而此陣列中的資料庫名稱 string[]
dbsToMigrate 要移轉的資料庫數目 string[]
dbsToTriggerCutoverOn 當您想要觸發特定資料庫的完全移轉時，請將 triggerCutover 旗標傳送為 True，且此陣列中的資料庫名稱 string[]
migrateRoles 若要移轉角色和許可權，我們需要將此旗標傳送為 True 'False'
'True'
migrationInstanceResourceId 私人端點移轉實例的 ResourceId 字串
migrationMode 在線和離線移轉模式有兩種類型 'Offline'
'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 或主機名：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 樣本資源定義

彈性伺服器/移轉資源類型可以使用目標作業來部署：

如需每個 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'
位置 資源所在的地理位置 字串 （必要）
名字 資源名稱 字串

約束：
模式 = ^[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 在線和離線移轉模式有兩種類型 'Offline'
'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 或主機名：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 提供者） 資源定義

彈性伺服器/移轉資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DBforPostgreSQL/flexibleServers/migrations 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2024-08-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "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"
    }
  })
}

屬性值

AdminCredentials

名字 描述 價值
sourceServerPassword 來源伺服器的密碼。 字串

約束：
敏感性值。 以安全參數的形式傳入。 （必要）
targetServerPassword 目標伺服器的密碼。 字串

約束：
敏感性值。 以安全參數的形式傳入。 （必要）

Microsoft.DBforPostgreSQL/flexibleServers/migrations

名字 描述 價值
位置 資源所在的地理位置 字串 （必要）
名字 資源名稱 字串

約束：
模式 = ^[a-z][a-z0-9]*$ （必要）
parent_id 此資源為父系之資源的標識碼。 類型資源的標識碼：彈性伺服器
性能 移轉資源屬性。 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 在線和離線移轉模式有兩種類型 'Offline'
'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 或主機名：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

名字 描述 價值