Tarsharm/follow base #22360

tarsharm · 2023-01-30T14:03:11Z

ARM API Information (Control Plane)

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for 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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

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

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

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

…-01 to version 2020-02-01

openapi-workflow-bot · 2023-01-30T14:03:15Z

Hi, @tarsharm 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 · 2023-01-30T14:03:19Z

Swagger Validation Report

️❌BreakingChange: 312 Errors, 38 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
migrate.json	2020-01-01(f2abc0f)	2020-01-01(main)

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

Rule	Message
`❌` 1012 - RemovedResponseCode	The new version removes the response code '201' Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L997:11
`❌` 1012 - RemovedResponseCode	The new version removes the response code '201' Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L1124:11
`❌` 1012 - RemovedResponseCode	The new version removes the response code '201' Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L1887:11
`❌` 1012 - RemovedResponseCode	The new version removes the response code '201' Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L2014:11
`❌` 1014 - RemovingHeader	The new version removs a required header 'Azure-AsyncOperation'. Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L142:15
`❌` 1014 - RemovingHeader	The new version removs a required header 'Azure-AsyncOperation'. Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L348:15
`❌` 1014 - RemovingHeader	The new version removs a required header 'Azure-AsyncOperation'. Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L1184:15
`❌` 1014 - RemovingHeader	The new version removs a required header 'Azure-AsyncOperation'. Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L1577:15
`❌` 1014 - RemovingHeader	The new version removs a required header 'Azure-AsyncOperation'. Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L1639:15
`❌` 1014 - RemovingHeader	The new version removs a required header 'Azure-AsyncOperation'. Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L2074:15
`❌` 1014 - RemovingHeader	The new version removs a required header 'Azure-AsyncOperation'. Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L2274:15
`❌` 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L5168:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L2748:9
`❌` 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L5557:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L3073:9
`❌` 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L4551:11 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L3281:11
`❌` 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L4571:11 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L3297:11
`❌` 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L1211:13 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L810:13

️❌Breaking Change(Cross-Version): 152 Errors, 71 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
migrate.json	2020-02-01(f2abc0f)	2020-01-01(main)

The following breaking changes are detected by comparison with the latest stable version:

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

Rule	Message
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L9157:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L4031:9
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L9168:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L4042:9
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L9173:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L4047:9
`❌` 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L6892:7 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L3845:7
`❌` 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L6920:7 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L3845:7
`❌` 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L10535:7 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L4524:7
`❌` 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L10563:7 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L4524:7
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v3/types.json#L19:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L2643:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L6186:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L2748:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v3/types.json#L19:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L2791:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L6575:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L3073:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L6686:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L3093:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L6359:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L3237:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L6364:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L3243:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L6368:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L3248:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L6372:9 Old: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L3253:9

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

There is no credential detected.

️🔄LintDiff inProgress [Detail]

️❌Avocado: 140 Errors, 0 Warnings failed [Detail]

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

Rule	Message
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVCluster_Create.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVCluster_Get.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVCluster_ListBySite.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVHostInt_Delete_MaximumSet_Gen.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVHostInt_Delete_MinimumSet_Gen.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVHost_Create.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVHost_Get.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVHost_ListBySite.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVMachine_Get.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVMachines_ListBySite.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVOperationsStatus_Get.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVRunAsAccount_Get.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVRunAsAccounts_ListBySite.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVSiteHealthSummary_Post.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVSiteSummary_Post.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/migrate/resource-manager/readme.md json: stable/2020-01-01/examples/HyperVSite_Create.json

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]

Validation passes for ServiceAPIReadinessTest.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️❌CadlAPIView: 0 Errors, 1 Warnings failed [Detail]

Rule	Message
⚠️ Failed to generate cadl APIView. Please check the detail log and make sure cadl compiler version is the latest.	"How to fix":"Check the detailed log and update cadl version to latest."

️❌ModelValidation: 24 Errors, 0 Warnings failed [Detail]

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

