Restart an Azure Database for PostgreSQL server using PowerShell

APPLIES TO: Azure Database for PostgreSQL - Single Server

Important

Azure Database for PostgreSQL - Single Server is on the retirement path. We strongly recommend that you upgrade to Azure Database for PostgreSQL - Flexible Server. For more information about migrating to Azure Database for PostgreSQL - Flexible Server, see What's happening to Azure Database for PostgreSQL Single Server?.

This topic describes how you can restart an Azure Database for PostgreSQL server. You may need to restart your server for maintenance reasons, which causes a short outage during the operation.

The server restart is blocked if the service is busy. For example, the service may be processing a previously requested operation such as scaling vCores.

Note

The time required to complete a restart depends on the PostgreSQL recovery process. To decrease the restart time, we recommend that you minimize the amount of activity on the server prior to the restart. You may also want to increase the checkpoint frequency. As well, you can tune checkpoint related parameter values including max_wal_size. It is also recommended to run CHECKPOINT command prior to restarting the server.

Prerequisites

To complete this how-to guide, you need:

• The Az PowerShell module installed locally or Azure Cloud Shell in the browser
• An Azure Database for PostgreSQL server

If you choose to use PowerShell locally, connect to your Azure account using the Connect-AzAccount cmdlet.

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.
Go to https://shell.azure.com, or select the Launch Cloud Shell button to open Cloud Shell in your browser.
Select the Cloud Shell button on the menu bar at the upper right 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.

Restart the server

Enter the following command to restart the server:

Restart-AzPostgreSqlServer -Name mydemoserver -ResourceGroupName myresourcegroup

Next steps

Create an Azure Database for PostgreSQL server using PowerShell