PostgreSQLManagementClient

Name: PostgreSQLManagementClient API
Brand: Azure PostgreSQL Management
Availability: InStock

★ Only Publicly Available OpenAPI DocumentStorageDatabaseoauth233 EndpointsREST

For Agents

Provision and manage Azure Database for PostgreSQL servers, databases, firewall and VNet rules, replicas, and server configuration through 33 ARM operations on Microsoft.DBforPostgreSQL.

Connect the PostgreSQLManagementClient to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the PostgreSQLManagementClient, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with PostgreSQLManagementClient API.

Provision Azure Database for PostgreSQL servers with chosen SKU, storage size, and region

Create databases, configure server parameters, and apply firewall and virtual network rules

Set up read replicas to scale read traffic and provide regional failover

Manage Active Directory administrators on a server for AAD-based authentication

GET STARTED

Start building with PostgreSQLManagementClient API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for PostgreSQLManagementClient, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for PostgreSQLManagementClient, keeping it validated and agent-ready. The Azure Database for PostgreSQL management API exposes 33 operations under Microsoft.DBforPostgreSQL for provisioning and managing managed PostgreSQL servers, databases, firewall rules, virtual network rules, replicas, configuration parameters, server administrators, and security alert policies. Use it to spin up a PostgreSQL server in a region, create databases, allow client IPs and VNets, configure server parameters, set up read replicas, and inspect log files at the server level.

Use Cases

Patterns agents use PostgreSQLManagementClient API for, with concrete tasks.

★ Managed PostgreSQL Provisioning

Provision a managed PostgreSQL server for a new application. The flow is: check name availability, list performance tiers, create the server with the chosen SKU and storage size, add firewall rules for application IPs, configure VNet rules for private connectivity, create application-specific databases, and tune key server parameters. The 33 endpoints cover the full provisioning surface so the entire setup completes in a single playbook.

Check availability of name 'app-prod-pg', create a GP_Gen5_2 server in westeurope with 100 GB storage, add a firewall rule for the office IP range, and create database 'app'

Read Replica Scaling

Scale read-heavy workloads by creating PostgreSQL read replicas in the same or another region. Listing replicas under a server returns the full replica topology and their replication state. The replica sits behind its own connection string so the application can route SELECT traffic away from the primary, while writes continue to land on the primary. Cross-region replicas double as warm standby for regional failover.

Create a read replica of server 'app-prod-pg' named 'app-prod-pg-replica1' in northeurope, then list replicas and confirm the replication state

Network Hardening

Lock down PostgreSQL server access to specific IPs and virtual networks. Firewall rules control public IP access at the server level and virtual network rules restrict access to specific subnets in an Azure VNet. An audit query lists every firewall and VNet rule across every PostgreSQL server in the subscription, surfacing rules that are too broad (0.0.0.0/0) or no longer needed.

List firewall rules and virtual network rules on every PostgreSQL server in the subscription, flag rules with start IP 0.0.0.0, and remove flagged rules after operator confirmation

AI Agent Database Operator

An AI agent supporting a platform team can provision and manage PostgreSQL servers through Jentic. The agent searches by intent ('create an azure postgresql server'), Jentic returns the Servers_Create operation with its schema, and the agent executes the call with managed Azure credentials. Replica setup, firewall rule changes, and parameter tuning follow the same intent-driven flow.

Search Jentic for 'create an Azure PostgreSQL server', load the Servers_Create schema, and execute it with the supplied SKU, storage, and region

Key Endpoints

33 endpoints — jentic publishes the only available openapi specification for postgresqlmanagementclient, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability

Check whether a server name is available

GET

/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/servers

List PostgreSQL servers in a subscription

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers

List servers in a resource group

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}

Get a specific PostgreSQL server

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/Replicas

List read replicas of a server

GET

/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/performanceTiers

List performance tiers available in a region

GET

/providers/Microsoft.DBforPostgreSQL/operations

List Microsoft.DBforPostgreSQL operations

POST

/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability

Check whether a server name is available

GET

/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/servers

List PostgreSQL servers in a subscription

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers

List servers in a resource group

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}

Get a specific PostgreSQL server

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/Replicas

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Azure service principal credentials are encrypted in the Jentic vault. Agents receive scoped ARM bearer tokens at execution time and never see the underlying client secret. PostgreSQL admin passwords supplied during create are passed through to ARM and not retained by Jentic.

Intent-based discovery

Agents search by intent ('create an azure postgresql server' or 'add a postgresql firewall rule') and Jentic returns the matching operation, avoiding the need to learn the 33 endpoints under Microsoft.DBforPostgreSQL.

Time to first call

Direct ARM integration: 1 day for AAD app registration, MSAL token handling, and async-operation polling. Through Jentic: under 1 hour.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Azure MySQL Management

Same management surface for Azure Database for MySQL.

Choose MySQL when the application uses MySQL; choose PostgreSQL when it uses Postgres.

Alternative

Azure MariaDB Management

Same management surface for Azure Database for MariaDB.

Choose MariaDB only for legacy MariaDB workloads; PostgreSQL is preferred for new ones.

Alternative

Azure SQL Management

Microsoft SQL Server / Azure SQL Database management equivalent.

Choose Azure SQL for SQL Server-based workloads; choose PostgreSQL for Postgres workloads.

Complementary

Azure Network Management

Provision the VNet and subnets used by PostgreSQL VNet rules.

Use Network Management to create the VNet and subnet, then use this API to add the matching VNet rule on the PostgreSQL server.

FAQs

Specific to using PostgreSQLManagementClient API through Jentic.

Why is there no official OpenAPI spec for PostgreSQLManagementClient?

Microsoft Azure does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call PostgreSQLManagementClient via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Azure PostgreSQL management API use?

It uses Azure Active Directory OAuth 2.0 against https://management.azure.com/ with the user_impersonation scope. The caller needs Contributor or a custom role with Microsoft.DBforPostgreSQL/* permissions on the resource group. Jentic stores service principal credentials encrypted and issues short-lived bearer tokens at execution time.

Can I provision a PostgreSQL server through this API?

Yes. PUT to /subscriptions/{id}/resourceGroups/{rg}/providers/Microsoft.DBforPostgreSQL/servers/{name} with the SKU, storage size, version, administrator login, and password in the request body. Server provisioning is a long-running operation that returns 202 Accepted with an Azure-AsyncOperation header you poll until the server reports Ready.

What are the rate limits for the PostgreSQL management API?

Azure Resource Manager applies subscription-level throttling at roughly 1,200 reads and 1,200 writes per hour. Server provisioning typically takes several minutes so async polling, not retry storms, is the right pattern.

How do I create a PostgreSQL read replica through Jentic?

Run pip install jentic and search for 'create an azure postgresql replica'. Jentic returns the Servers_Create operation with createMode set to Replica; load its schema and execute it with the source server resource ID in the properties.sourceServerId field.

Does this API run SQL queries against the database?

No. This is the management API for provisioning and configuring servers. Application SQL traffic uses the standard PostgreSQL wire protocol against {server}.postgres.database.azure.com on port 5432, typically through psycopg, libpq, or any standard PostgreSQL client.