Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating previously release api with missing properties within Microsoft.DBforPostgreSQL #32330

Merged
merged 1 commit into from
Feb 5, 2025

Conversation

nasc17
Copy link
Member

@nasc17 nasc17 commented Jan 24, 2025

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.

spec_pr_review_workflow_diagram

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:
    • edit this with your clarification

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.

Additional information

Viewing API changes

Stable release 2024-08-01 and Preview release 2024-11-01 Added missing property to UserAssignedIdentity. If SystemAssigned type is selected, principalId will be included in the response.
image

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.

@nasc17 nasc17 added BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior PublishToCustomers Acknowledgement the changes will be published to Azure customers. labels Jan 24, 2025
@nasc17 nasc17 requested a review from a team as a code owner January 24, 2025 20:07
Copy link

openapi-pipeline-app bot commented Jan 24, 2025

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app bot commented Jan 24, 2025

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/postgresql/armpostgresql There is no API change compared with the previous version
Go sdk/resourcemanager/postgresql/armpostgresqlflexibleservers There is no API change compared with the previous version
Java azure-resourcemanager-postgresqlflexibleserver https://apiview.dev/Assemblies/Review/21a61d731117447dbd7223467d7cfa42?revisionId=366a3d32c5b7403597a8356ca5815973
Python azure-mgmt-postgresqlflexibleservers https://apiview.dev/Assemblies/Review/2f26588813fb482db3523970145d3eb0?revisionId=d43e3c7668a44e02a7dbdbf8bbfa29ae

@github-actions github-actions bot added the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Jan 24, 2025
@azure-sdk
Copy link
Collaborator

API change check

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

Microsoft.DBforPostgreSQL

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview NotReadyForARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required and removed BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior labels Jan 24, 2025
@JeffreyRichter JeffreyRichter added the Versioning-Approved-BugFix https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 27, 2025
@nasc17
Copy link
Member Author

nasc17 commented Jan 27, 2025

/azp run

Copy link

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

@AzureRestAPISpecReview AzureRestAPISpecReview added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 27, 2025
@gary-x-li gary-x-li added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jan 29, 2025
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 29, 2025
@nasc17
Copy link
Member Author

nasc17 commented Jan 30, 2025

@live1206 Could you please help with this error. This PR is just a fix for a missed property. Not sure why this error is showing up now.

Seeing error: error CS0246: The type or namespace name 'PostgreSqlFlexibleServerUserAssignedIdentity' could not be found

Found referenced here: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/postgresql/Azure.ResourceManager.PostgreSql/src/PostgreSqlFlexibleServers/Generated/Models/PostgreSqlFlexibleServerUserAssignedIdentity.cs

@live1206
Copy link
Member

live1206 commented Feb 5, 2025

SDK zure-sdk-for-net is failing due to a property removed causing the custom code not compile, we need to handle it in azure-sdk-for-net. And this change is not introduced in the current PR, we can ignore the failure and handle it during the .NET SDK generation in azure-sdk-for-net.

@nasc17 nasc17 merged commit 8cffc00 into Azure:main Feb 5, 2025
27 of 29 checks passed
markcowl pushed a commit to markcowl/azure-rest-api-specs that referenced this pull request Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. PostgreSQL PublishToCustomers Acknowledgement the changes will be published to Azure customers. ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager Versioning-Approved-BugFix https://github.com/Azure/azure-sdk-tools/issues/6374 VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants