Release sql microsoft.sql 2024 05 01 preview #30165

ravigautam1896 · 2024-08-12T16:18:11Z

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:
- 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

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.

…rsion (#29200) * Adds base for updating Microsoft.Sql from version preview/2023-08-01-preview to version 2024-05-01-preview * Updates API version in new specs and examples * Updates readme * addressing comments * resolving spell check errors * resolving LroLocationheader errors * supress errors from DatabaseAdvisiors.json * reverting the supression --------- Co-authored-by: Ravi Gautam <ravigautam@microsoft.com>

* Update for Import/Export with Managed Identity * Fix the example reference and update description

…29823) * Set the new additionalProperties type to string * Remove the required type for additionalProperties, just keep them true

* Add instance pool operations swagger and examples * Address prettier check errors * Fix Swagger LintDiff errors * Fix parameter names to match parameter patterns * Remove validation for resourceGroupName parameter as it fails Swagger ModelValidation (and it should not be failing) * Replace bool with enum (PR review remark) --------- Co-authored-by: Ivan Arandjelovic <ivarandj@microsoft.com>

* Adding updated DatabaseOperations.json file * Trying to fix ModelValidation error * Reverting testing change --------- Co-authored-by: Roopesh Manda <rmanda@microsoft.com>

…ft.Sql-2024-05-01-preview (#30030) * taking changes from dsmaindev side * removing further DatabaseAdvisor.json changes * resolving spellcheck validation * resolving ModelValidation errors * resolving avocado errors * resolving LRO Headers Validation and xmsEnum Validation * resolving indentation --------- Co-authored-by: Ravi Gautam <ravigautam@microsoft.com>

openapi-pipeline-app · 2024-08-12T16:18:15Z

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

Co-authored-by: Ravi Gautam <ravigautam@microsoft.com>

openapi-pipeline-app · 2024-08-13T01:05:13Z

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

openapi-pipeline-app · 2024-08-13T01:16:21Z

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

* reverting cspell.json changes * revert changes2 --------- Co-authored-by: Ravi Gautam <ravigautam@microsoft.com>

openapi-pipeline-app · 2024-08-21T16:11:33Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
This PR has ARMChangesRequested label. Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
Automation should then add WaitForARMFeedback label.
❗If you don't have permissions to remove the label, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories.
For details of the ARM review, see aka.ms/azsdk/pr-arm-review
❌ The required check named Swagger ModelValidation has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

openapi-pipeline-app · 2024-08-21T16:11:33Z

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.Sql	https://apiview.dev/Assemblies/Review/86f9467cec6a49f899d90b4872280851?revisionId=92291147a61340feba6e44cdc2cf64af

...on/sql/resource-manager/Microsoft.Sql/preview/2024-05-01-preview/InstancePoolOperations.json

ramoka178 · 2024-08-29T19:20:46Z

...on/sql/resource-manager/Microsoft.Sql/preview/2024-05-01-preview/InstancePoolOperations.json

+          ],
+          "type": "string",
+          "readOnly": true
+        },


why are these needed in properties ? shouldn't they online come in error responses. and there is an error response definition in common-types

Can you be more specific?

ramoka178 · 2024-08-29T19:20:50Z

...on/sql/resource-manager/Microsoft.Sql/preview/2024-05-01-preview/InstancePoolOperations.json

+        },
+        "isCancellable": {
+          "description": "Whether the operation can be cancelled.",
+          "type": "boolean",


boolean

ARM recommends enums over booleans for future proof APIs.

Standard guidance is: replace boolean/switch properties with a more meaningful enum whenever possible.

A boolean will forever have two valid values (true or false). A string enum type is always preferred. Also, properties should always provide better values just than True and False. For example two switches "isTypeA" and "isTypeB" should be replaced with one enum "type": [A, B, DefaultType]. Enums are always a more flexible and future proof option because they allow additional values to be added in the future in a non-breaking way, e.g. [Enabled, Disabled, Suspended, Deallocated].

Note: do NOT define a 'boolean enum' with two values 'True and False'. This might be easier to 'extend' in terms of types, but semantically its cofusing, and no better than a boolean.

Agree, I already changed errorType from boolean to enum. Can you suggest how to convert this to enum?

It's a bit of a struggle to come up with property name that would have values "Cancelable", "NotCancelable". Maybe "CancelationType"?

As this is also same as in SQL MI apis, and since Portal work is already done maybe we should leave it "as is" for now and change it in next API release. Would this be acceptable?

ramoka178 · 2024-08-29T19:20:55Z

            "type": "string"

update description

Refers to: specification/sql/resource-manager/Microsoft.Sql/preview/2024-05-01-preview/ManagedInstanceLongTermRetentionPolicies.json:249 in 8e3d118. [](commit_id = 8e3d118, deletion_comment = False)

ramoka178 · 2024-08-29T19:20:58Z

      "additionalProperties": true,

what does this change imply ?

Refers to: specification/sql/resource-manager/Microsoft.Sql/preview/2024-05-01-preview/ServerAdvisors.json:586 in 8e3d118. [](commit_id = 8e3d118, deletion_comment = False)

mikeharder · 2024-08-29T19:27:29Z

/azp run

azure-pipelines · 2024-08-29T19:27:49Z

Azure Pipelines successfully started running 3 pipeline(s).

mikeharder · 2024-08-29T20:40:11Z

/azp run

azure-pipelines · 2024-08-29T20:40:36Z

Azure Pipelines successfully started running 3 pipeline(s).

ravigautam1896 · 2024-09-02T12:55:12Z

@ramoka178 in this PR we are just merging the release branch to main branch, no new changes are there in this PR.
and the changes which you have mentioned.
these are already approved.

ARMSignOff already done

PR #1
#29596

PR #2
#29823

PR #3
#29932

PR #4
#29956

PR #5
#30030

Co-authored-by: Ivan Arandjelovic <ivarandj@microsoft.com>

ravigautam1896 · 2024-09-05T01:51:02Z

/azp run

azure-pipelines · 2024-09-05T01:51:21Z

Azure Pipelines successfully started running 3 pipeline(s).

TimLovellSmith · 2024-09-05T18:21:13Z

@ramoka178 in this PR we are just merging the release branch to main branch, no new changes are there in this PR. and the changes which you have mentioned. these are already approved.

ARMSignOff already done

PR #1 #29596

PR #2 #29823

PR #3 #29932

PR #4 #29956

PR #5 #30030

You still need to fix validation errors before merging this PR. For the resource group name parameter the fix should be easy just reference common-types v5 or v6 ResourceGroupParameter the way other RPs do

ravigautam1896 · 2024-09-05T19:24:39Z

/azp run

azure-pipelines · 2024-09-05T19:25:00Z

Azure Pipelines successfully started running 3 pipeline(s).

TimLovellSmith · 2024-09-06T01:52:58Z

...ql/resource-manager/Microsoft.Sql/preview/2024-05-01-preview/DatabaseRecommendedActions.json

+    }
+  },
+  "definitions": {
+    "RecommendedAction": {


RecommendedAction

this is hard to review the change because its been reordered

TimLovellSmith · 2024-09-06T01:54:34Z

      "readOnly": true

why change it?

Refers to: specification/sql/resource-manager/Microsoft.Sql/preview/2024-05-01-preview/LocationCapabilities.json:1654 in 8a9361a. [](commit_id = 8a9361a, deletion_comment = True)

TimLovellSmith · 2024-09-06T01:56:26Z

Please fix model validation errors

ravigautam1896 and others added 6 commits June 13, 2024 16:20

Update for Import/Export with Managed Identity (#29596)

a7cbe56

* Update for Import/Export with Managed Identity * Fix the example reference and update description

Set the additionalProperties type to string for DatabaseAdvisors API (#…

8a9361a

…29823) * Set the new additionalProperties type to string * Remove the required type for additionalProperties, just keep them true

Adding updated DatabaseOperations.json file (#29956)

18937ee

* Adding updated DatabaseOperations.json file * Trying to fix ModelValidation error * Reverting testing change --------- Co-authored-by: Roopesh Manda <rmanda@microsoft.com>

ravigautam1896 requested review from jamestao, ericshape and jeremyfrosti as code owners August 12, 2024 16:18

ravigautam1896 enabled auto-merge (rebase) August 12, 2024 16:26

ravigautam1896 disabled auto-merge August 12, 2024 16:28

resolve merge conflict for cSpell.json (#30179)

1b38659

Co-authored-by: Ravi Gautam <ravigautam@microsoft.com>

ravigautam1896 enabled auto-merge (rebase) August 13, 2024 01:07

ericshape closed this Aug 13, 2024

auto-merge was automatically disabled August 13, 2024 01:13
Pull request was closed

ericshape reopened this Aug 13, 2024

ravigautam1896 enabled auto-merge (rebase) August 13, 2024 12:13

ravigautam1896 added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Aug 14, 2024

ravigautam1896 disabled auto-merge August 21, 2024 14:59

reverting cspell.json changes (#30285)

08acca3

* reverting cspell.json changes * revert changes2 --------- Co-authored-by: Ravi Gautam <ravigautam@microsoft.com>

AzureRestAPISpecReview added the ARMReview label Aug 21, 2024

ramoka178 reviewed Aug 29, 2024

View reviewed changes

...on/sql/resource-manager/Microsoft.Sql/preview/2024-05-01-preview/InstancePoolOperations.json Show resolved Hide resolved

ramoka178 reviewed Aug 29, 2024

View reviewed changes

...on/sql/resource-manager/Microsoft.Sql/preview/2024-05-01-preview/InstancePoolOperations.json Show resolved Hide resolved

ramoka178 reviewed Aug 29, 2024

View reviewed changes

ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Aug 29, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 29, 2024

Fix lintdiff enum errpr (#30383)

f3038a5

Co-authored-by: Ivan Arandjelovic <ivarandj@microsoft.com>

ravigautam1896 removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 2, 2024

openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 2, 2024

TimLovellSmith reviewed Sep 6, 2024

View reviewed changes

TimLovellSmith added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 6, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 6, 2024

ravigautam1896 closed this Sep 11, 2024

ravigautam1896 reopened this Sep 11, 2024

ravigautam1896 closed this Sep 11, 2024

ravigautam1896 deleted the release-sql-Microsoft.Sql-2024-05-01-preview branch September 16, 2024 05:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release sql microsoft.sql 2024 05 01 preview #30165

Release sql microsoft.sql 2024 05 01 preview #30165

ravigautam1896 commented Aug 12, 2024 •

edited

Loading

openapi-pipeline-app bot commented Aug 12, 2024

openapi-pipeline-app bot commented Aug 13, 2024

openapi-pipeline-app bot commented Aug 13, 2024

openapi-pipeline-app bot commented Aug 21, 2024 •

edited

Loading

openapi-pipeline-app bot commented Aug 21, 2024 •

edited

Loading

ramoka178 Aug 29, 2024

ivanarandjelovic Aug 30, 2024

ramoka178 Aug 29, 2024

ivanarandjelovic Aug 30, 2024

ramoka178 commented Aug 29, 2024

ramoka178 commented Aug 29, 2024

mikeharder commented Aug 29, 2024

azure-pipelines bot commented Aug 29, 2024

mikeharder commented Aug 29, 2024

azure-pipelines bot commented Aug 29, 2024

ravigautam1896 commented Sep 2, 2024

ravigautam1896 commented Sep 5, 2024

azure-pipelines bot commented Sep 5, 2024

TimLovellSmith commented Sep 5, 2024

ravigautam1896 commented Sep 5, 2024

azure-pipelines bot commented Sep 5, 2024

TimLovellSmith Sep 6, 2024

TimLovellSmith commented Sep 6, 2024

TimLovellSmith commented Sep 6, 2024

Release sql microsoft.sql 2024 05 01 preview #30165

Release sql microsoft.sql 2024 05 01 preview #30165

Conversation

ravigautam1896 commented Aug 12, 2024 • edited Loading

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented Aug 12, 2024

openapi-pipeline-app bot commented Aug 13, 2024

openapi-pipeline-app bot commented Aug 13, 2024

openapi-pipeline-app bot commented Aug 21, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Aug 21, 2024 • edited Loading

Generated ApiView

ramoka178 Aug 29, 2024

Choose a reason for hiding this comment

ivanarandjelovic Aug 30, 2024

Choose a reason for hiding this comment

ramoka178 Aug 29, 2024

Choose a reason for hiding this comment

ivanarandjelovic Aug 30, 2024

Choose a reason for hiding this comment

ramoka178 commented Aug 29, 2024

ramoka178 commented Aug 29, 2024

mikeharder commented Aug 29, 2024

azure-pipelines bot commented Aug 29, 2024

mikeharder commented Aug 29, 2024

azure-pipelines bot commented Aug 29, 2024

ravigautam1896 commented Sep 2, 2024

ravigautam1896 commented Sep 5, 2024

azure-pipelines bot commented Sep 5, 2024

TimLovellSmith commented Sep 5, 2024

ravigautam1896 commented Sep 5, 2024

azure-pipelines bot commented Sep 5, 2024

TimLovellSmith Sep 6, 2024

Choose a reason for hiding this comment

TimLovellSmith commented Sep 6, 2024

TimLovellSmith commented Sep 6, 2024

ravigautam1896 commented Aug 12, 2024 •

edited

Loading

openapi-pipeline-app bot commented Aug 21, 2024 •

edited

Loading

openapi-pipeline-app bot commented Aug 21, 2024 •

edited

Loading