List and update configurations of an Azure Database for PostgreSQL - Flexible Server instance using Azure CLI

APPLIES TO: Azure Database for PostgreSQL - Flexible Server

This sample CLI script lists all available configuration parameters as well as their allowable values for Azure Database for PostgreSQL flexible server, and sets the log_retention_days to a value that is other than the default one.

If you don't have an Azure subscription, create an Azure free account before you begin.

Prerequisites

• Use the Bash environment in Azure Cloud Shell. For more information, see Quickstart for Bash in Azure Cloud Shell.

  

• If you prefer to run CLI reference commands locally, install the Azure CLI. If you're running on Windows or macOS, consider running Azure CLI in a Docker container. For more information, see How to run the Azure CLI in a Docker container.

  • 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 other sign-in options, see Sign in with the Azure CLI.

  • When you're prompted, install the Azure CLI extension 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.

Sample script

Launch Azure Cloud Shell

The Azure Cloud Shell is a free interactive shell that you can use to run the steps in this article. It has common Azure tools preinstalled and configured to use with your account.

To open the Cloud Shell, just select Try it from the upper right corner of a code block. You can also launch Cloud Shell in a separate browser tab by going to https://shell.azure.com.

When Cloud Shell opens, verify that Bash is selected for your environment. Subsequent sessions will use Azure CLI in a Bash environment, Select Copy to copy the blocks of code, paste it into the Cloud Shell, and press Enter to run it.

Sign in to Azure

Cloud Shell is automatically authenticated under the initial account signed-in with. Use the following script to sign in using a different subscription, replacing subscriptionId with your Azure subscription ID.

If you don't have an Azure subscription, create an Azure free account before you begin.

subscription="subscriptionId" # Set Azure subscription ID here

az account set -s $subscription # ...or use 'az login'

For more information, see set active subscription or log in interactively.

Run the script

# List and update configurations of an Azure Database for PostgreSQL server

# Variable block
let "randomIdentifier=$RANDOM*$RANDOM"
location="East US"
resourceGroup="msdocs-postgresql-rg-$randomIdentifier"
tag="change-server-cofigurations-postgresql"
server="msdocs-postgresql-server-$randomIdentifier"
sku="GP_Gen5_2"
login="azureuser"
password="Pa$$w0rD-$randomIdentifier"

echo "Using resource group $resourceGroup with login: $login, password: $password..."

# Create a resource group
echo "Creating $resourceGroup in $location..."
az group create --name $resourceGroup --location "$location" --tags $tag

# Create a PostgreSQL server in the resource group
# Name of a server maps to DNS name and is thus required to be globally unique in Azure.
echo "Creating $server in $location..."
az postgres server create --name $server --resource-group $resourceGroup --location "$location" --admin-user $login --admin-password $password --sku-name $sku

# Display all available configurations with valid values of an Azure Database for PostgreSQL server
az postgres server configuration list --resource-group $resourceGroup --server-name $server

# Set value of **log_retention_days**
echo "Setting value of the log_retention_days setting on $server"
az postgres server configuration set --resource-group $resourceGroup --server-name $server --name log_retention_days --value 7

# Check the value of **log_retention_days**
echo "Checking the value of the log_retention_days setting on $server"
az postgres server configuration show --resource-group $resourceGroup --server-name $server --name log_retention_days

Clean up deployment

Use the following command to remove the resource group and all resources associated with it using the az group delete command - unless you have an ongoing need for these resources. Some of these resources may take a while to create, as well as to delete.

az group delete --name $resourceGroup

Sample reference

This script uses the commands outlined in the following table:

Command	Notes
az group create	Creates a resource group in which all resources are stored.
az postgres server create	Creates an Azure Database for PostgreSQL flexible server instance that hosts the databases.
az postgres server configuration list	List the configurations of an Azure Database for PostgreSQL flexible server instance.
az postgres server configuration set	Update the configuration of an Azure Database for PostgreSQL flexible server instance.
az postgres server configuration show	Show the configuration of an Azure Database for PostgreSQL flexible server instance.
az group delete	Deletes a resource group including all nested resources.

Next steps

• Read more information on the Azure CLI: Azure CLI documentation.
• Try additional scripts: Azure CLI samples for Azure Database for PostgreSQL- Flexible Server
• For more information on server parameters, see How to configure server parameters in Azure portal.