Ramoka/mgrp 0928 s360 #22270

ramoka178 · 2023-01-20T22:43:14Z

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.

openapi-workflow-bot · 2023-01-20T22:43:17Z

Hi, @ramoka178 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. vscswagger@microsoft.com

openapi-pipeline-app · 2023-01-20T22:43:18Z

Swagger Validation Report

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

compared swaggers (via Oad v0.10.4)]	new version	base version
management.json	2021-04-01(540545d)	2021-04-01(main)

Rule	Message
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'nextLink' renamed or removed? New: Microsoft.Management/stable/2021-04-01/management.json#L1068:7 Old: Microsoft.Management/stable/2021-04-01/management.json#L1068:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'nextLink' renamed or removed? New: Microsoft.Management/stable/2021-04-01/management.json#L1474:7 Old: Microsoft.Management/stable/2021-04-01/management.json#L1474:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property '@nextlink' in response that was not found in the old version. New: Microsoft.Management/stable/2021-04-01/management.json#L1068:7 Old: Microsoft.Management/stable/2021-04-01/management.json#L1068:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property '@nextlink' in response that was not found in the old version. New: Microsoft.Management/stable/2021-04-01/management.json#L1474:7 Old: Microsoft.Management/stable/2021-04-01/management.json#L1474:7

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

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

Validation passes for LintDiff.

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2021-04	package-2021-04(540545d)	package-2021-04(main)

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

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

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

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

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

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

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

Validation passed for PoliCheck.

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

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

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

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

Validation passes for Summary.

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

openapi-pipeline-app · 2023-01-20T22:43:19Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go - sdk/resourcemanager/managementgroups/armmanagementgroups - 2.0.0

+	Type of `SubscriptionUnderManagementGroupProperties.Parent` has been changed from `*DescendantParentGroupInfo` to `*ParentGroupBagInfo`

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

