Share via

MigrationResourceForPatch interface

Package:
@azure/arm-postgresql-flexible

Migration.

Properties

cancel

Indicates if cancel must be triggered for the entire migration.
dbsToCancelMigrationOn

When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.
dbsToMigrate

Names of databases to migrate.
dbsToTriggerCutoverOn

When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.
migrateRoles

Indicates if roles and permissions must be migrated.
migrationMode

Mode used to perform the migration: Online or Offline.
migrationWindowStartTimeInUtc

Start time (UTC) for migration window.
overwriteDbsInTarget

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

Migration secret parameters.
setupLogicalReplicationOnSourceDbIfNeeded

Indicates whether to setup logical replication on source server, if needed.
sourceDbServerFullyQualifiedDomainName

Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server.
sourceDbServerResourceId

Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username.
startDataMigration

Indicates if data migration must start right away.
tags

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

Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server.
triggerCutover

Indicates if cutover must be triggered for the entire migration.

Property Details

cancel

Indicates if cancel must be triggered for the entire migration.

cancel?: string

Property Value

string

dbsToCancelMigrationOn

When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.

dbsToCancelMigrationOn?: string[]

Property Value

string[]

dbsToMigrate

Names of databases to migrate.

dbsToMigrate?: string[]

Property Value

string[]

dbsToTriggerCutoverOn

When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.

dbsToTriggerCutoverOn?: string[]

Property Value

string[]

migrateRoles

Indicates if roles and permissions must be migrated.

migrateRoles?: string

Property Value

string

migrationMode

Mode used to perform the migration: Online or Offline.

migrationMode?: string

Property Value

string

migrationWindowStartTimeInUtc

Start time (UTC) for migration window.

migrationWindowStartTimeInUtc?: Date

Property Value

Date

overwriteDbsInTarget

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

overwriteDbsInTarget?: string

Property Value

string

secretParameters

Migration secret parameters.

secretParameters?: MigrationSecretParametersForPatch

Property Value

MigrationSecretParametersForPatch

setupLogicalReplicationOnSourceDbIfNeeded

Indicates whether to setup logical replication on source server, if needed.

setupLogicalReplicationOnSourceDbIfNeeded?: string

Property Value

string

sourceDbServerFullyQualifiedDomainName

Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server.

sourceDbServerFullyQualifiedDomainName?: string

Property Value

string

sourceDbServerResourceId

Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username.

sourceDbServerResourceId?: string

Property Value

string

startDataMigration

Indicates if data migration must 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

Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server.

targetDbServerFullyQualifiedDomainName?: string

Property Value

string

triggerCutover

Indicates if cutover must be triggered for the entire migration.

triggerCutover?: string

Property Value

string