Create a PostgreSQL server and configure a vNet rule using the Azure CLI
APPLIES TO: Azure Database for PostgreSQL - Single Server Azure Database for PostgreSQL - Flexible Server
This sample CLI script creates an Azure Database for PostgreSQL server and configures a vNet rule.
If you don't have an Azure subscription, create an Azure free account before you begin.
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.
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'
For more information, see set active subscription or log in interactively
Run the script
# Create a PostgreSQL server and configure a vNet rule # Variable block let "randomIdentifier=$RANDOM*$RANDOM" location="East US" resourceGroup="msdocs-postgresql-rg-$randomIdentifier" tag="create-postgresql-server" server="msdocs-postgresql-server-$randomIdentifier" sku="GP_Gen5_2" vNet="vNet-$randomIdentifier" vNetAddressPrefix="10.0.0.0/16" subnet="subnet-$randomIdentifier" subnetAddressPrefix="10.0.1.0/24" rule="rule-$randomIdentifier" 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 # Get available service endpoints for Azure region output is JSON echo "List of available service endpoints for $location" az network vnet list-endpoint-services --location "$location" # Add Azure SQL service endpoint to a subnet while creating the virtual network echo "Adding service endpoint to $subnet in $vNet" az network vnet create --resource-group $resourceGroup --name $vNet --address-prefixes $vNetAddressPrefix --location "$location" # Creates the service endpoint echo "Creating a service endpoint to $subnet in $vNet" az network vnet subnet create --resource-group $resourceGroup --name $subnet --vnet-name $vNet --address-prefix $subnetAddressPrefix --service-endpoints Microsoft.SQL # View service endpoints configured on a subnet echo "Viewing the service endpoint to $subnet in $vNet" az network vnet subnet show --resource-group $resourceGroup --name $subnet --vnet-name $vNet # Create a VNet rule on the server to secure it to the subnet # Note: resource group (-g) parameter is where the database exists. # VNet resource group if different should be specified using subnet id (URI) instead of subnet, VNet pair. echo "Creating a VNet rule on $server to secure it to $subnet in $vNet" az postgres server vnet-rule create --name $rule --resource-group $resourceGroup --server $server --vnet-name $vNet --subnet $subnet
Clean up resources
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 postgresql server create||Creates a PostgreSQL server that hosts the databases.|
|az network vnet list-endpoint-services||List which services support VNET service tunneling in a given region.|
|az network vnet create||Creates a virtual network.|
|az network vnet subnet create||Create a subnet and associate an existing NSG and route table.|
|az network vnet subnet show||Shows details of a subnet.|
|az postgresql server vnet-rule create||Create a virtual network rule to allows access to a PostgreSQL server.|
|az group delete||Deletes a resource group including all nested resources.|
- Read more information on the Azure CLI: Azure CLI documentation.
- Try additional scripts: Azure CLI samples for Azure Database for PostgreSQL
Submit and view feedback for