Share via

MigrationResource interface

Package:
@azure/arm-postgresql-flexible

Represents a migration resource.

Extends
TrackedResource

Properties

cancel

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

Current status of migration NOTE: This property will not be serialized. It can only be populated by the server.
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
migrationId

ID for migration, a GUID. NOTE: This property will not be serialized. It can only be populated by the server.
migrationInstanceResourceId

ResourceId of the private endpoint migration instance
migrationMode

There are two types of migration modes Online and Offline
migrationOption

This indicates the supported Migration option for the migration
migrationWindowEndTimeInUtc

End time in UTC for migration window
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
sourceDbServerMetadata

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

ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username
sourceType

migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, or EDB
sslMode

SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types
startDataMigration

Indicates whether the data migration should start right away
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
targetDbServerMetadata

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

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

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

Inherited Properties

id

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.
location

The geo-location where the resource lives
name

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

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

Resource tags.
type

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.

Property Details

cancel

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

cancel?: string

Property Value

string

currentStatus

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

currentStatus?: MigrationStatus

Property Value

MigrationStatus

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

migrationId

ID for migration, a GUID. NOTE: This property will not be serialized. It can only be populated by the server.

migrationId?: string

Property Value

string

migrationInstanceResourceId

ResourceId of the private endpoint migration instance

migrationInstanceResourceId?: string

Property Value

string

migrationMode

There are two types of migration modes Online and Offline

migrationMode?: string

Property Value

string

migrationOption

This indicates the supported Migration option for the migration

migrationOption?: string

Property Value

string

migrationWindowEndTimeInUtc

End time in UTC for migration window

migrationWindowEndTimeInUtc?: Date

Property Value

Date

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

sourceDbServerMetadata

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

sourceDbServerMetadata?: DbServerMetadata

Property Value

DbServerMetadata

sourceDbServerResourceId

ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username

sourceDbServerResourceId?: string

Property Value

string

sourceType

migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, or EDB

sourceType?: string

Property Value

string

sslMode

SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types

sslMode?: string

Property Value

string

startDataMigration

Indicates whether the data migration should start right away

startDataMigration?: string

Property Value

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

targetDbServerMetadata

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

targetDbServerMetadata?: DbServerMetadata

Property Value

DbServerMetadata

targetDbServerResourceId

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

targetDbServerResourceId?: string

Property Value

string

triggerCutover

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

triggerCutover?: string

Property Value

string

Inherited Property Details

id

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

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 NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

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

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

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

string

Inherited From TrackedResource.type