Skip to content

Update description for the following properties for SQL MI ARM REST A…#31080

Merged
ericshape merged 5 commits intoAzure:release-sql-Microsoft.Sql-2024-08-01-previewfrom
UrosKrsticMIPerf:dev/uroskrstic/update-sql-mi-api-property-description
Oct 23, 2024
Merged

Update description for the following properties for SQL MI ARM REST A…#31080
ericshape merged 5 commits intoAzure:release-sql-Microsoft.Sql-2024-08-01-previewfrom
UrosKrsticMIPerf:dev/uroskrstic/update-sql-mi-api-property-description

Conversation

@UrosKrsticMIPerf
Copy link
Copy Markdown
Contributor

@UrosKrsticMIPerf UrosKrsticMIPerf commented Oct 17, 2024

…PI: vCores, StorageSizeInGb and zoneRedudant, and update description of parameter sku. Hide totalMemoryMb parameter from older api versions, as it will not be used, and hasn't been used.

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:
    • Update description for the following properties for SQL MI ARM REST API: vCores, StorageSizeInGb and zoneRedudant, and update description of parameter sku. Hide totalMemoryMb parameter from older api versions, as it will not be used, and hasn't been used.

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.

@UrosKrsticMIPerf
Update description for the following properties for SQL MI ARM REST A…
120164b 
…PI: vCores, StorageSizeInGb and zoneRedudant, and update description of parameter sku. Hide totalMemoryMb parameter from older api versions, as it will not be used, and hasn't been used.
@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app bot commented Oct 17, 2024 •
edited
Loading

Next Steps to Merge

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

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app bot commented Oct 17, 2024 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/sql/armsql There is no API change compared with the previous version
JavaScript @azure/arm-sql There is no API change compared with the previous version
.Net Azure.ResourceManager.Sql https://apiview.dev/Assemblies/Review/1e3ea1e2dc2c4679b3acd45b20b81a18?revisionId=518f4e3433b34535b4e06b4b36accb15
Swagger Microsoft.Sql https://apiview.dev/Assemblies/Review/86f9467cec6a49f899d90b4872280851?revisionId=97480759da014513ba1ce711ba46c9bd

This was referenced Oct 17, 2024
Closed
Closed
Closed
Closed
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 17, 2024
@azure-sdk azure-sdk mentioned this pull request Oct 17, 2024
Closed
@ramoka178
Copy link
Copy Markdown
Contributor

ramoka178 commented Oct 22, 2024 

        "description": "Accepted",

please provide a description for the end user to understand easily

Refers to: specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/ManagedInstances.json:276 in e62235d. [](commit_id = e62235d, deletion_comment = False)

@ramoka178
Copy link
Copy Markdown
Contributor

