Review request for Microsoft.DBforPostgreSQL to add version stable/2025-08-01 by mattboentoro · Pull Request #36219 · Azure/azure-rest-api-specs

mattboentoro · 2025-07-25T21:40:35Z

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

New resource provider.
New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix OpenAPI spec quality issues in S360.
Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
Other, please clarify:
- Reorganizes file structure.
- Renames files to make more sense of their contents.
- Changes operationIds so that operation groups are nouns and operation names are verbs.
- Corrects some minLength, maxLength, or pattern of definitions that were incorrect and didn't match the validations imposed on the backend.
- Removes sensitive information that was slipped in some example files (like subscription identifiers, resource group names, or server names). Now only approved fictitious names are used.
- Makes the style and grammar of all descriptions consistent across the board.
- Adds some important missing examples.
- Changes response codes to match those actually returned by our APIs, rather than trying to satisfy the validation rules checked in the build process.
- Fixes multiple previously existing errors which had been supressed, but could be fixed in the swaggers.

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
A release plan has been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
For guidance on SDK breaking change review, refer to https://aka.ms/ci-fix.

openapi-pipeline-app · 2025-07-25T21:40:40Z

This comment is a remnant of a now-deprecated bot framework. It is being left behind only to point at the new comment that is updated by our new actions-based framework.

openapi-pipeline-app · 2025-07-25T21:40:40Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

Copilot

Pull Request Overview

This PR introduces a new API version preview/2025-08-01 for Microsoft.DBforPostgreSQL, adding comprehensive example files that demonstrate the enhanced capabilities of Azure Database for PostgreSQL flexible servers. The changes include updated examples for server management operations, new virtual endpoint features, enhanced security configurations, and advanced threat protection settings.

Key changes:

Comprehensive server lifecycle management examples (create, update, delete, restart, start/stop)
New virtual endpoint functionality for read/write load balancing
Enhanced security features including Microsoft Entra ID authentication and data encryption
Advanced threat protection settings configuration
Improved server capabilities and operational examples

Reviewed Changes

Copilot reviewed 107 out of 109 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
VirtualNetworkSubnetUsage.json	Example for checking virtual network subnet usage for PostgreSQL servers
VirtualEndpoints*.json	Examples for managing virtual endpoints including create, update, delete, get, and list operations
ServerThreatProtectionSettings*.json	Examples for configuring and managing advanced threat protection settings
ServerUpdate*.json	Various server update scenarios including Microsoft Entra authentication, data encryption, and maintenance windows
ServerCreate*.json	Server creation examples with different configurations including geo-restore, replicas, and encryption
Server*.json	Basic server operations like get, list, delete, start, stop, restart, and capabilities
ReplicasListByServer.json	Example for listing read replicas of a PostgreSQL server
PromoteReplicaAsPlannedSwitchover.json	Example for promoting a replica server as planned switchover
ServerCapabilities.json	Comprehensive server capabilities information including supported SKUs and storage options

...-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/VirtualNetworkSubnetUsage.json

Copilot · 2025-07-25T21:41:53Z

...nager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/VirtualEndpointsListByServer.json

