Microsoft.DBforPostgreSQL flexibleServers/migrations 2022-05-01-preview

Bicep リソース定義

flexibleServers/migrations リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DBforPostgreSQL/flexibleServers/migrations リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers/migrations@2022-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    cancel: bool
    dBsToCancelMigrationOn: [
      'string'
    ]
    dBsToMigrate: [
      'string'
    ]
    dBsToTiggerCutoverOn: [
      'string'
    ]
    migrationMode: 'string'
    migrationWindowStartTimeInUtc: 'string'
    overwriteDBsInTarget: bool
    secretParameters: {
      adminCredentials: {
        sourceServerPassword: 'string'
        targetServerPassword: 'string'
      }
    }
    setupLogicalReplicationOnSourceDBIfNeeded: bool
    sourceDBServerFullyQualifiedDomainName: 'string'
    sourceDBServerResourceId: 'string'
    startDataMigration: bool
    targetDBServerFullyQualifiedDomainName: 'string'
    triggerCutover: bool
  }
}

プロパティ値

flexibleServers/migrations

名前 形容 価値
名前 リソース名

Bicepで子リソースの名前と種類 設定する方法を参照してください。
string (必須)
場所 リソースが存在する地理的な場所 string (必須)
タグ リソース タグ。 タグ名と値のディクショナリ。 テンプレート の タグを参照してください
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

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

MigrationResourceProperties

名前 形容 価値
キャンセル 移行全体のキャンセルをトリガーするには、このフラグを true として送信する必要があります bool
dBsToCancelMigrationOn 特定のデータベースに対してキャンセルをトリガーする場合は、triggerCutover フラグを true として送信し、この配列内のデータベース名を送信します string[]
dBsToMigrate string[]

制約:
最大長 = 50
dBsToTiggerCutoverOn 特定のデータベースのカットオーバーをトリガーする場合は、triggerCutover フラグを true として送信し、この配列内のデータベース名を送信します string[]
migrationMode オンラインとオフラインの 2 種類の移行モードがあります 'オフライン'
'Online'
migrationWindowStartTimeInUtc
overwriteDBsInTarget bool
secretParameters 移行シークレット パラメーター。 MigrationSecretParameters
setupLogicalReplicationOnSourceDBIfNeeded bool
sourceDBServerFullyQualifiedDomainName
sourceDBServerResourceId
startDataMigration bool
targetDBServerFullyQualifiedDomainName
triggerCutover 移行全体のカットオーバーをトリガーするには、このフラグを true として送信する必要があります bool

MigrationSecretParameters

名前 形容 価値
adminCredentials サーバー管理者の資格情報。 AdminCredentials (必須)

AdminCredentials

名前 形容 価値
sourceServerPassword string (必須)

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
targetServerPassword string (必須)

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。

ARM テンプレート リソース定義

flexibleServers/migrations リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DBforPostgreSQL/flexibleServers/migrations リソースを作成するには、テンプレートに次の JSON を追加します。

{
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations",
  "apiVersion": "2022-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "cancel": "bool",
    "dBsToCancelMigrationOn": [ "string" ],
    "dBsToMigrate": [ "string" ],
    "dBsToTiggerCutoverOn": [ "string" ],
    "migrationMode": "string",
    "migrationWindowStartTimeInUtc": "string",
    "overwriteDBsInTarget": "bool",
    "secretParameters": {
      "adminCredentials": {
        "sourceServerPassword": "string",
        "targetServerPassword": "string"
      }
    },
    "setupLogicalReplicationOnSourceDBIfNeeded": "bool",
    "sourceDBServerFullyQualifiedDomainName": "string",
    "sourceDBServerResourceId": "string",
    "startDataMigration": "bool",
    "targetDBServerFullyQualifiedDomainName": "string",
    "triggerCutover": "bool"
  }
}

プロパティ値

flexibleServers/migrations

名前 形容 価値
種類 リソースの種類 'Microsoft.DBforPostgreSQL/flexibleServers/migrations'
apiVersion リソース API のバージョン '2022-05-01-preview'
名前 リソース名

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

MigrationResourceProperties

