Monitor and scale a single PostgreSQL server using Azure CLI
APPLIES TO: Azure Database for PostgreSQL - Single Server Azure Database for PostgreSQL - Flexible Server
This sample CLI script scales compute and storage for a single Azure Database for PostgreSQL server after querying the metrics. Compute can scale up or down. Storage can only scale up.
Storage can only be scaled up, not down.
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.
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
<Subscription ID> with your Azure Subscription ID. If you don't have an Azure subscription, create an Azure free account before you begin.
subscription="<subscriptionId>" # add subscription here az account set -s $subscription # ...or use 'az login'
Run the script
# Monitor and scale a single PostgreSQL server # Variable block let "randomIdentifier=$RANDOM*$RANDOM" subscriptionId="$(az account show --query id -o tsv)" location="East US" resourceGroup="msdocs-postgresql-rg-$randomIdentifier" tag="scale-postgresql-server" server="msdocs-postgresql-server-$randomIdentifier" sku="GP_Gen5_2" login="azureuser" password="Pa$$w0rD-$randomIdentifier" scaleUpSku="GP_Gen5_4" scaleDownSku="GP_Gen5_2" storageSize="102400" 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 # Monitor usage metrics - CPU echo "Returning the CPU usage metrics for $server" az monitor metrics list --resource "/subscriptions/$subscriptionId/resourceGroups/$resourceGroup/providers/Microsoft.DBforPostgresql/servers/$server" --metric cpu_percent --interval PT1M # Monitor usage metrics - Storage echo "Returning the storage usage metrics for $server" az monitor metrics list --resource "/subscriptions/$subscriptionId/resourceGroups/$resourceGroup/providers/Microsoft.DBforPostgresql/servers/$server" --metric storage_used --interval PT1M # Scale up the server by provisionining more vCores within the same tier echo "Scaling up $server by changing the SKU to $scaleUpSku" az postgres server update --resource-group $resourceGroup --name $server --sku-name $scaleUpSku # Scale down the server by provisioning fewer vCores within the same tier echo "Scaling down $server by changing the SKU to $scaleDownSku" az postgres server update --resource-group $resourceGroup --name $server --sku-name $scaleDownSku # Scale up the server to provision a storage size of 10GB # Storage size cannot be reduced echo "Scaling up the storage size for $server to $storageSize" az postgres server update --resource-group $resourceGroup --name $server --storage-size $storageSize
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
This script uses the commands outlined in the following table:
|az group create||Creates a resource group in which all resources are stored.|
|az postgres server create||Creates a PostgreSQL server that hosts the databases.|
|az postgres server update||Updates properties of the PostgreSQL server.|
|az monitor metrics list||List the metric value for the resources.|
|az group delete||Deletes a resource group including all nested resources.|
- Learn more about Azure Database for PostgreSQL compute and storage
- Try additional scripts: Azure CLI samples for Azure Database for PostgreSQL
- Learn more about the Azure CLI