Generate Swagger for the latest 2020-11-01-preview Servers and Manage… #13406

strehan1993 · 2021-03-12T21:57:49Z

…dInstances

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
- Adding a new service
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

…dInstances

openapi-workflow-bot · 2021-03-12T21:57:50Z

Hi, @strehan1993 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

openapi-pipeline-app · 2021-03-12T21:57:51Z

Swagger Validation Report

️❌BreakingChange: 17 Errors, 0 Warnings failed [Detail]

Only 10 items are listed, please refer to log for more details.

Compared Swaggers (Based on Oad v0.8.7)
- original: preview/2020-11-01-preview/ManagedInstances.json <---> new: preview/2020-11-01-preview/ManagedInstances.json
- original: preview/2020-11-01-preview/Servers.json <---> new: preview/2020-11-01-preview/Servers.json

Rule	Message
`❌` 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'ResourceIdentity' removed or renamed? New: Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json#L563:3 Old: Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json#L520:3
`❌` 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'ResourceIdentity' removed or renamed? New: Microsoft.Sql/preview/2020-11-01-preview/Servers.json#L414:3 Old: Microsoft.Sql/preview/2020-11-01-preview/Servers.json#L414:3
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'encryptionIdentityId' renamed or removed? New: Microsoft.Sql/preview/2020-11-01-preview/Servers.json#L475:7 Old: Microsoft.Sql/preview/2020-11-01-preview/Servers.json#L437:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'userAssignedIdentities' in response that was not found in the old version. New: Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json#L586:7 Old: resource-manager/common/v1/types.json#L161:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'primaryUserAssignedIdentityId' in response that was not found in the old version. New: Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json#L624:7 Old: Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json#L543:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'keyId' in response that was not found in the old version. New: Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json#L624:7 Old: Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json#L543:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'administrators' in response that was not found in the old version. New: Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json#L624:7 Old: Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json#L543:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'userAssignedIdentities' in response that was not found in the old version. New: Microsoft.Sql/preview/2020-11-01-preview/Servers.json#L437:7 Old: resource-manager/common/v1/types.json#L161:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'primaryUserAssignedIdentityId' in response that was not found in the old version. New: Microsoft.Sql/preview/2020-11-01-preview/Servers.json#L475:7 Old: Microsoft.Sql/preview/2020-11-01-preview/Servers.json#L437:7
`❌` 1043 - AddingOptionalParameter	The optional parameter '$expand' was added in the new version. New: Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json#L37:11

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.9.0 , classic-openapi-validator v1.1.6 )
- sql/resource-manager/readme.md tag:package-preview-2020-11
Linted configuring files (Based on target branch, openapi-validator v1.9.0 , classic-openapi-validator v1.1.6 )
- sql/resource-manager/readme.md tag:package-preview-2020-11

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	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-v4

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️❌[Staging] SDK Track2 Validation: 1 Errors, 1 Warnings failed [Detail]

The following tags are being changed in this PR

sql/resource-manager/readme.md#package-preview-2020-11

Rule	Message
`❌` AutorestCore/Exception	"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2020-11", "details":"Error: Plugin pre-namer reported failure."
⚠️ PreCheck/CheckDuplicateSchemas	"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2020-11", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail."

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-03-12T21:57:52Z

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌ azure-sdk-for-net failed [Detail]

❌Failed [Logs] Generate from f770b4974abf221d63c90a08c8beb46658e7340b. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/sql/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

❌Microsoft.Azure.Management.Sql [View full logs] [Preview SDK Changes]

cmdout	[msbuild] /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Utilities/SqlManagementTestUtilities.cs(230,66): error CS1061: 'Database' does not contain a definition for 'StorageAccountType' and no accessible extension method 'StorageAccountType' accepting a first argument of type 'Database' could be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseCrudScenarioTests.cs(58,21): error CS0117: 'Database' does not contain a definition for 'StorageAccountType' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseCrudScenarioTests.cs(120,21): error CS0117: 'Database' does not contain a definition for 'StorageAccountType' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseRestoreScenarioTests.cs(181,17): error CS0246: The type or namespace name 'BackupLongTermRetentionPolicy' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseRestoreScenarioTests.cs(181,66): error CS1061: 'SqlManagementClient' does not contain a definition for 'BackupLongTermRetentionPolicies' and no accessible extension method 'BackupLongTermRetentionPolicies' accepting a first argument of type 'SqlManagementClient' could be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseRestoreScenarioTests.cs(189,17): error CS0246: The type or namespace name 'BackupLongTermRetentionPolicy' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseRestoreScenarioTests.cs(189,64): error CS0246: The type or namespace name 'BackupLongTermRetentionPolicy' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseRestoreScenarioTests.cs(190,27): error CS1061: 'SqlManagementClient' does not contain a definition for 'BackupLongTermRetentionPolicies' and no accessible extension method 'BackupLongTermRetentionPolicies' accepting a first argument of type 'SqlManagementClient' could be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseRestoreScenarioTests.cs(194,36): error CS1061: 'SqlManagementClient' does not contain a definition for 'BackupLongTermRetentionPolicies' and no accessible extension method 'BackupLongTermRetentionPolicies' accepting a first argument of type 'SqlManagementClient' could be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Utilities/SqlManagementTestUtilities.cs(230,66): error CS1061: 'Database' does not contain a definition for 'StorageAccountType' and no accessible extension method 'StorageAccountType' accepting a first argument of type 'Database' could be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseCrudScenarioTests.cs(58,21): error CS0117: 'Database' does not contain a definition for 'StorageAccountType' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseCrudScenarioTests.cs(120,21): error CS0117: 'Database' does not contain a definition for 'StorageAccountType' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseRestoreScenarioTests.cs(181,17): error CS0246: The type or namespace name 'BackupLongTermRetentionPolicy' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseRestoreScenarioTests.cs(181,66): error CS1061: 'SqlManagementClient' does not contain a definition for 'BackupLongTermRetentionPolicies' and no accessible extension method 'BackupLongTermRetentionPolicies' accepting a first argument of type 'SqlManagementClient' could be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseRestoreScenarioTests.cs(189,17): error CS0246: The type or namespace name 'BackupLongTermRetentionPolicy' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseRestoreScenarioTests.cs(189,64): error CS0246: The type or namespace name 'BackupLongTermRetentionPolicy' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseRestoreScenarioTests.cs(190,27): error CS1061: 'SqlManagementClient' does not contain a definition for 'BackupLongTermRetentionPolicies' and no accessible extension method 'BackupLongTermRetentionPolicies' accepting a first argument of type 'SqlManagementClient' could be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/DatabaseRestoreScenarioTests.cs(194,36): error CS1061: 'SqlManagementClient' does not contain a definition for 'BackupLongTermRetentionPolicies' and no accessible extension method 'BackupLongTermRetentionPolicies' accepting a first argument of type 'SqlManagementClient' could be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: dotnet

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from f770b4974abf221d63c90a08c8beb46658e7340b. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sql/mgmt/2014-04-01/sql [View full logs] [Preview SDK Changes]
```
info	[Changelog] No exported changes
```

️✔️preview/sql/mgmt/v4.0/sql [View full logs] [Preview SDK Changes] Breaking Change Detected