Share via

MigrationResourceForPatch interface

  • Reference
Package:
@azure/arm-postgresql-flexible

Represents a migration resource for patch.

Properties

cancel

To trigger cancel for entire migration we need to send this flag as True
dbsToCancelMigrationOn

When you want to trigger cancel for specific databases send cancel flag as True and database names in this array
dbsToMigrate

Number of databases to migrate
dbsToTriggerCutoverOn

When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array
migrateRoles

To migrate roles and permissions we need to send this flag as True
migrationMode

There are two types of migration modes Online and Offline
migrationWindowStartTimeInUtc

Start time in UTC for migration window
overwriteDbsInTarget

Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists.
secretParameters

Migration secret parameters
setupLogicalReplicationOnSourceDbIfNeeded

Indicates whether to setup LogicalReplicationOnSourceDb, if needed
sourceDbServerFullyQualifiedDomainName

Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection
sourceDbServerResourceId

ResourceId of the source database server
startDataMigration

Indicates whether the data migration should start right away
tags

Application-specific metadata in the form of key-value pairs.
targetDbServerFullyQualifiedDomainName

Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection
triggerCutover

To trigger cutover for entire migration we need to send this flag as True

Property Details

cancel

To trigger cancel for entire migration we need to send this flag as True

cancel?: string

Property Value

string

dbsToCancelMigrationOn

When you want to trigger cancel for specific databases send cancel flag as True and database names in this array

dbsToCancelMigrationOn?: string[]

Property Value

string[]

dbsToMigrate

Number of databases to migrate

dbsToMigrate?: string[]

Property Value

string[]

dbsToTriggerCutoverOn

When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array

dbsToTriggerCutoverOn?: string[]

Property Value

string[]

migrateRoles

To migrate roles and permissions we need to send this flag as True

migrateRoles?: string

Property Value

string

migrationMode

There are two types of migration modes Online and Offline

migrationMode?: string

Property Value

string

migrationWindowStartTimeInUtc

Start time in UTC for migration window

migrationWindowStartTimeInUtc?: Date

Property Value

Date

overwriteDbsInTarget

Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists.

overwriteDbsInTarget?: string

Property Value

string

secretParameters

Migration secret parameters

secretParameters?: MigrationSecretParameters

Property Value

MigrationSecretParameters

setupLogicalReplicationOnSourceDbIfNeeded

Indicates whether to setup LogicalReplicationOnSourceDb, if needed

setupLogicalReplicationOnSourceDbIfNeeded?: string

Property Value

string

sourceDbServerFullyQualifiedDomainName

Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection

sourceDbServerFullyQualifiedDomainName?: string

Property Value

string

sourceDbServerResourceId

ResourceId of the source database server

sourceDbServerResourceId?: string

Property Value

string

startDataMigration

Indicates whether the data migration should start right away

startDataMigration?: string

Property Value

string

tags

Application-specific metadata in the form of key-value pairs.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

targetDbServerFullyQualifiedDomainName

Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection

targetDbServerFullyQualifiedDomainName?: string

Property Value

string

triggerCutover

To trigger cutover for entire migration we need to send this flag as True

triggerCutover?: string

Property Value

string