azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
Updates for 2023-04-01
ARM (Control Plane) API Specification Update Pull Request
Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
- [x] New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
- [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
- [ ] Update existing version to fix swagger quality issues in S360.
- [ ] Other, please clarify:
- This is a new API version with a breaking change. Breaking change being: on a non-existing resource of type Microsoft.Management/managementGroup, ARM will be returning 404 instead of the current 403. Logic for change in status code is happening in ARM and not in RP. Attaching
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:
- [x] I have reviewed the general guidance on the spec PR review process: https://aka.ms/specprreview.
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data-plane related specifications.
- [x] I commit to follow the Breaking Change Policy.
- [x] I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can request review from an ARM API Review board. This has been approved by the breaking change review team as well.
ARM API changes review
- If you want for the ARM team to review this PR, you must add the
ARMReviewlabel. - The automation may automatically add the
ARMReviewlabel, if appropriate.
If this happens, proceed according to guidance given in GitHub comments also added by the automation.
Breaking change review
If you have any breaking changes as defined in the Breaking Change Policy, follow the process outlined in the High-level Breaking Change Process doc.
Getting help
- For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For additional help, see https://aka.ms/azsdk/support/spectools.
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 33 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| management.json | 2023-04-01(f369a67) | 2021-04-01(main) |
| management.json | 2023-04-01(f369a67) | 2018-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2023-04 | package-2023-04(f369a67) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response in the GET collection operation 'ManagementGroups_List' does not match the response definition in the individual GET operation 'ManagementGroups_Get' . Location: Microsoft.Management/stable/2023-04-01/management.json#L51 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Management/stable/2023-04-01/management.json#L72 |
|
The path for 'put' operation must be under a subscription and resource group. Location: Microsoft.Management/stable/2023-04-01/management.json#L93 |
|
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Management/stable/2023-04-01/management.json#L100 |
|
Query parameter $recurse should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Management/stable/2023-04-01/management.json#L100 |
|
Query parameter $filter should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Management/stable/2023-04-01/management.json#L100 |
|
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.Management/stable/2023-04-01/management.json#L152 |
|
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.Management/stable/2023-04-01/management.json#L152 |
|
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: 'ManagementGroups_CreateOrUpdate' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema' Location: Microsoft.Management/stable/2023-04-01/management.json#L152 |
|
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.Management/stable/2023-04-01/management.json#L172 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Management/stable/2023-04-01/management.json#L198 |
|
The property 'displayName' in the request body either not apppear in the resource model or has the wrong level. Location: Microsoft.Management/stable/2023-04-01/management.json#L228 |
|
The property 'parentGroupId' in the request body either not apppear in the resource model or has the wrong level. Location: Microsoft.Management/stable/2023-04-01/management.json#L228 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Management/stable/2023-04-01/management.json#L292 |
|
The path for 'put' operation must be under a subscription and resource group. Location: Microsoft.Management/stable/2023-04-01/management.json#L352 |
|
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.Management/stable/2023-04-01/management.json#L373 |
|
The response in the GET collection operation 'HierarchySettings_List' does not match the response definition in the individual GET operation 'HierarchySettings_Get' . Location: Microsoft.Management/stable/2023-04-01/management.json#L516 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Management/stable/2023-04-01/management.json#L534 |
|
The path for 'put' operation must be under a subscription and resource group. Location: Microsoft.Management/stable/2023-04-01/management.json#L552 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Management/stable/2023-04-01/management.json#L570 |
|
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: 'HierarchySettings_CreateOrUpdate' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.Management/stable/2023-04-01/management.json#L587 |
|
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.Management/stable/2023-04-01/management.json#L604 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Management/stable/2023-04-01/management.json#L675 |
|
The response schema of operations API '/providers/Microsoft.Management/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Management/stable/2023-04-01/management.json#L708 |
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.Management/stable/2023-04-01/management.json#L709 |
|
$skiptoken is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Management/stable/2023-04-01/management.json#L772 |
|
$skip is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Management/stable/2023-04-01/management.json#L772 |
|
$top is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Management/stable/2023-04-01/management.json#L772 |
|
$select is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Management/stable/2023-04-01/management.json#L772 |
|
$search is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Management/stable/2023-04-01/management.json#L772 |
️️✔️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.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @ramoka178! Thank you for your pull request. To help get your PR merged: - Ensure you reviewed the checklists in the PR description. - Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval. - For convenient view of the API changes made by this PR, refer to the URLs provided in the table in
the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
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-js - @azure/arm-managementgroups - 3.0.0+ Interface EntitiesListNextOptionalParams no longer has parameter filter + Interface EntitiesListNextOptionalParams no longer has parameter groupName + Interface EntitiesListNextOptionalParams no longer has parameter search + Interface EntitiesListNextOptionalParams no longer has parameter select + Interface EntitiesListNextOptionalParams no longer has parameter skip + Interface EntitiesListNextOptionalParams no longer has parameter skiptoken + Interface EntitiesListNextOptionalParams no longer has parameter top + Interface EntitiesListNextOptionalParams no longer has parameter view + Interface ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupNextOptionalParams no longer has parameter skiptoken + Interface ManagementGroupsGetDescendantsNextOptionalParams no longer has parameter skiptoken + Interface ManagementGroupsGetDescendantsNextOptionalParams no longer has parameter top + Interface ManagementGroupsListNextOptionalParams no longer has parameter skiptoken + Removed Enum KnownEnum0 + Removed Enum KnownEnum2 + Removed Enum KnownEnum3 + Removed Enum KnownManagementGroupChildType + Removed Enum KnownPermissions + Type of parameter expand of interface ManagementGroupsGetOptionalParams is changed from Enum0 to ManagementGroupExpandType + Type of parameter search of interface EntitiesListOptionalParams is changed from Enum2 to EntitySearchType + Type of parameter view of interface EntitiesListOptionalParams is changed from Enum3 to EntityViewParameterType
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from d0264e8667c7ea009997a991b8ba8cc52f970844. SDK Automation 14.0.0command 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 [email protected]/[email protected] --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
️✔️Microsoft.Azure.Management.ManagementGroups [View full logs] [Preview SDK Changes]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from d0264e8667c7ea009997a991b8ba8cc52f970844. SDK Automation 14.0.0command 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] npm notice cmderr [automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.8.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-managementgroups [View full logs] [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Added model EntitySearchType info [Changelog] - Added model EntityViewParameterType info [Changelog] - Added model ManagementGroupExpandType
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from d0264e8667c7ea009997a991b8ba8cc52f970844. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip 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] [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from d0264e8667c7ea009997a991b8ba8cc52f970844. SDK Automation 14.0.0command 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] [Preview SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from d0264e8667c7ea009997a991b8ba8cc52f970844. SDK Automation 14.0.0command 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] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] 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] - 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] Generate from d0264e8667c7ea009997a991b8ba8cc52f970844. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] 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
️✔️managementgroups [View full logs] [Preview Schema Changes]
️❌ azure-powershell failed [Detail]
❌Pipeline Framework Failed [Logs] Generate from d0264e8667c7ea009997a991b8ba8cc52f970844. SDK Automation 14.0.0command 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 SSL error: syscall failure: Broken pipe Error: SSL error: syscall failure: Broken pipe
️✔️Az.managementgroups.DefaultTag [View full logs]error Fatal error: SSL error: syscall failure: Broken pipe error The following packages are still pending: error Az.managementgroups.DefaultTag
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | Microsoft.Management | https://apiview.dev/Assemblies/Review/b664cc359c154a1cb4faf6122446dc4e |
| Go | sdk/resourcemanager/managementgroups/armmanagementgroups | There is no API change compared with the previous version |
| Java | azure-resourcemanager-managementgroups | There is no API change compared with the previous version |
| JavaScript | @azure/arm-managementgroups | https://apiview.dev/Assemblies/Review/65a542152b3c4abdbacfacdf513f983d |
Hi @ramoka178! 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.
https://msazure.visualstudio.com/One/_workitems/edit/23007234 is the workitem related to this breaking change. An email conversation is also attached in this - which suggests to link the discussion during Swagger PR.
https://msazure.visualstudio.com/One/_workitems/edit/23007234 is the workitem related to this breaking change. An email conversation is also attached in this - which suggests to link the discussion during Swagger PR.
Hi @ramoka178! 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.
Can you please add the previous version as the base commit. Also this PR does not seem to be using Openapi hub as per the first checked comment ?
Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.
Hi, @ramoka178. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
![microsoft-github-policy-service[bot] avatar](https://avatars.githubusercontent.com/in/95686?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @ramoka178. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Hi, @ramoka178. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.