azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
SCOMRPFromPrivateToPublic 1
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!
- [ ] 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:
- 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 have reviewed the general guidance on the spec PR review process: https://aka.ms/specprreview.
- [ ] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data-plane related specifications.
- [ ] I commit to follow the Breaking Change Policy.
- [ ] 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.
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.
Hi, @RBANSALMS! Thank you for your pull request. To help get your PR merged:
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 Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 126 Errors, 19 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2021-06-30-preview | package-2021-06-30-preview(64f7f5f) | default(main) |
| package-2022-04-30-preview | package-2022-04-30-preview(64f7f5f) | default(main) |
| package-2022-09-13-preview | package-2022-09-13-preview(64f7f5f) | default(main) |
| package-2023-06-30 | package-2023-06-30(64f7f5f) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Operations API must be implemented for 'Microsoft.Scom'. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L1 |
|
|
The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L50 |
RPC-Uri-V1-03 |
|
The response schema of operations API '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scom/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L74 |
|
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L75 |
RPC-Operations-V1-01 |
|
The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L92 |
RPC-Uri-V1-03 |
|
The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L134 |
RPC-Uri-V1-03 |
|
The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L173 |
RPC-Uri-V1-03 |
|
The resource name parameter 'instanceName' should be defined with a 'pattern' restriction. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L173 |
RPC-Uri-V1-05 |
|
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L240 |
RPC-Put-V1-11 |
|
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L240 |
RPC-Put-V1-11 |
|
LRO PATCH must have 200 and 202 return codes. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L270 |
|
|
The async patch operation should return 202. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L298 |
RPC-Patch-V1-06, RPC-Async-V1-08 |
|
A 202 response should include an Location response header. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L352 |
RPC-Async-V1-07 |
|
The schema 'OperationsList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L378 |
|
|
Missing identifier id in array item property Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L381 |
|
|
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L404 |
|
|
The schema 'MonitoringInstance' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L446 |
|
|
The schema 'MonitoringInstanceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L464 |
|
|
Missing identifier id in array item property Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L482 |
|
|
The schema 'ManagementServerProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L529 |
|
|
The schema 'DomainControllerProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L549 |
|
|
The schema 'DomainUserCredentials' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L562 |
|
|
The schema 'AzureHybridBenefitProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L612 |
|
|
The schema 'MonitoringInstanceList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2021-06-30-preview/scom.json#L629 |
|
|
Operations API must be implemented for 'Microsoft.Scom'. Location: Microsoft.SCOM/preview/2022-04-30-preview/scom.json#L1 |
|
|
The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2022-04-30-preview/scom.json#L50 |
RPC-Uri-V1-03 |
|
The response schema of operations API '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scom/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.SCOM/preview/2022-04-30-preview/scom.json#L74 |
|
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.SCOM/preview/2022-04-30-preview/scom.json#L75 |
RPC-Operations-V1-01 |
|
The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2022-04-30-preview/scom.json#L92 |
RPC-Uri-V1-03 |
|
The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2022-04-30-preview/scom.json#L134 |
RPC-Uri-V1-03 |
️️✔️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: 10 Errors, 0 Warnings failed [Detail]
️️✔️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.
️️✔️All merging requirements met succeeded [Detail] [Expand]
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?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.
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning [Logs] Generate from a52d182c641de4fc21893c485792d7f3205dd10a. 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 minor version of npm available! 9.5.1 -> 9.8.1 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice warn No file changes detected after generation warn No package detected after generation
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from a52d182c641de4fc21893c485792d7f3205dd10a. 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.2.1 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.2.1 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-scom [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from a52d182c641de4fc21893c485792d7f3205dd10a. 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/scom/armscom [View full logs] [Preview SDK Changes]info [Changelog] This is a new package info [Changelog]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from a52d182c641de4fc21893c485792d7f3205dd10a. 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-scom [View full logs] [Preview SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs] Generate from a52d182c641de4fc21893c485792d7f3205dd10a. 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] 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
️✔️scom [View full logs] [Preview Schema Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | Microsoft.SCOM | https://apiview.dev/Assemblies/Review/b80deb3e632d434c9f330d95b0a89ce0 |
| Go | sdk/resourcemanager/scom/armscom | https://apiview.dev/Assemblies/Review/b68f85f9b0144a4689e2d2687e550639 |
| Java | azure-resourcemanager-scom | https://apiview.dev/Assemblies/Review/3704c8d14a2544a093601e76cfe5c6d8 |
| JavaScript | @azure/arm-scom | https://apiview.dev/Assemblies/Review/fdf3610182794182a687f03d8c5e8dfd |
Hi @RBANSALMS! 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.
Hi, @RBANSALMS, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved. Action Required:
Earlier I had created this PR https://github.com/Azure/azure-rest-api-specs/pull/24608 to move SCOM MI swagger from private repo to Public repo, but due to no interaction on that PR, I have created this PR now.
Hi @RBANSALMS! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic Validation | Fix-SemanticValidation-Error | High |
| Model Validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | High |
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.
GitHub issue for finalizing name of the NameSpace for SDK: [Board Review: Management Plane Namespace Review Microsoft.Scom · Issue #1187 · Azure/azure-sdk-pr (github.com)](https://github.com/Azure/azure-sdk-pr/issues/1187)
Hi @RBANSALMS! Your PR has some issues. Please fix the CI issues, if present, in following order:
Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.Task How to fix Priority Avocado Fix-Avocado High Semantic Validation Fix-SemanticValidation-Error High Model Validation Fix-ModelValidation-Error High LintDiff Fix-LintDiff High
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.
Please fix these and afterwards, remove ARMChangesRequest label for ARM to review this swagger.
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.
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
Opened new PR with Just PP APIs: https://github.com/Azure/azure-rest-api-specs/pull/25148