Migration interface

Properties of a migration.

Extends

Properties

cancel

Indicates if cancel must be triggered for the entire migration.

currentStatus

Current status of a 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.

migrationId

Identifier of a migration.

migrationInstanceResourceId

Identifier of the private endpoint migration instance.

migrationMode

Mode used to perform the migration: Online or Offline.

migrationOption

Supported option for a migration.

migrationWindowEndTimeInUtc

End time (UTC) for migration window.

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.

sourceDbServerMetadata

Metadata of source database 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.

sourceType

Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL

sslMode

SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.

startDataMigration

Indicates if data migration must start right away.

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.

targetDbServerMetadata

Metadata of target database server.

targetDbServerResourceId

Identifier of the target database server resource.

triggerCutover

Indicates if cutover must be triggered for the entire migration.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

The geo-location where the resource lives

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

Resource tags.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

cancel

Indicates if cancel must be triggered for the entire migration.

cancel?: string

Property Value

string

currentStatus

Current status of a migration.

currentStatus?: MigrationStatus

Property Value

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

migrationId

Identifier of a migration.

migrationId?: string

Property Value

string

migrationInstanceResourceId

Identifier of the private endpoint migration instance.

migrationInstanceResourceId?: string

Property Value

string

migrationMode

Mode used to perform the migration: Online or Offline.

migrationMode?: string

Property Value

string

migrationOption

Supported option for a migration.

migrationOption?: string

Property Value

string

migrationWindowEndTimeInUtc

End time (UTC) for migration window.

migrationWindowEndTimeInUtc?: Date

Property Value

Date

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?: MigrationSecretParameters

Property Value

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

sourceDbServerMetadata

Metadata of source database server.

sourceDbServerMetadata?: DbServerMetadata

Property Value

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

sourceType

Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL

sourceType?: string

Property Value

string

sslMode

SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.

sslMode?: string

Property Value

string

startDataMigration

Indicates if data migration must start right away.

startDataMigration?: string

Property Value

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

targetDbServerMetadata

Metadata of target database server.

targetDbServerMetadata?: DbServerMetadata

Property Value

targetDbServerResourceId

Identifier of the target database server resource.

targetDbServerResourceId?: string

Property Value

string

triggerCutover

Indicates if cutover must be triggered for the entire migration.

triggerCutover?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type