Stop-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 .
Cancels an active migration.
Syntax
Cancel (Default)
Stop-AzPostgreSqlFlexibleServerMigration
-Name <String>
-ResourceGroupName <String>
-ServerName <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CancelViaIdentityFlexibleServer
Stop-AzPostgreSqlFlexibleServerMigration
-Name <String>
-FlexibleServerInputObject <IPostgreSqlFlexibleServerIdentity>
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CancelViaIdentity
Stop-AzPostgreSqlFlexibleServerMigration
-InputObject <IPostgreSqlFlexibleServerIdentity>
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Cancels an active migration.
Examples
Example 1: Cancel an active migration in a flexible server
Stop-AzPostgreSqlFlexibleServerMigration -SubscriptionId aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e -ResourceGroupName example-resource-group -ServerName server-name -Name example-migration
AdminCredentialsSourceServerPassword :
AdminCredentialsTargetServerPassword :
Cancel :
CurrentStatusError :
CurrentStatusState : InProgress
CurrentSubStateDetailCurrentSubState : PerformingPreRequisiteSteps
CurrentSubStateDetailDbDetail : {
}
DbsToCancelMigrationOn :
DbsToMigrate : {example-database}
DbsToTriggerCutoverOn :
Id : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/example-resource-group/providers/Microsoft.DBforPostgreSQL/flexibleServers/example-server/migrations/example-migration
InstanceResourceId :
Location : Canada Central
MigrateRole : False
MigrationId : 00000000-0000-0000-0000-000000000000
Mode : Offline
Name : example-migration
Option : ValidateAndMigrate
OverwriteDbsInTarget : True
ResourceGroupName : example-resource-group
SecretParameterSourceServerUsername :
SecretParameterTargetServerUsername :
SetupLogicalReplicationOnSourceDbIfNeeded : True
SourceDbServerFullyQualifiedDomainName :
SourceDbServerMetadataLocation :
SourceDbServerMetadataSkuName :
SourceDbServerMetadataSkuTier :
SourceDbServerMetadataStorageMb :
SourceDbServerMetadataVersion :
SourceDbServerResourceId : example-server.postgres.database.azure.com:5432@example-administrator-login
SourceType : OnPremises
SslMode : Prefer
StartDataMigration :
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Tag : {
}
TargetDbServerFullyQualifiedDomainName :
TargetDbServerMetadataLocation : example-location
TargetDbServerMetadataSkuName : Standard_D4ads_v5
TargetDbServerMetadataSkuTier : GeneralPurpose
TargetDbServerMetadataStorageMb : 131072
TargetDbServerMetadataVersion : 18
TargetDbServerResourceId : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/example-resource-group/providers/Microsoft.DBforPostgreSQL/flexibleServers/example-migration
TriggerCutover : True
Type : Microsoft.DBforPostgreSQL/flexibleServers/migrations
ValidationDetailDbLevelValidationDetail :
ValidationDetailServerLevelValidationDetail :
ValidationDetailStatus :
ValidationDetailValidationEndTimeInUtc :
ValidationDetailValidationStartTimeInUtc :
WindowEndTimeInUtc :
WindowStartTimeInUtc : 3/22/2026 6:16:56 PM
Cancels an active migration in an Azure Database for PostgreSQL flexible server with migration name, server name, and subscription explicitly passed as arguments.
If subscription is not passed explicitly, it's taken from default context.
Parameters
-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
-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
CancelViaIdentityFlexibleServer
Position: Named Mandatory: True Value from pipeline: True 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
CancelViaIdentity
Position: Named Mandatory: True Value from pipeline: True 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
Cancel
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CancelViaIdentityFlexibleServer
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PassThru
Returns true when the command succeeds
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
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
Cancel
Position: Named Mandatory: True 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
Cancel
Position: Named Mandatory: True 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
Cancel
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
