Microsoft.DBforPostgreSQL flexibleServers/migrations 2023-03-01-preview

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 で子リソースの名前と型を設定する方法を参照してください。
string (必須)
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。
型のリソースのシンボル名: flexibleServers
properties 移行リソースのプロパティ。 MigrationResourceProperties

MigrationResourceProperties

名前 説明
cancel 移行全体のキャンセルをトリガーするには、このフラグを True として送信する必要があります "False"
'True'
dbsToCancelMigrationOn 特定のデータベースに対してキャンセルをトリガーする場合は、キャンセル フラグを True として送信し、この配列内のデータベース名を指定します string[]
dbsToMigrate 移行するデータベースの数 string[]
dbsToTriggerCutoverOn 特定のデータベースのカットオーバーをトリガーする場合は、triggerCutover フラグを True として送信し、この配列内のデータベース名を指定します string[]
migrationMode オンラインとオフラインの 2 種類の移行モードがあります 'オフライン'
'Online'
migrationWindowEndTimeInUtc 移行期間の終了時刻 (UTC) string
migrationWindowStartTimeInUtc 移行期間の UTC の開始時刻 string
overwriteDbsInTarget ターゲット サーバー上のデータベースが既に存在する場合に上書きできるかどうかを示します。 False に設定すると、データベースが既に存在することが検出された場合、移行ワークフローは確認を待機します。 "False"
'True'
secretParameters 移行シークレット パラメーター MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded 必要に応じて LogicalReplicationOnSourceDb をセットアップするかどうかを示します "False"
'True'
sourceDbServerFullyQualifiedDomainName ソース サーバーの完全修飾ドメイン名または ip。 これは省略可能な値です。顧客が指定した場合、dms は常に接続に使用します string
sourceDbServerResourceId ソース データベース サーバーの ResourceId string
startDataMigration データ移行をすぐに開始するかどうかを示します "False"
'True'
targetDbServerFullyQualifiedDomainName ターゲット サーバーの完全修飾ドメイン名または ip。 これは省略可能な値です。顧客が指定した場合、dms は常に接続に使用します string
triggerCutover 移行全体のカットオーバーをトリガーするには、このフラグを True として送信する必要があります "False"
'True'

MigrationSecretParameters

名前 説明
adminCredentials ソース サーバーとターゲット サーバーの資格情報を管理する AdminCredentials (必須)
sourceServerUsername ソース サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 string
targetServerUsername ターゲット サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 string

AdminCredentials

名前 説明
sourceServerPassword ソース サーバーのパスワード。 string (必須)
targetServerPassword ターゲット サーバーのパスワード。 string (必須)

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

名前 説明
type リソースの種類 'Microsoft.DBforPostgreSQL/flexibleServers/migrations'
apiVersion リソース API のバージョン '2023-03-01-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。
string (必須)
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
properties 移行リソースのプロパティ。 MigrationResourceProperties

MigrationResourceProperties

名前 説明
cancel 移行全体のキャンセルをトリガーするには、このフラグを True として送信する必要があります "False"
'True'
dbsToCancelMigrationOn 特定のデータベースに対して取り消しをトリガーする場合は、キャンセル フラグを True として送信し、この配列内のデータベース名を送信します string[]
dbsToMigrate 移行するデータベースの数 string[]
dbsToTriggerCutoverOn 特定のデータベースのカットオーバーをトリガーする場合は、triggerCutover フラグを True として送信し、この配列内のデータベース名を送信します string[]
migrationMode オンラインとオフラインの 2 種類の移行モードがあります 'オフライン'
'Online'
migrationWindowEndTimeInUtc 移行期間の終了時刻 (UTC) string
migrationWindowStartTimeInUtc 移行期間の開始時刻 (UTC) string
overwriteDbsInTarget ターゲット サーバー上のデータベースを上書きできるかどうかを示します (既に存在する場合)。 False に設定すると、データベースが既に存在することが検出された場合、移行ワークフローは確認を待機します。 "False"
'True'
secretParameters 移行シークレット パラメーター MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded 必要に応じて LogicalReplicationOnSourceDb を設定するかどうかを示します "False"
'True'
sourceDbServerFullyQualifiedDomainName ソース サーバーの完全修飾ドメイン名または IP。 これは省略可能な値です。顧客が指定した場合、dms は常に接続に使用します string
sourceDbServerResourceId ソース データベース サーバーの ResourceId string
startDataMigration データ移行をすぐに開始するかどうかを示します "False"
'True'
targetDbServerFullyQualifiedDomainName ターゲット サーバーの完全修飾ドメイン名または ip。 これは省略可能な値です。顧客が指定した場合、dms は常に接続に使用します string
triggerCutover 移行全体のカットオーバーをトリガーするには、このフラグを True として送信する必要があります "False"
'True'

MigrationSecretParameters

Name 説明
adminCredentials ソース サーバーとターゲット サーバーの資格情報を管理する AdminCredentials (必須)
sourceServerUsername ソース サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 string
targetServerUsername ターゲット サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 string

AdminCredentials

Name 説明
sourceServerPassword ソース サーバーのパスワード。 string (必須)
targetServerPassword ターゲット サーバーのパスワード。 string (必須)

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

名前 説明
type リソースの種類 "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2023-03-01-preview"
name リソース名 string (必須)
location リソースが保存されている地理的な場所 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: flexibleServers
tags リソース タグ。 タグの名前と値のディクショナリ。
properties 移行リソースのプロパティ。 MigrationResourceProperties

MigrationResourceProperties

名前 説明
cancel 移行全体のキャンセルをトリガーするには、このフラグを True として送信する必要があります "False"
"True"
dbsToCancelMigrationOn 特定のデータベースに対してキャンセルをトリガーする場合は、キャンセル フラグを True として送信し、この配列内のデータベース名を指定します string[]
dbsToMigrate 移行するデータベースの数 string[]
dbsToTriggerCutoverOn 特定のデータベースのカットオーバーをトリガーする場合は、triggerCutover フラグを True として送信し、この配列内のデータベース名を指定します string[]
migrationMode オンラインとオフラインの 2 種類の移行モードがあります "オフライン"
"オンライン"
migrationWindowEndTimeInUtc 移行期間の終了時刻 (UTC) string
migrationWindowStartTimeInUtc 移行期間の UTC の開始時刻 string
overwriteDbsInTarget ターゲット サーバー上のデータベースが既に存在する場合に上書きできるかどうかを示します。 False に設定すると、データベースが既に存在することが検出された場合、移行ワークフローは確認を待機します。 "False"
"True"
secretParameters 移行シークレット パラメーター MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded 必要に応じて LogicalReplicationOnSourceDb をセットアップするかどうかを示します "False"
"True"
sourceDbServerFullyQualifiedDomainName ソース サーバーの完全修飾ドメイン名または ip。 これは省略可能な値です。顧客が指定した場合、dms は常に接続に使用します string
sourceDbServerResourceId ソース データベース サーバーの ResourceId string
startDataMigration データ移行をすぐに開始するかどうかを示します "False"
"True"
targetDbServerFullyQualifiedDomainName ターゲット サーバーの完全修飾ドメイン名または ip。 これは省略可能な値です。顧客が指定した場合、dms は常に接続に使用します string
triggerCutover 移行全体のカットオーバーをトリガーするには、このフラグを True として送信する必要があります "False"
"True"

MigrationSecretParameters

名前 説明
adminCredentials ソース サーバーとターゲット サーバーの資格情報を管理する AdminCredentials (必須)
sourceServerUsername ソース サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 string
targetServerUsername ターゲット サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 string

AdminCredentials

Name 説明
sourceServerPassword ソース サーバーのパスワード。 string (必須)
targetServerPassword ターゲット サーバーのパスワード。 string (必須)