New-AzPostgreSqlFlexibleServerMigration
This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus .
Syntax
CreateExpanded (Default)
New-AzPostgreSqlFlexibleServerMigration
-Name <String>
-ResourceGroupName <String>
-ServerName <String>
-Location <String>
[-SubscriptionId <String>]
[-AdminCredentialsSourceServerPassword <SecureString>]
[-AdminCredentialsTargetServerPassword <SecureString>]
[-Cancel <String>]
[-DbsToCancelMigrationOn <String[]>]
[-DbsToMigrate <String[]>]
[-DbsToTriggerCutoverOn <String[]>]
[-MigrateRole <String>]
[-MigrationInstanceResourceId <String>]
[-MigrationMode <String>]
[-MigrationOption <String>]
[-MigrationWindowEndTimeInUtc <DateTime>]
[-MigrationWindowStartTimeInUtc <DateTime>]
[-OverwriteDbsInTarget <String>]
[-SecretParameterSourceServerUsername <String>]
[-SecretParameterTargetServerUsername <String>]
[-SetupLogicalReplicationOnSourceDbIfNeeded <String>]
[-SourceDbServerFullyQualifiedDomainName <String>]
[-SourceDbServerResourceId <String>]
[-SourceType <String>]
[-SslMode <String>]
[-StartDataMigration <String>]
[-Tag <Hashtable>]
[-TargetDbServerFullyQualifiedDomainName <String>]
[-TriggerCutover <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonString
New-AzPostgreSqlFlexibleServerMigration
-Name <String>
-ResourceGroupName <String>
-ServerName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonFilePath
New-AzPostgreSqlFlexibleServerMigration
-Name <String>
-ResourceGroupName <String>
-ServerName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentityFlexibleServerExpanded
New-AzPostgreSqlFlexibleServerMigration
-Name <String>
-FlexibleServerInputObject <IPostgreSqlFlexibleServerIdentity>
-Location <String>
[-AdminCredentialsSourceServerPassword <SecureString>]
[-AdminCredentialsTargetServerPassword <SecureString>]
[-Cancel <String>]
[-DbsToCancelMigrationOn <String[]>]
[-DbsToMigrate <String[]>]
[-DbsToTriggerCutoverOn <String[]>]
[-MigrateRole <String>]
[-MigrationInstanceResourceId <String>]
[-MigrationMode <String>]
[-MigrationOption <String>]
[-MigrationWindowEndTimeInUtc <DateTime>]
[-MigrationWindowStartTimeInUtc <DateTime>]
[-OverwriteDbsInTarget <String>]
[-SecretParameterSourceServerUsername <String>]
[-SecretParameterTargetServerUsername <String>]
[-SetupLogicalReplicationOnSourceDbIfNeeded <String>]
[-SourceDbServerFullyQualifiedDomainName <String>]
[-SourceDbServerResourceId <String>]
[-SourceType <String>]
[-SslMode <String>]
[-StartDataMigration <String>]
[-Tag <Hashtable>]
[-TargetDbServerFullyQualifiedDomainName <String>]
[-TriggerCutover <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Examples
Example 1: Create a migration from a PostgreSQL server to a flexible server
New-AzPostgreSqlFlexibleServerMigration -ResourceGroupName example-resource-group -ServerName example-target-server -Name example-migration -DbsToMigrate example-database-01,example-database-02 -Location example-location -MigrationMode Offline -MigrationOption Validate -SourceDbServerResourceId example-source-server-fully-qualified-domain-name:example-port@example-user -SourceType OnPremises
AdminCredentialsSourceServerPassword :
AdminCredentialsTargetServerPassword :
Cancel :
CurrentStatusError :
CurrentStatusState : InProgress
CurrentSubStateDetailCurrentSubState :
CurrentSubStateDetailDbDetail : {
}
DbsToCancelMigrationOn :
DbsToMigrate : {daadsdasd, postgres}
DbsToTriggerCutoverOn :
Id : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/example-resource-group/providers/Microsoft.DBforPostgreSQL/flexibleServers/example-target-server/migrations/example-migration
InstanceResourceId :
Location : example-location
MigrateRole :
MigrationId : 00000000-0000-0000-0000-000000000000
Mode : Offline
Name : example-migration
Option : Validate
OverwriteDbsInTarget : True
ResourceGroupName : example-resource-group
SecretParameterSourceServerUsername :
SecretParameterTargetServerUsername :
SetupLogicalReplicationOnSourceDbIfNeeded :
SourceDbServerFullyQualifiedDomainName :
SourceDbServerMetadataLocation :
SourceDbServerMetadataSkuName :
SourceDbServerMetadataSkuTier :
SourceDbServerMetadataStorageMb :
SourceDbServerMetadataVersion :
SourceDbServerResourceId : example-source-server-fully-qualified-domain-name:example-port@example-user
SourceType : OnPremises
SslMode : Prefer
StartDataMigration :
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Tag : {
}
TargetDbServerFullyQualifiedDomainName :
TargetDbServerMetadataLocation :
TargetDbServerMetadataSkuName :
TargetDbServerMetadataSkuTier :
TargetDbServerMetadataStorageMb :
TargetDbServerMetadataVersion :
TargetDbServerResourceId : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/example-resource-group/providers/Microsoft.DBforPostgreSQL/flexibleServers/example-target-server
TriggerCutover : True
Type : Microsoft.DBforPostgreSQL/flexibleServers/migrations
ValidationDetailDbLevelValidationDetail :
ValidationDetailServerLevelValidationDetail :
ValidationDetailStatus :
ValidationDetailValidationEndTimeInUtc :
ValidationDetailValidationStartTimeInUtc :
WindowEndTimeInUtc :
WindowStartTimeInUtc : 5/22/2026 9:45:51 AM
Creates a migration from a PostgreSQL server to an Azure Database for PostgreSQL flexible server.
Parameters
-AdminCredentialsSourceServerPassword
Password for the user of the source server.
Parameter properties
Type: SecureString
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AdminCredentialsTargetServerPassword
Password for the user of the target server.
Parameter properties
Type: SecureString
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Cancel
Indicates if cancel must be triggered for the entire migration.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DbsToCancelMigrationOn
When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DbsToMigrate
Names of databases to migrate.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DbsToTriggerCutoverOn
When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity
Default value: None Supports wildcards: False DontShow: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Create operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Create operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
The geo-location where the resource lives
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MigrateRole
Indicates if roles and permissions must be migrated.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MigrationInstanceResourceId
Identifier of the private endpoint migration instance.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MigrationMode
Mode used to perform the migration: Online or Offline.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MigrationOption
Supported option for a migration.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MigrationWindowEndTimeInUtc
End time (UTC) for migration window.
Parameter properties
Type: DateTime
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MigrationWindowStartTimeInUtc
Start time (UTC) for migration window.
Parameter properties
Type: DateTime
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of migration.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: MigrationName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SecretParameterSourceServerUsername
Gets or sets the name of the user for the source server.
This user doesn't need to be an administrator.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SecretParameterTargetServerUsername
Gets or sets the name of the user for the target server.
This user doesn't need to be an administrator.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ServerName
The name of the server.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SetupLogicalReplicationOnSourceDbIfNeeded
Indicates whether to setup logical replication on source server, if needed.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SslMode
SSL mode used by a migration.
Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'.
Default SSL mode for other source types is 'Prefer'.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-StartDataMigration
Indicates if data migration must start right away.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
The value must be an UUID.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonFilePath
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Resource tags.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TriggerCutover
Indicates if cutover must be triggered for the entire migration.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityFlexibleServerExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity
Outputs
Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigration
