Quickstart: Create an Azure Database for PostgreSQL server by using the Azure CLI

This quickstart shows how to use Azure CLI commands in Azure Cloud Shell to create a single Azure Database for PostgreSQL server in five minutes. If you don't have an Azure subscription, create a free account before you begin.

Prerequisites

• Use the Bash environment in Azure Cloud Shell.

  

• If you prefer, install the Azure CLI to run CLI reference commands.

  • If you're using a local installation, sign in to the Azure CLI by using the az login command. To finish the authentication process, follow the steps displayed in your terminal. For additional sign-in options, see Sign in with the Azure CLI.

  • When you're prompted, install Azure CLI extensions on first use. For more information about extensions, see Use extensions with the Azure CLI.

  • Run az version to find the version and dependent libraries that are installed. To upgrade to the latest version, run az upgrade.

• This article requires version 2.0 or later of the Azure CLI. If using Azure Cloud Shell, the latest version is already installed.

  Tip

  Consider using the simpler az postgres up Azure CLI command that's currently in preview. Try out the quickstart.

• Select the specific subscription ID under your account by using the az account set command.

  • Make a note of the id value from the az login output to use as the value for the subscription argument in the command.

    az account set --subscription <subscription id>
    

  • If you have multiple subscriptions, choose the appropriate subscription in which the resource should be billed. To get all your subscriptions, use az account list.

Create an Azure Database for PostgreSQL server

Create an Azure resource group by using the az group create command, and then create your PostgreSQL server inside this resource group. You should provide a unique name. The following example creates a resource group named myresourcegroup in the westus location.

az group create --name myresourcegroup --location westus

Create an Azure Database for PostgreSQL server by using the az postgres server create command. A server can contain multiple databases.

az postgres server create --resource-group myresourcegroup --name mydemoserver  --location westus --admin-user myadmin --admin-password <server_admin_password> --sku-name GP_Gen5_2 

Here are the details for the preceding arguments:

Configure a server-level firewall rule

By default, the server that you created is not publicly accessible and is protected with firewall rules. You can configure the firewall rules on your server by using the az postgres server firewall-rule create command to give your local environment access to connect to the server.

The following example creates a firewall rule called AllowMyIP that allows connections from a specific IP address, 192.168.0.1. Replace the IP address or range of IP addresses that corresponds to where you'll be connecting from. If you don't know your IP address, go to WhatIsMyIPAddress.com to get it.

az postgres server firewall-rule create --resource-group myresourcegroup --server mydemoserver --name AllowMyIP --start-ip-address 192.168.0.1 --end-ip-address 192.168.0.1

Get the connection information

To connect to your server, provide host information and access credentials.

az postgres server show --resource-group myresourcegroup --name mydemoserver

The result is in JSON format. Make a note of the administratorLogin and fullyQualifiedDomainName values.

{
  "administratorLogin": "myadmin",
  "earliestRestoreDate": null,
  "fullyQualifiedDomainName": "mydemoserver.postgres.database.azure.com",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.DBforPostgreSQL/servers/mydemoserver",
  "location": "westus",
  "name": "mydemoserver",
  "resourceGroup": "myresourcegroup",
  "sku": {
    "capacity": 2,
    "family": "Gen5",
    "name": "GP_Gen5_2",
    "size": null,
    "tier": "GeneralPurpose"
  },
  "sslEnforcement": "Enabled",
  "storageProfile": {
    "backupRetentionDays": 7,
    "geoRedundantBackup": "Disabled",
    "storageMb": 5120
  },
  "tags": null,
  "type": "Microsoft.DBforPostgreSQL/servers",
  "userVisibleState": "Ready",
  "version": "9.6"
}

Connect to the Azure Database for PostgreSQL server by using psql

The psql client is a popular choice for connecting to PostgreSQL servers. You can connect to your server by using psql with Azure Cloud Shell. You can also use psql on your local environment if you have it available. An empty database, postgres, is automatically created with a new PostgreSQL server. You can use that database to connect with psql, as shown in the following code.

psql --host=mydemoserver.postgres.database.azure.com --port=5432 --username=myadmin@mydemoserver --dbname=postgres

psql postgresql://myadmin%40mydemoserver@mydemoserver.postgres.database.azure.com:5432/postgres

Clean up resources

If you don't need these resources for another quickstart or tutorial, you can delete them by running the following command.

az group delete --name myresourcegroup

If you just want to delete the one newly created server, you can run the az postgres server delete command.

az postgres server delete --resource-group myresourcegroup --name mydemoserver

Next steps