ramoka178 commented Oct 22, 2024 

          "Location": {

add description for location header too. here and other places of this PR

Refers to: specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/ManagedInstances.json:278 in e62235d. [](commit_id = e62235d, deletion_comment = False)

@ramoka178
Copy link
Copy Markdown
Contributor

ramoka178 commented Oct 22, 2024 

    "x-ms-long-running-operation": true,

"x-ms-long-running-operation-options": {
"final-state-via": "location"
}

wherever missed in this PR

Refers to: specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/ManagedInstances.json:290 in e62235d. [](commit_id = e62235d, deletion_comment = False)

@ramoka178
Copy link
Copy Markdown
Contributor

ramoka178 commented Oct 22, 2024 

        "Freemium"

please add descriptions for each enum

Refers to: specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/ManagedInstances.json:1325 in e62235d. [](commit_id = e62235d, deletion_comment = False)

@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 Oct 22, 2024
@ericshape
Copy link
Copy Markdown
Member

ericshape commented Oct 23, 2024

@UrosKrsticMIPerf to address the conflict, please rebase your base branch from the upstream release branch (not main branch)

@ericshape
Copy link
Copy Markdown
Member

ericshape commented Oct 23, 2024

and please address the comments from ARM reviewers in this swagger file as well as in the DSMainDev repo.

@UrosKrsticMIPerf
Copy link
Copy Markdown
Contributor Author

UrosKrsticMIPerf commented Oct 23, 2024 

        "description": "Accepted",

please provide a description for the end user to understand easily

Refers to: specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/ManagedInstances.json:276 in e62235d. [](commit_id = e62235d, deletion_comment = False)

No part of my actual change, the only change related to the 2023-08-01 and 2024-05-01 ManagedInstances.json file is the removal of totalMemoryMb parameter, everything else is reverted and removed.

@UrosKrsticMIPerf
Copy link
Copy Markdown
Contributor Author

UrosKrsticMIPerf commented Oct 23, 2024 

        "Freemium"

please add descriptions for each enum

Refers to: specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/ManagedInstances.json:1325 in e62235d. [](commit_id = e62235d, deletion_comment = False)

No part of my actual change, the only change related to the 2023-08-01 and 2024-05-01 ManagedInstances.json file is the removal of totalMemoryMb parameter, everything else is reverted and removed.

@UrosKrsticMIPerf
Copy link
Copy Markdown
Contributor Author

UrosKrsticMIPerf commented Oct 23, 2024 

          "Location": {

add description for location header too. here and other places of this PR

Refers to: specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/ManagedInstances.json:278 in e62235d. [](commit_id = e62235d, deletion_comment = False)

No part of my actual change, the only change related to the 2023-08-01 and 2024-05-01 ManagedInstances.json file is the removal of totalMemoryMb parameter, everything else is reverted and removed.

@UrosKrsticMIPerf
Copy link
Copy Markdown
Contributor Author

UrosKrsticMIPerf commented Oct 23, 2024 

        "description": "Accepted",

please provide a description for the end user to understand easily

Refers to: specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/ManagedInstances.json:276 in e62235d. [](commit_id = e62235d, deletion_comment = False)

No part of my actual change, the only change related to the 2023-08-01 and 2024-05-01 ManagedInstances.json file is the removal of totalMemoryMb parameter, everything else is reverted and removed.

@UrosKrsticMIPerf
Copy link
Copy Markdown
Contributor Author

UrosKrsticMIPerf commented Oct 23, 2024 

    "x-ms-long-running-operation": true,

"x-ms-long-running-operation-options": { "final-state-via": "location" }

wherever missed in this PR

Refers to: specification/sql/resource-manager/Microsoft.Sql/preview/2023-08-01-preview/ManagedInstances.json:290 in e62235d. [](commit_id = e62235d, deletion_comment = False)

No part of my actual change, the only change related to the 2023-08-01 and 2024-05-01 ManagedInstances.json file is the removal of totalMemoryMb parameter, everything else is reverted and removed.

@UrosKrsticMIPerf
Copy link
Copy Markdown
Contributor Author

UrosKrsticMIPerf commented Oct 23, 2024

and please address the comments from ARM reviewers in this swagger file as well as in the DSMainDev repo.

No part of my actual change, the only change related to the 2023-08-01 and 2024-05-01 ManagedInstances.json file is the removal of totalMemoryMb parameter, everything else is reverted and removed. Handled the comments.

@UrosKrsticMIPerf
Copy link
Copy Markdown
Contributor Author

UrosKrsticMIPerf commented Oct 23, 2024

@UrosKrsticMIPerf to address the conflict, please rebase your base branch from the upstream release branch (not main branch)

Rebased.

@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 23, 2024
@ramoka178
Copy link
Copy Markdown
Contributor

ramoka178 commented Oct 23, 2024

/azp run

@azure-pipelines
Copy link
Copy Markdown

azure-pipelines bot commented Oct 23, 2024

Azure Pipelines successfully started running 3 pipeline(s).

@ramoka178
Copy link
Copy Markdown
Contributor

ramoka178 commented Oct 23, 2024

Please fix the required failing checks too

@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 Oct 23, 2024
@UrosKrsticMIPerf
Copy link
Copy Markdown
Contributor Author

UrosKrsticMIPerf commented Oct 23, 2024

Please fix the required failing checks too

@ramoka178 do you perhaps know why these required checks are failing? I tried looking at the details and the underlying pipeline but I see no information related to my changes to be honest.
image

@UrosKrsticMIPerf
Merge branch 'release-sql-Microsoft.Sql-2024-08-01-preview' into dev/…
5acc303 
…uroskrstic/update-sql-mi-api-property-description
@UrosKrsticMIPerf
Copy link
Copy Markdown
Contributor Author

UrosKrsticMIPerf commented Oct 23, 2024 •
edited
Loading

Please fix the required failing checks too

@ramoka178 do you perhaps know why these required checks are failing? I tried looking at the details and the underlying pipeline but I see no information related to my changes to be honest.
image

Looks like the required checks are passing now, after a rebase to the release branch.

@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 23, 2024
@ramoka178 ramoka178 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 23, 2024
@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 Oct 23, 2024
@ericshape ericshape merged commit 6987f2a into Azure:release-sql-Microsoft.Sql-2024-08-01-preview Oct 23, 2024
@achyuth-ms achyuth-ms mentioned this pull request Apr 9, 2025
Merged
8 tasks
ericshape pushed a commit that referenced this pull request Apr 9, 2025
@achyuth-ms
Merging #31080 , #31062 and #30912 for new API release (#33807)
17b24fe 
* adding MemorySizeInGb to swagger #30912

* adding #31080 and #31062

* prettier fix

* prettiercheck fix
@ericshape ericshape mentioned this pull request Apr 15, 2025
Closed
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ericshape ericshape ericshape approved these changes

@jamestao jamestao Awaiting requested review from jamestao

@jeremyfrosti jeremyfrosti Awaiting requested review from jeremyfrosti

Assignees

No one assigned

Labels

ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review resource-manager SQL

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@UrosKrsticMIPerf @ramoka178 @ericshape @AzureRestAPISpecReview