Manage an Azure Database for PostgreSQL Single server using the Azure CLI

APPLIES TO: Azure Database for PostgreSQL - Single Server

This article shows you how to manage your Single servers deployed in Azure. Management tasks include compute and storage scaling, admin password reset, and viewing server details.

Prerequisites

If you don't have an Azure subscription, create a free account before you begin. This article requires that you're running the Azure CLI version 2.0 or later locally. To see the version installed, run the az --version command. If you need to install or upgrade, see Install Azure CLI.

You'll need to log in to your account using the az login command. Note the id property, which refers to Subscription ID for your Azure account.

az login

Select the specific subscription under your account using az account set command. Make a note of the id value from the az login output to use as the value for subscription argument in the command. If you have multiple subscriptions, choose the appropriate subscription in which the resource should be billed. To get all your subscription, use az account list.

az account set --subscription <subscription id>

If you have not already created a server, refer to this quickstart to create one.

Azure Cloud Shell

Azure hosts Azure Cloud Shell, an interactive shell environment that you can use through your browser. You can use either Bash or PowerShell with Cloud Shell to work with Azure services. You can use the Cloud Shell preinstalled commands to run the code in this article, without having to install anything on your local environment.

To start Azure Cloud Shell:

Option Example/Link
Select Try It in the upper-right corner of a code or command block. Selecting Try It doesn't automatically copy the code or command to Cloud Shell. Screenshot that shows an example of Try It for Azure Cloud Shell.
Go to https://shell.azure.com, or select the Launch Cloud Shell button to open Cloud Shell in your browser. Screenshot that shows how to launch Cloud Shell in a new window.
Select the Cloud Shell button on the menu bar at the upper right in the Azure portal. Screenshot that shows the Cloud Shell button in the Azure portal

To use Azure Cloud Shell:

  1. Start Cloud Shell.

  2. Select the Copy button on a code block (or command block) to copy the code or command.

  3. Paste the code or command into the Cloud Shell session by selecting Ctrl+Shift+V on Windows and Linux, or by selecting Cmd+Shift+V on macOS.

  4. Select Enter to run the code or command.

Scale compute and storage

You can scale up your pricing tier, compute, and storage easily using the following command. You can see all the server operation you can perform az postgres server overview

az postgres server update --resource-group myresourcegroup --name mydemoserver --sku-name GP_Gen5_4 --storage-size 6144

Here are the details for arguments above:

Setting Sample value Description
name mydemoserver Enter a unique name for your Azure Database for PostgreSQL server. The server name can contain only lowercase letters, numbers, and the hyphen (-) character. It must contain from 3 to 63 characters.
resource-group myresourcegroup Provide the name of the Azure resource group.
sku-name GP_Gen5_2 Enter the name of the pricing tier and compute configuration. Follows the convention {pricing tier}{compute generation}{vCores} in shorthand. See the pricing tiers for more information.
storage-size 6144 The storage capacity of the server (unit is megabytes). Minimum 5120 and increases in 1024 increments.

Important

  • Storage can be scaled up (however, you cannot scale storage down)
  • Scaling up from Basic to General purpose or Memory optimized pricing tier is not supported. You can manually scale up with either using a bash script or using PostgreSQL Workbench

Manage PostgreSQL databases on a server.

You can use any of these commands to create, delete, list, and view database properties of a database on your server

Cmdlet Usage Description
az postgres db create az postgres db create -g myresourcegroup -s mydemoserver -n mydatabasename Creates a database
az postgres db delete az postgres db delete -g myresourcegroup -s mydemoserver -n mydatabasename Delete your database from your server. This command does not delete your server.
az postgres db list az postgres db list -g myresourcegroup -s mydemoserver lists all the databases on the server
az postgres db show az postgres db show -g myresourcegroup -s mydemoserver -n mydatabasename Shows more details of the database

Update admin password

You can change the administrator role's password with this command

az postgres server update --resource-group myresourcegroup --name mydemoserver --admin-password <new-password>

Important

Make sure password is minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters.

Delete a server

If you would just like to delete the PostgreSQL Single server, you can run az postgres server delete command.

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

Next steps