Rule	Message
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L6890:19 ExampleUrl: stable/2020-02-01/examples/HyperVSites_GetSite_MinimumSet_Gen.json#L12:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L6890:19 ExampleUrl: stable/2020-02-01/examples/HyperVSites_PutSite_MinimumSet_Gen.json#L15:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L7761:27 ExampleUrl: stable/2020-02-01/examples/ImportSites_Get_MinimumSet_Gen.json#L12:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L8942:27 ExampleUrl: stable/2020-02-01/examples/ServerSitesInterface_Get_MinimumSet_Gen.json#L12:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L10533:19 ExampleUrl: stable/2020-02-01/examples/Sites_GetSite_MinimumSet_Gen.json#L12:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-02-01/migrate.json#L10533:19 ExampleUrl: stable/2020-02-01/examples/Sites_PutSite_MinimumSet_Gen.json#L15:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L5872:19 ExampleUrl: stable/2020-01-01/examples/HyperVSites_GetSite_MinimumSet_Gen.json#L12:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L5872:19 ExampleUrl: stable/2020-01-01/examples/HyperVSites_PutSite_MinimumSet_Gen.json#L15:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L6684:27 ExampleUrl: stable/2020-01-01/examples/ImportSites_Get_MinimumSet_Gen.json#L12:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L7865:27 ExampleUrl: stable/2020-01-01/examples/ServerSitesInterface_Get_MinimumSet_Gen.json#L12:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L9285:19 ExampleUrl: stable/2020-01-01/examples/Sites_GetSite_MinimumSet_Gen.json#L12:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L9285:19 ExampleUrl: stable/2020-01-01/examples/Sites_PutSite_MinimumSet_Gen.json#L15:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L5872:19 ExampleUrl: stable/2020-01-01/examples/HyperVSites_GetSite_MinimumSet_Gen.json#L12:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L5872:19 ExampleUrl: stable/2020-01-01/examples/HyperVSites_PutSite_MinimumSet_Gen.json#L15:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L6684:27 ExampleUrl: stable/2020-01-01/examples/ImportSites_Get_MinimumSet_Gen.json#L12:15
`❌` MISSING_RESOURCE_ID	id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OffAzure/stable/2020-01-01/migrate.json#L7865:27 ExampleUrl: stable/2020-01-01/examples/ServerSitesInterface_Get_MinimumSet_Gen.json#L12:15

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

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️❌PrettierCheck: 365 Errors, 0 Warnings failed [Detail]

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

Rule	Message
`❌` HowToFix	Code style issues found path: specification/migrate/Migrate.Management/package.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVCluster_GetAllClustersInSite_MaximumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVCluster_GetAllClustersInSite_MinimumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVCluster_GetCluster_MaximumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVCluster_GetCluster_MinimumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVCluster_PutCluster_MaximumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVCluster_PutCluster_MinimumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVHost_GetAllHostsInSite_MaximumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVHost_GetAllHostsInSite_MinimumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVHost_GetHost_MaximumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVHost_GetHost_MinimumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVHost_PutHost_MaximumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVHost_PutHost_MinimumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVJobs_GetAllJobsInSite_MaximumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVJobs_GetAllJobsInSite_MinimumSet_Gen.json
`❌` HowToFix	Code style issues found path: stable/2020-01-01/examples/HyperVJobs_GetJob_MaximumSet_Gen.json

️❌SpellCheck: 54 Errors, 0 Warnings failed [Detail]

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

