Merk
Tilgang til denne siden krever autorisasjon. Du kan prøve å logge på eller endre kataloger.
Tilgang til denne siden krever autorisasjon. Du kan prøve å endre kataloger.
This article provides the latest news and updates about the recommended API versions to use. The API versions that aren't listed here might be supported, but will be retired soon. Find the documentation for the latest preview and stable API version is available here.
API releases
This section summarizes the feature changes across each Azure Database for PostgreSQL API version.
Note
API versions generally build on earlier versions, but preview features can change or be removed. The Release Notes column lists the changes for each version.
| API version | Stable/Preview | Release Notes |
|---|---|---|
| 2026-10-01 | Stable (GA) | Includes all capabilities from previous stable API versions, with the following additions: Maintenance management: Support for rescheduling planned maintenance, applying available maintenance updates on demand, viewing upcoming maintenance, and retrieving maintenance history. Networking: Support for migrating servers from virtual network (VNet) integration to public access and private endpoint-capable networking. FIPS compliance: Support for creating servers with FIPS enabled and enabling or disabling FIPS on existing servers. Immutable backups: Support for creating servers with immutable backups enabled. Major version upgrades: Support for running pre-upgrade validation checks before initiating a PostgreSQL major version upgrade. Autonomous tuning: Adds vacuumTable as a supported autonomous tuning option.Cross-tenant customer-managed keys (CMK): Support for configuring cross-tenant encryption using customer-managed keys, with or without geo-redundant backups enabled. PostgreSQL version flexibility: Removes the PostgreSQL version enumeration constraint, allowing server creation and major version upgrades to support newly released PostgreSQL versions without requiring an API schema update. |
| 2026-07-01-preview | Preview | Includes all capabilities from previous API versions, with the following additions: PostgreSQL 19: Adds PostgreSQL version 19 to the supported PostgresMajorVersion enumeration.Database Agent (DBAgent): Introduces a new DBAgent resource and associated management operations. Storage management: Adds new storage properties to support Premium SSD v2 and storage autogrow configuration. |
| 2026-04-01-preview | Preview | Includes all capabilities from previous API versions, with the following additions: Maintenance management: Introduces the MaintenanceEvent API with operations to retrieve maintenance event details, list maintenance events by server, reschedule planned maintenance, and apply available maintenance updates on demand.Major version upgrade prechecks: Introduces the MajorVersionUpgradePrecheck API with Get and List by Server operations, along with a new MajorVersionUpgradePrecheck operation on the Servers API to initiate pre-upgrade validation checks.Cross-tenant customer-managed keys (CMK): Adds primaryFederatedIdentityClientId and geoBackupFederatedIdentityClientId properties to the Servers API to support cross-tenant data encryption using customer-managed keys. |
| 2026-01-01-preview | Preview | Includes all capabilities from previous API versions, with the following addition: Networking: Support for migrating servers from virtual network (VNet) integration to public access and private endpoint-capable networking. |
| 2025-08-01 | Stable (GA) | Earlier GA features + Support for PG 18 Support for PG 17 Adds support for specifying default database name in an Elastic Cluster Adds support for table recommendations Corrects HTTP response codes to reflect what each API can return Adds example for CMK-based data encryption with automatic key version update Adds example for creation of server in Microsoft owned virtual network Renames files for better representation of their contents Renames operation IDs to improve organization, clarity, and navigation Improves metadata of local definitions Improves descriptions for consistency |
| 2025-06-01-preview | Preview | Renames files for better representation of their contents Renames operations to improve organization, clarity, and navigation Adds example for CMK-based data encryption with automatic key version update Adds example for creation of server in Microsoft owned virtual network Adds support for table recommendations Adds support for specifying default database name in an Elastic Cluster Removes support for parameter tuning feature Improves descriptions Improves metadata of local definitions Corrects HTTP response codes to reflect what each API can return |
| 2025-01-01-preview | Preview | Adds support for parameter tuning feature |
| 2024-11-01-preview | Preview | Index tuning Added source types for migration PG 17 support UltraSSD_LRS storage type support Elastic Clusters on flexible server instances |
| 2024-08-01 | Stable (GA) | Earlier GA features + Geo + CMK - Revive Dropped Storage auto growth IOPS scaling New location capability api Long Term Retention Backup Server Logs Migrations Migration Pre-validation Read replicas - Switchover (Site swap) Read replicas - Virtual Endpoints Private Endpoints Azure Defender / Threat Protection APIs PG 16 support PremiumV2_LRS storage type support Location capability changes for SSDv2 Migration Roles Migration Instance Resource Id to support Private endpoint Migrations On-demand backup System assigned managed identity |
| 2023-06-01-preview | Preview | Earlier GA features + Migration Prevalidation Read replicas - Switchover (Site swap) Read replicas - Virtual Endpoints Private Endpoints Azure Defender\Threat Protection APIs PG 16 support PremiumV2_LRS storage type support Location capability changes for SSDv2 Quota Usage API |
| 2023-03-01-preview | Preview | New GA version features (2022-12-01) + Geo + CMK Storage auto growth IOPS scaling New location capability API Azure Defender Server Logs Migrations |
| 2022-12-01 | Stable (GA) | Earlier GA features + EntraID CMK Backups Administrators Replicas GeoRestore MVU |
| 2022-05-01-preview | Preview | CheckMigrationNameAvailability Migrations |
| 2021-06-01 | Stable (GA) | Earlier GA features + Server CRUD CheckNameAvailability Configurations (Parameters) Database Firewall rules Private DNS zone suffix PITR Server Restart Server Start Server Stop Maintenance window Virtual network subnet usage |
Stable API operation list
Each supported stable API operation and its details are listed in the following table.
| Feature/Operation | Details |
|---|---|
| Administrators | Manage Microsoft Entra ID server administrators |
| Advanced Threat Protection | Manage advanced threat protection settings |
| Backup & Restore | Manage automatic and on-demand server backups |
| Capabilities | List available server capabilities by location and server |
| Configurations | View and manage PostgreSQL server parameters |
| Databases | Create, read, update, delete, and list databases |
| Data Encryption | Configure customer-managed keys (CMK), including cross-tenant encryption |
| Firewall Rules | Create, read, update, delete, and list firewall rules |
| Long-Term Retention | Manage long-term retention backup operations |
| Maintenance Events | List, retrieve, reschedule, and apply maintenance events on demand |
| Major Version Upgrade Prechecks | Initiate pre-upgrade validation checks and retrieve validation results |
| Migrations | Create and manage database migration operations |
| Name Availability | Check server and virtual endpoint name availability |
| Network Mode Migration | Migrate servers from VNet integration to a Private Link-capable network configuration |
| Operations | List available resource provider management operations |
| Performance Tuning | Retrieve tuning options and database optimization recommendations |
| Private DNS Zone Suffix | Retrieve the private DNS zone suffix |
| Private Endpoints | Manage private endpoint connections |
| Private Link Resources | List private link resources |
| Quota Usage | Retrieve regional server quota and usage information |
| Read Replicas | Create and manage read replicas, including promotion and switchover |
| Servers | Create, read, update, delete, list, start, stop, and restart servers |
| Virtual Endpoints | Create and manage virtual endpoints |
| Virtual Network Subnet Usage | Retrieve virtual network subnet usage information |
Preview API operation list
The following table lists each supported preview API operation and its details.
| Feature/Operation | Details |
|---|---|
| Administrators | Create, retrieve, list, and delete Microsoft Entra ID server administrators |
| Advanced Threat Protection | Retrieve, list, and update advanced threat protection settings |
| Backup & Restore | Create, retrieve, list, and delete on-demand backups; list available automatic backups |
| Capabilities | List available server capabilities by location and server |
| Captured Logs | List captured server logs available for download |
| Configurations | Retrieve, list, and update PostgreSQL server parameters |
| Database Agents | List, retrieve, enable, and disable database agent configurations |
| Databases | Create, retrieve, list, and delete databases |
| Data Encryption | Configure customer-managed keys (CMK), including cross-tenant encryption |
| Firewall Rules | Create, retrieve, update, list, and delete firewall rules |
| Long-Term Retention | Validate backup prerequisites, initiate long-term retention backups, and retrieve backup operation results |
| Maintenance Events | Retrieve and list maintenance events, filter by upcoming or past status, reschedule maintenance, and apply maintenance immediately |
| Major Version Upgrade Prechecks | Initiate pre-upgrade validation checks and retrieve or list validation results |
| Migrations | Create, retrieve, list, update, and cancel database migrations; validate migration name availability |
| Name Availability | Check server and virtual endpoint name availability globally or by location |
| Network Mode Migration | Migrate servers from VNet integration to a Private Link-capable networking model |
| Operations | List available resource provider management operations |
| Performance Tuning | Retrieve tuning options and index or table optimization recommendations |
| Private DNS Zone Suffix | Retrieve the private DNS zone suffix |
| Private Endpoints | Retrieve, list, approve, reject, and delete private endpoint connections |
| Private Link Resources | Retrieve and list private link resources |
| Quota Usage | Retrieve regional quota usage for flexible servers |
| Read Replicas | Create, list, and manage read replicas, including promotion and switchover |
| Servers | Create, retrieve, update, delete, and list servers; start, stop, and restart servers |
| Storage Management | Configure Premium SSD v2 and storage autogrow through server storage properties |
| Virtual Endpoints | Create, retrieve, update, list, and delete virtual endpoints |
| Virtual Network Subnet Usage | Retrieve virtual network subnet usage information |
Using preview versions of API from Terraform
Terraform is an infrastructure-as-code (IaC) software tool created by HashiCorp. Users define and provide data center infrastructure using a declarative configuration language known as HashiCorp Configuration Language (HCL), or optionally JSON. Terraform is a common way to perform IaC management for Azure Database for PostgreSQL based on GA Azure RM API, in addition to Azure Resource Manager (ARM) Templates Terraform community releases regular updates for Azure Resource Manager (AzureRM) Terraform provider based on Azure Resource Manager API version in General Availability (GA).
If a particular feature is currently in a preview API and isn't yet incorporated into the GA API and AzureRM Terraform provider, use the AzAPI Terraform provider to call the preview API directly from Terraform. The AzAPI provider is a thin layer on top of the Azure Resource Manager REST APIs. The AzAPI provider enables you to manage any Azure resource type by using any API version. The AzAPI provider is a thin layer on top of the Azure ARM REST APIs. By using the AzAPI provider, you can manage any Azure resource type using any API version. This provider complements the AzureRM provider by enabling the management of new Azure resources and properties (including private preview).
AzAPI provider features the following benefits:
- Supports all Azure services:
- Private preview services and features
- Public preview services and features
- All API versions
- Full Terraform state file fidelity
- Properties and values are saved to state
- No dependency on Swagger
- Common and consistent Azure authentication
The AzAPI2AzureRM is an open source tool that is designed to help migrate from the AzAPI provider to the AzureRM provider.
Contacts
For any questions or suggestions you might have on Azure Database for PostgreSQL, send an email to the Azure Database for PostgreSQL Team (@Ask Azure Database for PostgreSQL). Note that this email address isn't a technical support alias.
In addition, consider the following points of contact as appropriate:
- To contact Azure Support, file a ticket from the Azure portal.
- To fix an issue with your account, file a support request in the Azure portal.
- To provide feedback or to request new features, create an entry via UserVoice.