Update for Import/Export with Managed Identity #29596
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
psong-ms
requested review from
jamestao,
ericshape and
jeremyfrosti
as code owners
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| DatabaseExtensions.json | 2024-05-01-preview(b6bd0cf) | 2021-11-01(main) |
| DatabaseExtensions.json | 2024-05-01-preview(b6bd0cf) | 2023-08-01-preview(main) |
| Databases.json | 2024-05-01-preview(b6bd0cf) | 2021-11-01(main) |
| Databases.json | 2024-05-01-preview(b6bd0cf) | 2023-08-01-preview(main) |
| Servers.json | 2024-05-01-preview(b6bd0cf) | 2021-11-01(main) |
| Servers.json | 2024-05-01-preview(b6bd0cf) | 2023-08-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L1906:7 Old: Microsoft.Sql/preview/2023-08-01-preview/Databases.json#L1911:7 |
|
| The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L1977:7 Old: Microsoft.Sql/preview/2023-08-01-preview/Databases.json#L1982:7 |
|
| The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.Sql/preview/2024-05-01-preview/Servers.json#L633:7 Old: Microsoft.Sql/preview/2023-08-01-preview/Servers.json#L631:7 |
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-preview-2024-05 | package-preview-2024-05(b6bd0cf) | package-preview-2024-05(release-sql-Microsoft.Sql-2024-05-01-preview) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'serverName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2024-05-01-preview/DatabaseExtensions.json#L19 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2024-05-01-preview/DatabaseExtensions.json#L19 |
|
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extensions/{extensionName} has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response. Location: Microsoft.Sql/preview/2024-05-01-preview/DatabaseExtensions.json#L67 |
|
The resource name parameter 'serverName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2024-05-01-preview/DatabaseExtensions.json#L67 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2024-05-01-preview/DatabaseExtensions.json#L67 |
|
The resource name parameter 'extensionName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2024-05-01-preview/DatabaseExtensions.json#L67 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Sql/preview/2024-05-01-preview/DatabaseExtensions.json#L114 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Sql/preview/2024-05-01-preview/DatabaseExtensions.json#L114 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'DatabaseExtensions_CreateOrUpdate' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema' Location: Microsoft.Sql/preview/2024-05-01-preview/DatabaseExtensions.json#L114 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Sql/preview/2024-05-01-preview/DatabaseExtensions.json#L114 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2024-05-01-preview/DatabaseExtensions.json#L165 |
|
The nested resource 'ImportExportExtensionsOperationResult' does not have list operation, please add it. Location: Microsoft.Sql/preview/2024-05-01-preview/DatabaseExtensions.json#L331 |
|
The resource name parameter 'serverName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L19 |
|
The resource name parameter 'serverName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L73 |
|
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L73 |
|
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L80 |
|
Query parameter $filter should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L80 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L144 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L144 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L144 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L189 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L272 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L305 |
|
Properties of a PATCH request body must not be x-ms-mutability: ['create'], property:createMode. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L343 |
|
Properties of a PATCH request body must not be x-ms-mutability: ['create'], property:sampleName. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L343 |
|
Properties of a PATCH request body must not be x-ms-mutability: ['create'], property:sourceDatabaseId. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L343 |
|
Properties of a PATCH request body must not be x-ms-mutability: ['create'], property:restorePointInTime. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L343 |
|
Properties of a PATCH request body must not be x-ms-mutability: ['create'], property:sourceDatabaseDeletionDate. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L343 |
|
Properties of a PATCH request body must not be x-ms-mutability: ['create'], property:recoveryServicesRecoveryPointId. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L343 |
|
Properties of a PATCH request body must not be x-ms-mutability: ['create'], property:longTermRetentionBackupResourceId. Location: Microsoft.Sql/preview/2024-05-01-preview/Databases.json#L343 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/sql/resource-manager/readme.md tag: specification/sql/resource-manager/readme.md#tag-package-composite-v5 |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMReview
resource-manager
WaitForARMFeedback
This was referenced Jun 26, 2024
ramoka178
reviewed
Jun 26, 2024
| @@ -0,0 +1,41 @@ | |||
| { | |||
There was a problem hiding this comment.
Are the examples part of this PR? I do not see them being called from the swagger json files changed in this PR .
There was a problem hiding this comment.
Thanks for pointing it out. Just fixed it in the last iteration of this PR.
ramoka178
added
the
ARMChangesRequested
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
ericshape
approved these changes
Jul 5, 2024
|
Hi @psong-ms can you follow the step in PR description to get the approval from ARM side? |
ericshape
added
WaitForARMFeedback
|
These are the breaking changes for this new API version (comparing with the last preview version). They are intended changes.
|
madhura-np
added
the
ARMSignedOff
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
|
/pr RequestMerge |
sredman
merged commit a7cbe56
into
Azure:release-sql-Microsoft.Sql-2024-05-01-preview
26 of 29 checks passed
8 tasks
ravigautam1896
added a commit
that referenced
this pull request
Sep 16, 2024
* Adding folders and examples changes for Version 2024-05-01 preview version (#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 (#29596) * Update for Import/Export with Managed Identity * Fix the example reference and update description * Set the additionalProperties type to string for DatabaseAdvisors API (#29823) * Set the new additionalProperties type to string * Remove the required type for additionalProperties, just keep them true * Dev/ivarandj/instance pool operations api (#29932) * 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 (#29956) * Adding updated DatabaseOperations.json file * Trying to fix ModelValidation error * Reverting testing change --------- Co-authored-by: Roopesh Manda <rmanda@microsoft.com> * Adding swagger files for minor changes related to release-sql-Microsoft.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> * resolve merge conflict for cSpell.json (#30179) Co-authored-by: Ravi Gautam <ravigautam@microsoft.com> * reverting cspell.json changes (#30285) * reverting cspell.json changes * revert changes2 --------- Co-authored-by: Ravi Gautam <ravigautam@microsoft.com> * Fix lintdiff enum errpr (#30383) Co-authored-by: Ivan Arandjelovic <ivarandj@microsoft.com> --------- Co-authored-by: Ravi Gautam <ravigautam@microsoft.com> Co-authored-by: psong-ms <147777703+psong-ms@users.noreply.github.com> Co-authored-by: UrosKrsticMIPerf <150959695+UrosKrsticMIPerf@users.noreply.github.com> Co-authored-by: Ivan Arandjelovic <ivan.arandjelovic@gmail.com> Co-authored-by: Ivan Arandjelovic <ivarandj@microsoft.com> Co-authored-by: akromm <87152103+akromm@users.noreply.github.com> Co-authored-by: Roopesh Manda <rmanda@microsoft.com> Co-authored-by: Mike Harder <mharder@microsoft.com>
jaskisin
pushed a commit
to jaskisin/azure-rest-api-specs
that referenced
this pull request
Sep 16, 2024
* Adding folders and examples changes for Version 2024-05-01 preview version (Azure#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 (Azure#29596) * Update for Import/Export with Managed Identity * Fix the example reference and update description * Set the additionalProperties type to string for DatabaseAdvisors API (Azure#29823) * Set the new additionalProperties type to string * Remove the required type for additionalProperties, just keep them true * Dev/ivarandj/instance pool operations api (Azure#29932) * 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 (Azure#29956) * Adding updated DatabaseOperations.json file * Trying to fix ModelValidation error * Reverting testing change --------- Co-authored-by: Roopesh Manda <rmanda@microsoft.com> * Adding swagger files for minor changes related to release-sql-Microsoft.Sql-2024-05-01-preview (Azure#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> * resolve merge conflict for cSpell.json (Azure#30179) Co-authored-by: Ravi Gautam <ravigautam@microsoft.com> * reverting cspell.json changes (Azure#30285) * reverting cspell.json changes * revert changes2 --------- Co-authored-by: Ravi Gautam <ravigautam@microsoft.com> * Fix lintdiff enum errpr (Azure#30383) Co-authored-by: Ivan Arandjelovic <ivarandj@microsoft.com> --------- Co-authored-by: Ravi Gautam <ravigautam@microsoft.com> Co-authored-by: psong-ms <147777703+psong-ms@users.noreply.github.com> Co-authored-by: UrosKrsticMIPerf <150959695+UrosKrsticMIPerf@users.noreply.github.com> Co-authored-by: Ivan Arandjelovic <ivan.arandjelovic@gmail.com> Co-authored-by: Ivan Arandjelovic <ivarandj@microsoft.com> Co-authored-by: akromm <87152103+akromm@users.noreply.github.com> Co-authored-by: Roopesh Manda <rmanda@microsoft.com> Co-authored-by: Mike Harder <mharder@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection 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!
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:
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 ApiViewcomment 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
Purpose of this PRandDue diligence checklist.write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.