Migrate offline, from an Azure VM or an on-premises PostgreSQL server to Azure Database for PostgreSQL, with the migration service

This article guides you using the Azure portal to migrate your PostgreSQL database from an Azure VM or an on-premises PostgreSQL server to an Azure Database for PostgreSQL. The Azure portal allows you to perform various tasks, including database migration. Following the steps outlined in this tutorial, you can seamlessly transfer your database to Azure and take advantage of its powerful features and scalability.

The migration service comes with a simple, wizard-based experience on the Azure portal.

Using the Azure portal:

1. Select your Azure Database for PostgreSQL flexible server.

2. In the resource menu, select Migration.

   

3. Select Create to go through a wizard-based series of tabs to perform a migration to a flexible server from on-premises or Azure VM.

   Note

   The first time you use the migration service, an empty grid appears with a prompt to begin your first migration.

   If migrations to your flexible server target have already been created, the grid now contains information about attempted migrations.

   

You need to provide multiple details related to the migration, like the migration name, source server type, option, and mode.

• Migration name is the unique identifier for each migration to this flexible server target. This field accepts only alphanumeric characters and doesn't accept any special characters except a hyphen (-). The name can't start with a hyphen and should be unique for a target server. No two migrations to the same flexible server target can have the same name.

• Source server type - Depending on your PostgreSQL source, you can select Azure Virtual Machine or On-premise server.

• Migration option - Allows you to perform validations before triggering a migration. You can pick any of the following options:

  • Validate - Checks your server and database readiness for migration to the target.
  • Validate and migrate — Performs validation before triggering a migration. If there are no validation failures, the migration is initiated.

Choosing the Validate or Validate and migrate option is always a good practice for performing premigration validations before running the migration.

To learn more about the premigration validation, visit premigration.

• Migration mode allows you to pick the mode for the migration. Offline is the default option. In this case, we'll use the default.

Select Next: Runtime server.

The migration runtime server is a specialized feature within the migration service in Azure Database for PostgreSQL, designed to act as an intermediary server during migration. It's a separate Azure Database for PostgreSQL flexible server instance that isn't the target server, but is used to facilitate the migration of databases from a source environment that is only accessible via a private network.

For more information about the runtime server, visit Migration runtime server.

The Source server tab prompts you to give details related to the source selected in the Setup tab, which is the source of the databases.

• Server name - Provide the name of the host or the IP address of the source PostgreSQL server.
• Port - Port number of the source server.
• Administrator login - Name of the administrator user of the source PostgreSQL server.
• Password - Password of the administrator login provided to connect to source PostgreSQL server.
• SSL mode - Supported values are preferred and required. When the SSL at the source PostgreSQL server is OFF, use prefer. If the SSL at the source server is ON, use the require. SSL values can be determined in postgresql.conf file of the source server.
• Test connection — Performs the connectivity test between the target and source. Once the connection is successful, you can proceed to the next tab. These test aims to identify any connectivity issues that might exist between the target and source servers, including verification of authentication using the credentials supplied. Establishing a test connection takes a few seconds.

After the successful test connection, select Next: Target server.

The Target server tab displays metadata for the flexible server target, such as the subscription name, resource group, server name, location, and PostgreSQL version.

• Administrator login - Name of the administrator user of the target PostgreSQL server.
• Password - Password of the administrator login provided to connect to target PostgreSQL server.
• Custom FQDN or IP address: The custom FQDN or IP address field is optional, and can be used when the target is behind a custom DNS server or has custom DNS namespaces, making it accessible only via specific FQDNs or IP addresses. For example, this could include entries like production-flexible-server.example.com, 198.1.0.2, or a PostgreSQL FQDN such as production-flexible-server.postgres.database.azure.com, if the custom DNS server contains the DNS zone postgres.database.azure.com or forward queries for this zone to 168.63.129.16, where the FQDN is resolved in the Azure public or private DNS zone.
• Test connection — Performs the connectivity test between the source and target. Once the connection is successful, you can proceed to the next tab. These test aims to identify any connectivity issues that might exist between the source and target servers, including verification of authentication using the credentials supplied. Establishing a test connection takes a few seconds.

After the successful test connection, select the Next: Databases to validate or migrate

Under the Databases to validate or migrate tab, you can choose a list of user databases to migrate from your source PostgreSQL server.

After selecting the databases, select Next: Summary.

The Summary tab summarizes all the source and target details for creating the validation or migration. Review the details and select Start validation and migration.

You can cancel any ongoing validations or migrations. The workflow must be in the In progress status so that it can be canceled. You can't cancel a validation or migration in the Succeeded or Failed state.

• Canceling a validation stops further validation activity, and the validation moves to a Canceled state.
• Canceling a migration stops further migration activity on your target server and moves to a Canceled state. The cancel action returns all changes the migration service makes on your target server.

This article explores using the Azure CLI to migrate your PostgreSQL database from an Azure virtual machine or an on-premises PostgreSQL instance to an Azure Database for PostgreSQL. The Azure CLI provides a powerful and flexible command-line interface that allows you to perform various tasks, including database migration. Following the steps outlined in this article, you can seamlessly transfer your database to Azure and take advantage of its powerful features and scalability.

To learn more about Azure CLI with the migration service, visit How to set up Azure CLI for the migration service.

Once the CLI is installed, open the command prompt and log into your Azure account using the below command.

az login

To begin the migration, create a JSON file with the migration details. The JSON file contains the following information:

• Edit the below placeholders << >> in the JSON lines and store them in the local machine as <<filename>>.json where the CLI is being invoked. In this tutorial, we have saved the file in c:/migration-CLI/migration_body.json

{
"properties": {
"SourceDBServerResourceId": "<<source-server-hostname-or-IP-address>>:<<port>>@<<username>>",
        "SecretParameters": {
            "AdminCredentials": {
                "SourceServerPassword": "<<source-server-administrator-password>>",
                "TargetServerPassword": "<<target-server-administrator-password>>"
            },
            "targetServerUserName": "<<target-server-administrator-login>>"
        },
        "DBsToMigrate": "<<comma-separated-list-of-databases-in-array-like-["ticketdb","timedb","inventorydb"]>>",
        "OverwriteDBsInTarget": "true",
        "sourceType": "OnPremises",
        "sslMode": "Prefer"
    }
}

• Run the following command to check if any migrations are running. The migration name is unique across the migrations within the Azure Database for PostgreSQL flexible server target.

  az postgres flexible-server migration list --subscription <subscription_id> --resource-group <resource_group> --name <target_server> --filter all
  

• In the above steps, there are no migrations performed so we start with the new migration by running the following command.

  az postgres flexible-server migration create --subscription <subscription_id> --resource-group <resource_group> --name <target_server> --migration-name <migration> --migration-mode offline --migration-option ValidateAndMigrate --properties "c:/migration-cli/migration_body.json"
  

• Run the following command to see the status of the migration initiated in the previous step. You can check the status of the migration by providing the migration name.

  az postgres flexible-server migration show --subscription <subscription_id> --resource-group <resource_group> --name <target_server> --migration-name <migration>
  

• The progress and status of the migration is shown in Azure CLI.

• You can also see the progress and status in Azure portal.

• You can cancel any ongoing migration attempts using the cancel command. This command stops the particular migration attempt, and rolls back all changes that it could have made on your target server. Following is the CLI command to cancel migration that has an "In progress" status.

  az postgres flexible-server migration update cancel --subscription <subscription_id> --resource-group <resource_group> --name <target_server> --migration-name <migration>