️✔️Succeeded [Logs]Release - Generate from 12ac8cc. 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
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/managementgroups/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.ManagementGroups [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.ManagementGroups.2.0.0-beta.nupkg
- Microsoft.Azure.Management.ManagementGroups.2.0.0-beta.symbols.nupkg

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 12ac8cc. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.5.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.5.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.5.0` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-managementgroups [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added model EntitySearchType
info	[Changelog]   - Added model EntityViewParameterType
info	[Changelog]   - Added model ManagementGroupExpandType
info	[Changelog]   - Added model ParentGroupBagInfo

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

️✔️Succeeded [Logs]Release - Generate from 12ac8cc. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-managementgroups [View full logs] [Release SDK Changes]

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

️✔️Succeeded [Logs]Release - Generate from 12ac8cc. 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
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/managementgroups/armmanagementgroups [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Type of `SubscriptionUnderManagementGroupProperties.Parent` has been changed from `*DescendantParentGroupInfo` to `*ParentGroupBagInfo`
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New struct `ParentGroupBagInfo`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 2 additive change(s).

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

️✔️Succeeded [Logs]Release - Generate from 12ac8cc. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-managementgroups [View full logs] [Release SDK Changes] Breaking Change Detected

azure-arm-managementgroups-3.0.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface ParentGroupBagInfo
info	[Changelog]   - Added Type Alias EntitySearchType
info	[Changelog]   - Added Type Alias EntityViewParameterType
info	[Changelog]   - Added Type Alias ManagementGroupExpandType
info	[Changelog]   - Added Enum KnownEntitySearchType
info	[Changelog]   - Added Enum KnownEntityViewParameterType
info	[Changelog]   - Added Enum KnownManagementGroupExpandType
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Interface EntitiesListNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface EntitiesListNextOptionalParams no longer has parameter groupName
info	[Changelog]   - Interface EntitiesListNextOptionalParams no longer has parameter search
info	[Changelog]   - Interface EntitiesListNextOptionalParams no longer has parameter select
info	[Changelog]   - Interface EntitiesListNextOptionalParams no longer has parameter skip
info	[Changelog]   - Interface EntitiesListNextOptionalParams no longer has parameter skiptoken
info	[Changelog]   - Interface EntitiesListNextOptionalParams no longer has parameter top
info	[Changelog]   - Interface EntitiesListNextOptionalParams no longer has parameter view
info	[Changelog]   - Interface ManagementGroupsGetDescendantsNextOptionalParams no longer has parameter skiptoken
info	[Changelog]   - Interface ManagementGroupsGetDescendantsNextOptionalParams no longer has parameter top
info	[Changelog]   - Interface ManagementGroupsListNextOptionalParams no longer has parameter skiptoken
info	[Changelog]   - Interface ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupNextOptionalParams no longer has parameter skiptoken
info	[Changelog]   - Type of parameter search of interface EntitiesListOptionalParams is changed from Enum2 to EntitySearchType
info	[Changelog]   - Type of parameter view of interface EntitiesListOptionalParams is changed from Enum3 to EntityViewParameterType
info	[Changelog]   - Type of parameter expand of interface ManagementGroupsGetOptionalParams is changed from Enum0 to ManagementGroupExpandType
info	[Changelog]   - Type of parameter parent of interface SubscriptionUnderManagementGroup is changed from DescendantParentGroupInfo to ParentGroupBagInfo
info	[Changelog]   - Removed Enum KnownEnum0
info	[Changelog]   - Removed Enum KnownEnum2
info	[Changelog]   - Removed Enum KnownEnum3
info	[Changelog]   - Removed Enum KnownManagementGroupChildType
info	[Changelog]   - Removed Enum KnownPermissions

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 12ac8cc. 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
warn	No file changes detected after generation

️✔️managementgroups [View full logs]

️️✔️ azure-powershell succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 12ac8cc. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

️✔️Az.ManagementGroupsApi [View full logs] [Release SDK Changes]
- Az.ManagementGroupsApi.0.1.0.nupkg

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

openapi-pipeline-app · 2023-01-20T22:43:20Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/managementgroups/armmanagementgroups	https://apiview.dev/Assemblies/Review/fceb97e598cd4838801f6c5af11d8d0d
Java	azure-resourcemanager-managementgroups	https://apiview.dev/Assemblies/Review/a712d542b3644dadad0e036952f7d26e
JavaScript	@azure/arm-managementgroups	https://apiview.dev/Assemblies/Review/2fcb8283b066450b8081b50cef093b4b

openapi-workflow-bot · 2023-01-20T22:49:55Z

Hi @ramoka178, 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.

raych1 · 2023-01-21T01:57:27Z

Hi @ramoka178, 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.

@ramoka178 , please follow above instructions to get breaking change review.

ramoka178 · 2023-02-01T21:42:04Z

Created one at https://msazure.visualstudio.com/One/_workitems/edit/16981120

* Add blockchain to latest profile * Add additional types * fixing nextlink --------- Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>

markcowl and others added 5 commits August 21, 2019 19:39

Add blockchain to latest profile

1bcc20d

Add additional types

7b46097

Merge remote-tracking branch 'upstream/main' into main

30f98d0

Merge remote-tracking branch 'upstream/main' into main

14cbe15

fixing nextlink

540545d

openapi-assignment-bot bot assigned raych1 Jan 20, 2023

openapi-workflow-bot bot added the FixS360 label Jan 20, 2023

AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required resource-manager labels Jan 20, 2023

azure-sdk mentioned this pull request Jan 20, 2023

[AutoPR sdk/resourcemanager/managementgroups/armmanagementgroups] Ramoka/mgrp 0928 s360 azure-sdk/azure-sdk-for-go#4054

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Jan 20, 2023

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

raych1 approved these changes Feb 22, 2023

View reviewed changes

raych1 merged commit 12ac8cc into Azure:main Feb 22, 2023

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label Feb 22, 2023

azure-sdk mentioned this pull request Feb 22, 2023

[ReleasePR Az.ManagementGroupsApi] Ramoka/mgrp 0928 s360 Azure/azure-powershell#18512

Closed

ramoka178 mentioned this pull request Feb 28, 2023

MGRP S360 Vuln #22832

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ramoka/mgrp 0928 s360 #22270

Ramoka/mgrp 0928 s360 #22270

ramoka178 commented Jan 20, 2023 •

edited

Loading

openapi-workflow-bot bot commented Jan 20, 2023

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

edited

Loading

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

edited

Loading

Breaking Changes Tracking

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

edited

Loading

openapi-workflow-bot bot commented Jan 20, 2023

raych1 commented Jan 21, 2023

ramoka178 commented Feb 1, 2023

Ramoka/mgrp 0928 s360 #22270

Ramoka/mgrp 0928 s360 #22270

Conversation

ramoka178 commented Jan 20, 2023 • edited 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 20, 2023

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

Swagger Validation Report

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

Swagger Generation Artifacts

Breaking Changes Tracking

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

Generated ApiView

openapi-workflow-bot bot commented Jan 20, 2023

raych1 commented Jan 21, 2023

ramoka178 commented Feb 1, 2023

ramoka178 commented Jan 20, 2023 •

edited

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading