Connect to a cluster in Azure Cosmos DB for PostgreSQL

APPLIES TO: Azure Cosmos DB for PostgreSQL (powered by the Citus database extension to PostgreSQL)

Choose one of the following database clients to see how to configure it to connect to an Azure Cosmos DB for PostgreSQL cluster.

pgAdmin is a popular and feature-rich open source administration and development platform for PostgreSQL.

  1. Download and install pgAdmin.

  2. Open the pgAdmin application on your client computer. From the Dashboard, select Add New Server.

    Screenshot that shows the pgAdmin dashboard.

  3. Choose a Name in the General tab. Any name will work.

    Screenshot that shows the pgAdmin general connection settings.

  4. Enter connection details in the Connection tab.

    Screenshot that shows the pgAdmin connection settings.

    Customize the following fields:

    • Host name/address: Obtain this value from the Overview page for your cluster in the Azure portal. It's listed there as Coordinator name. It will be of the form, c-<clustername>.12345678901234.postgres.cosmos.azure.com.
    • Maintenance database: use the value citus.
    • Username: use the value citus.
    • Password: the connection password or Microsoft Entra ID token. For more information, see authentication options.
    • Save password: enable if desired.
  5. In the SSL tab, set SSL mode to Require.

    Screenshot that shows the pgAdmin SSL settings.

  6. Select Save to save and connect to the database.

Next steps