Rule	Message
`❌` HowToFix	Unknown word (globby), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L134:10
`❌` HowToFix	Unknown word (picocolors), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L140:10
`❌` HowToFix	Unknown word (nodelib), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L205:20
`❌` HowToFix	Unknown word (scandir), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L205:31
`❌` HowToFix	Unknown word (nodelib), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L211:11
`❌` HowToFix	Unknown word (nodelib), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L218:20
`❌` HowToFix	Unknown word (nodelib), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L227:20
`❌` HowToFix	Unknown word (scandir), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L233:22
`❌` HowToFix	Unknown word (fastq), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L234:10
`❌` HowToFix	Unknown word (cliui), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L350:19
`❌` HowToFix	Unknown word (fastq), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L467:19
`❌` HowToFix	Unknown word (reusify), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L473:10
`❌` HowToFix	Unknown word (domexception), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L492:15
`❌` HowToFix	Unknown word (formdata), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L511:19
`❌` HowToFix	Unknown word (globby), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L544:19
`❌` HowToFix	Unknown word (extglob), please fix the error or add words to ./custom-words.txt path: specification/migrate/Migrate.Management/package-lock.json#L591:22

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️❌CadlValidation: 2 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` MissingExamplesDirectory	"details":"The 'examples' directory is missing in the cadl folder specification/migrate/Migrate.Management, please ensure the 'examples' is added in the PR."
`❌` GeneratedSwaggerNotFound	"details":"The generated swagger file from cadl specification/migrate/Migrate.Management can not be found."

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

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

openapi-pipeline-app · 2023-01-30T14:03:20Z

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` RestBuild error	"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=347596&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 "

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

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

❌Failed [Logs] Generate from 44dcbe5d23320e5e1d56529f03fbac55e4e84125. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn		specification/migrate/Migrate.Management/cadl-project.yaml skipped due to azure-sdk-for-net-track2 not found in cadl-project.yaml
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:760
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 760 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

❌Azure.ResourceManager.Migrate [View full logs] [Preview SDK Changes]
```
info	[Changelog]
```

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

❌Code Generator Failed [Logs] Generate from 44dcbe5d23320e5e1d56529f03fbac55e4e84125. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
warn		specification/migrate/Migrate.Management/cadl-project.yaml skipped due to azure-sdk-for-go not found in cadl-project.yaml
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
cmderr	[generator automation-v2] [ERROR] total 1 error(s):
cmderr	[generator automation-v2] [ERROR] failed to execute `go generate` '�[33;1mWARNING: Unable to find version for /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/migrate/armmigrate�[0m
cmderr	[generator automation-v2] [ERROR] Cannot find go module under resourcemanager/migrate/armmigrate, try to build in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/migrate/armmigrate
cmderr	[generator automation-v2] [ERROR] ##[command]Cleaning auto-generated files in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/migrate/armmigrate
cmderr	[generator automation-v2] [ERROR] ##[command]Executing autorest.go in  /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/migrate/armmigrate
cmderr	[generator automation-v2] [ERROR] autorest --version=3.8.2 --use=@autorest/[email protected] --go --track2 --output-folder=/mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/migrate/armmigrate --clear-output-folder=false --go.clear-output-folder=false --honor-body-placement=true --remove-unreferenced-types=false ./autorest.md
cmderr	[generator automation-v2] [ERROR] AutoRest code generation utility [cli version: 3.6.1; node: v16.19.0]
cmderr	[generator automation-v2] [ERROR] (C) 2018 Microsoft Corporation.
cmderr	[generator automation-v2] [ERROR] https://aka.ms/autorest
cmderr	[generator automation-v2] [ERROR] info    | AutoRest core version selected from configuration: 3.8.2.
cmderr	[generator automation-v2] [ERROR] There is a new version of AutoRest available (3.6.3).
cmderr	[generator automation-v2] [ERROR] > You can install the newer version with with npm install -g autorest@latest
cmderr	[generator automation-v2] [ERROR] info    |    Loading AutoRest core      '/home/cloudtest/.autorest/@[email protected]/nodemodules/@autorest/core/dist' (3.8.2)
cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future.
cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future.
cmderr	[generator automation-v2] [ERROR] info    |    Installing AutoRest extension '@autorest/go' (4.0.0-preview.45 -> 4.0.0-preview.45)
cmderr	[generator automation-v2] [ERROR] info    |    Installed AutoRest extension '@autorest/go' (4.0.0-preview.45->4.0.0-preview.45)
cmderr	[generator automation-v2] [ERROR] info    |    Installing AutoRest extension '@autorest/modelerfour' (4.23.1 -> 4.23.1)
cmderr	[generator automation-v2] [ERROR] info    |    Installed AutoRest extension '@autorest/modelerfour' (4.23.1->4.23.1)
cmderr	[generator automation-v2] [ERROR] error   | [Exception] No input files provided.
cmderr	[generator automation-v2] [ERROR] Use --help to get help information or see https://aka.ms/autorest/cli for additional documentation
cmderr	[generator automation-v2] [ERROR] error   |   Error: [Exception] No input files provided.
cmderr	[generator automation-v2] [ERROR] Use --help to get help information or see https://aka.ms/autorest/cli for additional documentation
cmderr	[generator automation-v2] [ERROR] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
cmderr	[generator automation-v2] [ERROR] ##[error]Error running autorest.go
cmderr	[generator automation-v2] [ERROR] build.go:5: running "pwsh": exit status 1
cmderr	[generator automation-v2] [ERROR] ': exit status 1
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation-v2
warn	Skip package processing as generation is failed

️🔄 azure-sdk-for-js inProgress [Detail]

️❌ azure-resource-manager-schemas failed [Detail]

❌Pipeline Framework Failed [Logs] Generate from 44dcbe5d23320e5e1d56529f03fbac55e4e84125. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
cannot force update branch 'sdkAuto/22360/migrate' as it is the current HEAD of the repository.
Error: cannot force update branch 'sdkAuto/22360/migrate' as it is the current HEAD of the repository.

️✔️migrate [View full logs] [Preview Schema Changes]

️✔️migrate [View full logs]

error	Fatal error: cannot force update branch 'sdkAuto/22360/migrate' as it is the current HEAD of the repository.
error	The following packages are still pending:
error		migrate
error		migrate

️❌ azure-powershell failed [Detail]

❌Failed [Logs] Generate from 44dcbe5d23320e5e1d56529f03fbac55e4e84125. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
warn		specification/migrate/Migrate.Management/cadl-project.yaml skipped due to azure-powershell not found in cadl-project.yaml
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

❌Az.migrate [View full logs] [Preview SDK Changes]

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

openapi-pipeline-app · 2023-01-30T14:03:21Z

Generated ApiView

Language	Package Name	ApiView Link
swagger	Microsoft.OffAzure	https://apiview.dev/Assemblies/Review/06cec1755e32446b814bd7c656b98110

openapi-workflow-bot · 2023-01-30T14:13:17Z

Hi @tarsharm, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
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.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

openapi-workflow-bot · 2023-01-30T14:13:18Z

Hi, @tarsharm, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline

akning-ms · 2023-01-31T01:32:23Z

Hi @markcowl , @tarsharm told me The breaking change is caused by CADL generating swagger. can it avoid/fix in CADL file?

openapi-workflow-bot · 2023-02-06T07:19:38Z

Hi @tarsharm This PR was flagged for introducing a new RP namespace that is not being onboarded with RPaaS. Merging this PR to the main branch will be blocked as RPaaS is required for new RPs. To resolve this and allow the PR to be merged into the main branch, please use RPaaS to onboard the new RP.

konrad-jamrozik · 2024-03-12T03:35:32Z

@tarsharm I have removed the Approved-BreakingChange label because it is obsolete. Your PR will have to be re-approved. Please follow the instructions at https://aka.ms/brch. If you provide the reason why your PR was approved in the first place, this will speed up the process and help the Breaking Change Review Board apply appropriate new label. Apologies for the inconvenience!

