azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Psah434 solutions microsoft.solutions 2023 12 01 preview
ARM (Control Plane) API Specification Update Pull Request
[!TIP] Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.
[!NOTE] As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
- [ ] New resource provider.
- [ ] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
- [ ] 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 OpenAPI spec quality issues in S360.
- [ ] Other, please clarify:
- edit this with your clarification
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:
- [ ] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
- [ ] 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 proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the suppressions guide to get approval.
Getting help
- First, please carefully read through this PR description, from top to bottom. Please fill out the
Purpose of this PRandDue diligence checklist. - To understand what you must do next to merge this PR, see the
Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
- If the PR CI checks appear to be stuck in
queuedstate, please add a comment with contents/azp run. This should result in a new comment denoting aPR validation pipelinehas started and the checks should be updated after few minutes. - If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
Next Steps to Merge
✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 10 Warnings warning [Detail]
| Compared specs (v0.10.7) | new version | base version |
|---|---|---|
| managedapplications.json | 2023-12-01-preview(9eef7e1) | 2021-07-01(main) |
| managedapplications.json | 2023-12-01-preview(9eef7e1) | 2021-02-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-preview-2023-12 | package-preview-2023-12(9eef7e1) | 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 |
|---|---|
|
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName} has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L73 |
|
The resource name parameter 'applicationName' should be defined with a 'pattern' restriction. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L73 |
|
GET operation must have response codes 200 and default. In addition, can have 202 if the GET represents the location header polling url. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L74 |
|
Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L100 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L100 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L118 |
|
A 202 response should include an Location response header. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L150 |
|
Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L248 |
|
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L251 |
|
Properties of a PATCH request body must not be required, property:jitAccessEnabled. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L251 |
|
Properties of a PATCH request body must not be required, property:email. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L251 |
|
Properties of a PATCH request body must not be required, property:phone. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L251 |
|
A 202 response should include an Location response header. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L264 |
|
The resource name parameter 'applicationDefinitionName' should be defined with a 'pattern' restriction. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L283 |
|
GET operation must have response codes 200 and default. In addition, can have 202 if the GET represents the location header polling url. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L284 |
|
Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L310 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L310 |
|
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L635 |
|
The path for the CURD methods do not contain a resource type. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L635 |
|
The path must be under a subscription and resource group for tracked resource types. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L635 |
|
/{applicationId} has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L635 |
|
GET operation must have response codes 200 and default. In addition, can have 202 if the GET represents the location header polling url. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L636 |
|
Response code 404 is defined without a x-ms-error-response. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L661 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L661 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L679 |
|
A 202 response should include an Location response header. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L710 |
|
Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L803 |
|
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L806 |
|
Properties of a PATCH request body must not be required, property:jitAccessEnabled. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L806 |
|
Properties of a PATCH request body must not be required, property:email. Location: Microsoft.Solutions/preview/2023-12-01-preview/managedapplications.json#L806 |
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The readme file has more than one default tag. readme: specification/solutions/resource-manager/readme.md |
️️✔️SwaggerAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=424553&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning in generating from 816bb61b7a0d4107e06476c0b0d362f9329c6436. 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] cmderr [automation_generate.sh] npm notice New patch version of npm available! 10.5.0 -> 10.5.2 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.2> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️azure-mgmt-managedapplications [Preview SDK Changes]- azure-mgmt-managedapplications-1.0.0b1.zip
- azure_mgmt_managedapplications-1.0.0b1-py3-none-any.whl
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning in generating from 816bb61b7a0d4107e06476c0b0d362f9329c6436. 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 -> 24.0 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 -> 24.0 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-managedapplications [Preview SDK Changes]- pom.xml
- azure-resourcemanager-managedapplications-1.0.0-beta.4.jar
- azure-resourcemanager-managedapplications-1.0.0-beta.4-sources.jar
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded in generating from 816bb61b7a0d4107e06476c0b0d362f9329c6436. 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/solutions/armmanagedapplications [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 in generating from 816bb61b7a0d4107e06476c0b0d362f9329c6436. 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 cmderr [automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
️✔️@azure/arm-managedapplications [Preview SDK Changes]- azure-arm-managedapplications-3.0.1.tgz
info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-powershell warning [Detail]
⚠️Warning in generating from 816bb61b7a0d4107e06476c0b0d362f9329c6436. 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
⚠️Az.solutions.DefaultTag [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/solutions/armmanagedapplications | https://apiview.dev/Assemblies/Review/c6aea8cee651450692ec7d613455f3b0?revisionId=ed8b426c69da4bc3b08fa3a0ec49cba4 |
| JavaScript | @azure/arm-managedapplications | There is no API change compared with the previous version |
| Java | azure-resourcemanager-managedapplications | https://apiview.dev/Assemblies/Review/0f296bfc8e6247d6b2cca7fa8965f193?revisionId=50d0eaaea5fa4898978e91486b8825fa |
| Swagger | Microsoft.Solutions | https://apiview.dev/Assemblies/Review/6f87d0cb38b141b29454d4a867f31512?revisionId=113434138d8b4b8481e29f93b3b62754 |
And check and fix the model validation errors: https://github.com/Azure/azure-rest-api-specs/pull/28486/checks?check_run_id=23169055079
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.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
And check and fix the model validation errors: https://github.com/Azure/azure-rest-api-specs/pull/28486/checks?check_run_id=23169055079
This has been fixed.