名前 形容 価値
キャンセル 移行全体のキャンセルをトリガーするには、このフラグを true として送信する必要があります bool
dBsToCancelMigrationOn 特定のデータベースに対してキャンセルをトリガーする場合は、triggerCutover フラグを true として送信し、この配列内のデータベース名を送信します string[]
dBsToMigrate string[]

制約:
最大長 = 50
dBsToTiggerCutoverOn 特定のデータベースのカットオーバーをトリガーする場合は、triggerCutover フラグを true として送信し、この配列内のデータベース名を送信します string[]
migrationMode オンラインとオフラインの 2 種類の移行モードがあります 'オフライン'
'Online'
migrationWindowStartTimeInUtc
overwriteDBsInTarget bool
secretParameters 移行シークレット パラメーター。 MigrationSecretParameters
setupLogicalReplicationOnSourceDBIfNeeded bool
sourceDBServerFullyQualifiedDomainName
sourceDBServerResourceId
startDataMigration bool
targetDBServerFullyQualifiedDomainName
triggerCutover 移行全体のカットオーバーをトリガーするには、このフラグを true として送信する必要があります bool

MigrationSecretParameters

名前 形容 価値
adminCredentials サーバー管理者の資格情報。 AdminCredentials (必須)

AdminCredentials

名前 形容 価値
sourceServerPassword string (必須)

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
targetServerPassword string (必須)

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。

Terraform (AzAPI プロバイダー) リソース定義

flexibleServers/migrations リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DBforPostgreSQL/flexibleServers/migrations リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2022-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      cancel = bool
      dBsToCancelMigrationOn = [
        "string"
      ]
      dBsToMigrate = [
        "string"
      ]
      dBsToTiggerCutoverOn = [
        "string"
      ]
      migrationMode = "string"
      migrationWindowStartTimeInUtc = "string"
      overwriteDBsInTarget = bool
      secretParameters = {
        adminCredentials = {
          sourceServerPassword = "string"
          targetServerPassword = "string"
        }
      }
      setupLogicalReplicationOnSourceDBIfNeeded = bool
      sourceDBServerFullyQualifiedDomainName = "string"
      sourceDBServerResourceId = "string"
      startDataMigration = bool
      targetDBServerFullyQualifiedDomainName = "string"
      triggerCutover = bool
    }
  })
}

プロパティ値

flexibleServers/migrations

名前 形容 価値
種類 リソースの種類 "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2022-05-01-preview"
名前 リソース名 string (必須)
場所 リソースが存在する地理的な場所 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: flexibleServers
タグ リソース タグ。 タグ名と値のディクショナリ。
プロパティ 移行リソースのプロパティ。 MigrationResourceProperties

MigrationResourceProperties

名前 形容 価値
キャンセル 移行全体のキャンセルをトリガーするには、このフラグを true として送信する必要があります bool
dBsToCancelMigrationOn 特定のデータベースに対してキャンセルをトリガーする場合は、triggerCutover フラグを true として送信し、この配列内のデータベース名を送信します string[]
dBsToMigrate string[]

制約:
最大長 = 50
dBsToTiggerCutoverOn 特定のデータベースのカットオーバーをトリガーする場合は、triggerCutover フラグを true として送信し、この配列内のデータベース名を送信します string[]
migrationMode オンラインとオフラインの 2 種類の移行モードがあります "オフライン"
"オンライン"
migrationWindowStartTimeInUtc
overwriteDBsInTarget bool
secretParameters 移行シークレット パラメーター。 MigrationSecretParameters
setupLogicalReplicationOnSourceDBIfNeeded bool
sourceDBServerFullyQualifiedDomainName
sourceDBServerResourceId
startDataMigration bool
targetDBServerFullyQualifiedDomainName
triggerCutover 移行全体のカットオーバーをトリガーするには、このフラグを true として送信する必要があります bool

MigrationSecretParameters

名前 形容 価値
adminCredentials サーバー管理者の資格情報。 AdminCredentials (必須)

AdminCredentials

名前 形容 価値
sourceServerPassword string (必須)

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
targetServerPassword string (必須)

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。