Migration interface

Indicates if cancel must be triggered for the entire migration.

cancel?: string

Property Value

Current status of a migration. NOTE: This property will not be serialized. It can only be populated by the server.

currentStatus?: MigrationStatus

Property Value

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

Names of databases to migrate.

dbsToMigrate?: string[]

Property Value

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

Indicates if roles and permissions must be migrated.

migrateRoles?: string

Property Value

Identifier of a migration. NOTE: This property will not be serialized. It can only be populated by the server.

migrationId?: string

Property Value

Identifier of the private endpoint migration instance.

migrationInstanceResourceId?: string

Property Value

Mode used to perform the migration: Online or Offline.

migrationMode?: string

Property Value

Supported option for a migration.

migrationOption?: string

Property Value

End time (UTC) for migration window.

migrationWindowEndTimeInUtc?: Date

Property Value

Start time (UTC) for migration window.

migrationWindowStartTimeInUtc?: Date

Property Value

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

Migration secret parameters.

secretParameters?: MigrationSecretParameters

Property Value

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

setupLogicalReplicationOnSourceDbIfNeeded?: string

Property Value

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

Metadata of source database server. NOTE: This property will not be serialized. It can only be populated by the server.

sourceDbServerMetadata?: DbServerMetadata

Property Value

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

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

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

Indicates if data migration must start right away.

startDataMigration?: string

Property Value

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

Metadata of target database server. NOTE: This property will not be serialized. It can only be populated by the server.

targetDbServerMetadata?: DbServerMetadata

Property Value

Identifier of the target database server resource. NOTE: This property will not be serialized. It can only be populated by the server.

targetDbServerResourceId?: string

Property Value

Indicates if cutover must be triggered for the entire migration.

triggerCutover?: string

Property Value

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

Inherited From TrackedResource.id

The geo-location where the resource lives

location: string

Property Value

Inherited From TrackedResource.location

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

Inherited From TrackedResource.name

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

Inherited From TrackedResource.systemData

Resource tags.

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

Property Value

Inherited From TrackedResource.tags

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

Inherited From TrackedResource.type