@@ -0,0 +1,31 @@
+{
+  "parameters": {
+    "api-version": "2024-08-01",


The api-version in the example should be "2025-08-01" to match the directory structure, not "2024-08-01".

Suggested change

"api-version": "2024-08-01",

"api-version": "2025-08-01",

Copilot · 2025-07-25T21:41:53Z

...source-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/VirtualEndpointsGet.json

@@ -0,0 +1,28 @@
+{
+  "parameters": {
+    "api-version": "2024-08-01",


The api-version should be "2025-08-01" to match the directory structure.

Suggested change

"api-version": "2024-08-01",

"api-version": "2025-08-01",

...urce-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/VirtualEndpointUpdate.json

Copilot · 2025-07-25T21:41:54Z

...urce-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/VirtualEndpointDelete.json

@@ -0,0 +1,22 @@
+{
+  "parameters": {
+    "api-version": "2024-08-01",


The api-version should be "2025-08-01" to match the directory structure.

Suggested change

"api-version": "2024-08-01",

"api-version": "2025-08-01",

...urce-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/VirtualEndpointCreate.json

github-actions · 2025-07-25T21:42:29Z

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language	API Review for Package
Swagger	Microsoft.DBforPostgreSQL
Go	sdk/resourcemanager/postgresql/armpostgresqlflexibleservers
Java	com.azure.resourcemanager:azure-resourcemanager-postgresqlflexibleserver

mikekistler · 2025-07-28T17:13:56Z

Breaking changes previously reviewed and approved in #33028

...manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/CapabilitiesByLocationList.json

...e-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/CapabilitiesByServerList.json

specification/postgresql/resource-manager/readme.md

josefree · 2025-09-24T02:59:39Z

A PR converting Azure Database for PostgreSQL - Flexible Server to TypeSpec has been prepped by the Azure SDK team as part of the drive to migrate all Azure services to TypeSpec by March 31, 2025. The PR for this is Migrate PostgreSql to TypeSpec #36556.
The responsible team is required to assign an API developer to the pull request, collaborate with the Azure SDK engineer to review and address any remaining issues related to service functionality, and aim to merge the PR within two weeks of the IcM ticket open.
Information regarding how to do this finalization and who to contact for assistance are at Getting started | TypeSpec Azure.
After the conversion PR is merged, subsequent versions should continue to use TypeSpec.

...ication/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/Servers.json

mattboentoro · 2025-09-24T17:27:03Z

@live1206 @msyyc we're not sure why this PR is having issue with SDK validation for .NET and Python. Our previous PR doesn't have these issues: https://github.com/Azure/azure-rest-api-specs/pull/35537/checks

msyyc · 2025-09-25T02:23:50Z

/azp run SDK Validation - Python

azure-pipelines · 2025-09-25T02:24:04Z

Azure Pipelines successfully started running 1 pipeline(s).

msyyc · 2025-09-25T03:00:33Z

@mattboentoro python failure is fixed.

live1206 · 2025-09-28T01:30:04Z

The .NET SDK validation failure is due to breaking changes, custom SDK code in azure-sdk-for-net is incompatible with latest generate .NET SDK. We can only fix it in azure-sdk-for-net when generate new version .NET SDK.
This is optional for spec PR merge, please go ahead ignoring this failure.

…25-08-01 (#36219) * copy paste from the previous GA version * changing the version name to 2025-08-01 * add changes from the 2025-06-01-preview * added version 2025-08-01 to readme * address feedback * add description to all enum values * fix lint diff * correct the description for enum, fix mutability for non-modifiable attribute * add PG18 * address comment --------- Co-authored-by: Matthew Boentoro <mboentoro@microsoft.com> Co-authored-by: Scott Beddall <45376673+scbedd@users.noreply.github.com>

copy paste from the previous GA version

30df28d

mattboentoro requested a review from a team as a code owner July 25, 2025 21:40

mattboentoro requested review from Copilot and nasc17 July 25, 2025 21:40

microsoft-github-policy-service bot added the PostgreSQL label Jul 25, 2025

mattboentoro requested a review from nachoalonsoportillo July 25, 2025 21:41

Copilot AI reviewed Jul 25, 2025

View reviewed changes

github-actions bot added the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Jul 25, 2025

changing the version name to 2025-08-01

14bc04b

AzureRestAPISpecReview added ARMReview new-api-version resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 25, 2025

add changes from the 2025-06-01-preview

b25dd89

AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 25, 2025

added version 2025-08-01 to readme

22bf3ec

nachoalonsoportillo approved these changes Jul 28, 2025

View reviewed changes

nasc17 changed the title ~~Review request for Microsoft.DBforPostgreSQL to add version preview/2025-08-01~~ Review request for Microsoft.DBforPostgreSQL to add version stable/2025-08-01 Jul 28, 2025

mikekistler added the BreakingChange-Approved-Previously Changes were reviewed and approved in a previous PR label Jul 28, 2025

nasc17 reviewed Jul 28, 2025

View reviewed changes

...manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/CapabilitiesByLocationList.json Outdated Show resolved Hide resolved

nasc17 reviewed Jul 28, 2025

View reviewed changes

...e-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/CapabilitiesByServerList.json Show resolved Hide resolved

nasc17 reviewed Jul 29, 2025

View reviewed changes

specification/postgresql/resource-manager/readme.md Outdated Show resolved Hide resolved

Merge branch 'main' into mattboentoro/2025-08-01

7e5828c

AzureRestAPISpecReview removed the NotReadyForARMReview label Jul 29, 2025

QixiaLu mentioned this pull request Aug 28, 2025

Add PostgreSQL@2025-01-01-preview hashicorp/pandora#4931

Closed

microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Sep 8, 2025

microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Sep 22, 2025

nasc17 mentioned this pull request Sep 23, 2025

Migrate PostgreSql to TypeSpec #36556

Merged

add PG18

e651071

josefree added the service-under-conversion label Sep 24, 2025

nasc17 reviewed Sep 24, 2025

View reviewed changes

...ication/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/Servers.json Show resolved Hide resolved

address comment

a367d68

nasc17 self-requested a review September 24, 2025 17:04

nasc17 approved these changes Sep 24, 2025

View reviewed changes

Merge branch 'main' into mattboentoro/2025-08-01

2e54a7b

msyyc mentioned this pull request Sep 25, 2025

[postgresql] Update package version in readme.python.md to fix python sdk generation #37742

Merged

github-actions bot added the BreakingChange-Python-Sdk label Sep 25, 2025

msyyc added the BreakingChange-Python-Sdk-Approved label Sep 26, 2025

tadelesh added the BreakingChange-Go-Sdk-Approved label Sep 29, 2025

Merge branch 'main' into mattboentoro/2025-08-01

4fa44c5

mattboentoro added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Sep 29, 2025

mattboentoro merged commit ef8f970 into Azure:main Sep 29, 2025
47 of 50 checks passed

jliusan mentioned this pull request Nov 13, 2025

[Release] sdk/resourcemanager/postgresql/armpostgresqlflexibleservers/5.0.0 Azure/azure-sdk-for-go#25609

Closed

jliusan mentioned this pull request Nov 24, 2025

[Release] sdk/resourcemanager/postgresql/armpostgresqlflexibleservers/5.0.0 Azure/azure-sdk-for-go#25654

Merged

Conversation

mattboentoro commented Jul 25, 2025 • edited by nachoalonsoportillo Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

Uh oh!

openapi-pipeline-app bot commented Jul 25, 2025 • edited by scbedd Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openapi-pipeline-app bot commented Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Change Check

Uh oh!

mikekistler commented Jul 28, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

josefree commented Sep 24, 2025

Uh oh!

Uh oh!

mattboentoro commented Sep 24, 2025

Uh oh!

msyyc commented Sep 25, 2025

Uh oh!

azure-pipelines bot commented Sep 25, 2025

Uh oh!

msyyc commented Sep 25, 2025

Uh oh!

live1206 commented Sep 28, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

14 participants

mattboentoro commented Jul 25, 2025 •

edited by nachoalonsoportillo

Loading

openapi-pipeline-app bot commented Jul 25, 2025 •

edited by scbedd

Loading

openapi-pipeline-app bot commented Jul 25, 2025 •

edited

Loading

github-actions bot commented Jul 25, 2025 •

edited

Loading