openapi-pipeline-app · 2024-03-12T03:35:46Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ Your PR has at least one breaking change (label: BreakingChangeReviewRequired). See the PR description for help.
❌ The required check named Swagger PrettierCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.
❌ The required check named Swagger SpellCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

tarsharm and others added 4 commits January 30, 2023 13:10

Adds base for updating Microsoft.OffAzure from version stable/2020-01…

a098f17

…-01 to version 2020-02-01

Updates readme

323d889

Updates API version in new specs and examples

e0d4b78

Add new version

7f5e806

openapi-assignment-bot bot assigned akning-ms Jan 30, 2023

tarsharm marked this pull request as draft January 30, 2023 14:03

AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required Cadl Authored with Cadl CI-MissingBaseCommit new-api-version resource-manager labels Jan 30, 2023

fix errors

41a044c

tarsharm added 8 commits January 31, 2023 08:37

fix errors

aef85f3

Adding cadl files

410e3f3

Adding cadl code

3d539a9

remove unnecessary file

8786f60

Fix Operation status

8835511

add examples

817b2f6

add examples

ca520bb

Fix errrors

6c1c207

akning-ms assigned jianyexi and unassigned akning-ms Feb 2, 2023

tarsharm added 3 commits February 2, 2023 23:00

Fix breaking changes

15a0225

Update response

5ff9c57

Fix breaking changes

c99e1cd

AzureRestAPISpecReview added CI-NewRPNamespaceWithoutRPaaS new-rp-namespace labels Feb 6, 2023

tarsharm added 7 commits February 8, 2023 08:32

Add SingleSPN swagger

083e403

Fix preetier

555a032

remove unnecessary files

f921036

Fix spell check

d917b01

Fix spell check

ad154cb

Update cadl version

9417c41

Update swagger

f92563d

AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Feb 8, 2023

tarsharm added 2 commits February 8, 2023 19:38

Fix runtime exception

9bf6bf3

Merge from latest

8522d69

tarsharm force-pushed the tarsharm/FollowBase branch from 763f06a to 8522d69 Compare February 8, 2023 14:16

Fix runtime exception

5f003dc

AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Feb 8, 2023

mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 13, 2023

tarsharm added 5 commits February 17, 2023 14:02

remove default response

2789543

Adding old json as well

384333c

remove defult

4d53986

remove breaking changes

b5f1f6c

Fix breaking changes

f2abc0f

konrad-jamrozik removed the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tarsharm/follow base #22360

Tarsharm/follow base #22360

tarsharm commented Jan 30, 2023 •

edited by openapi-workflow-bot bot

Loading

openapi-workflow-bot bot commented Jan 30, 2023

openapi-pipeline-app bot commented Jan 30, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jan 30, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Jan 30, 2023 •

edited

Loading

openapi-workflow-bot bot commented Jan 30, 2023

openapi-workflow-bot bot commented Jan 30, 2023

akning-ms commented Jan 31, 2023

openapi-workflow-bot bot commented Feb 6, 2023

konrad-jamrozik commented Mar 12, 2024

openapi-pipeline-app bot commented Mar 12, 2024

Tarsharm/follow base #22360

Are you sure you want to change the base?

Tarsharm/follow base #22360

Conversation

tarsharm commented Jan 30, 2023 • edited by openapi-workflow-bot bot Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jan 30, 2023

openapi-pipeline-app bot commented Jan 30, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jan 30, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Jan 30, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Jan 30, 2023

openapi-workflow-bot bot commented Jan 30, 2023

akning-ms commented Jan 31, 2023

openapi-workflow-bot bot commented Feb 6, 2023

konrad-jamrozik commented Mar 12, 2024

openapi-pipeline-app bot commented Mar 12, 2024

Next Steps to Merge

tarsharm commented Jan 30, 2023 •

edited by openapi-workflow-bot bot

Loading

openapi-pipeline-app bot commented Jan 30, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jan 30, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jan 30, 2023 •

edited

Loading