Skip to content

Base commit of SCOM MI PP 20230707 version#25171

Merged
mentat9 merged 6 commits into
mainfrom
SCOMPP20230707
Sep 6, 2023
Merged

Base commit of SCOM MI PP 20230707 version#25171
mentat9 merged 6 commits into
mainfrom
SCOMPP20230707

Conversation

@RBANSALMS

Copy link
Copy Markdown
Contributor

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] public repo review queue, private repo review queue
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue

If you need further help with anything, see Getting help section below.

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:
    • 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:

  • [ X] 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 Step 2, "ARM Review", for this PR.

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

Getting help

@openapi-pipeline-app

openapi-pipeline-app Bot commented Aug 4, 2023

Copy link
Copy Markdown

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: 3 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) new version base version
package-2023-07-07-preview package-2023-07-07-preview(f0ed59c) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ DeprecatedXmsCodeGenerationSetting The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation.
Location: Microsoft.Scom/preview/2023-07-07-preview/scom.json#L7
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Operations_List
Location: Microsoft.Scom/preview/2023-07-07-preview/scom.json#L122
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'setservercount' in:'Instances_Scale'. Consider updating the operationId
Location: Microsoft.Scom/preview/2023-07-07-preview/scom.json#L461
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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.
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot

Copy link
Copy Markdown

Hi, @RBANSALMS! 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-pipeline-app

    openapi-pipeline-app Bot commented Aug 4, 2023

    Copy link
    Copy Markdown

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking


    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs] Generate from 6aea747cfe9bed13e32c6bd98e93ee6750225f93. 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] npm notice
      cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.6.7 -> 10.0.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.0.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.0.0` 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 6aea747cfe9bed13e32c6bd98e93ee6750225f93. 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
      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 6aea747cfe9bed13e32c6bd98e93ee6750225f93. 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/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 6aea747cfe9bed13e32c6bd98e93ee6750225f93. 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-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 failed [Detail]
    • Code Generator Failed [Logs] Generate from 6aea747cfe9bed13e32c6bd98e93ee6750225f93. 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]  ERR! code EBADENGINE
      cmderr	[initScript.sh]  Unsupported engine
      cmderr	[initScript.sh] npm ERR! engine Not compatible with your version of node/npm: npm@10.0.0
      cmderr	[initScript.sh] npm ERR! notsup Not compatible with your version of node/npm: npm@10.0.0
      cmderr	[initScript.sh] npm ERR! notsup Required: {"node":"^18.17.0 || >=20.5.0"}
      cmderr	[initScript.sh] npm ERR! notsup Actual:   {"npm":"8.19.4","node":"v16.20.2"}
      cmderr	[initScript.sh]  A complete log of this run can be found in:
      cmderr	[initScript.sh] npm ERR!     /home/cloudtest/.npm/_logs/2023-09-06T05_23_35_663Z-debug-0.log
      error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
      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
      cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:500
      cmderr	[generateScript.sh]     return new TSError(diagnosticText, diagnosticCodes)
      cmderr	[generateScript.sh]            ^
      cmderr	[generateScript.sh] TSError: ⨯ Unable to compile TypeScript:
      cmderr	[generateScript.sh] cmd/generateall.ts(7,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations.
      cmderr	[generateScript.sh] cmd/generateall.ts(11,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations.
      cmderr	[generateScript.sh] cmd/generateall.ts(12,18): error TS2307: Cannot find module 'path' or its corresponding type declarations.
      cmderr	[generateScript.sh] cmd/generateall.ts(14,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations.
      cmderr	[generateScript.sh] cmd/generateall.ts(15,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations.
      cmderr	[generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
      cmderr	[generateScript.sh] cmd/generateall.ts(64,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
      cmderr	[generateScript.sh] cmd/generateall.ts(81,67): error TS7006: Parameter 'x' implicitly has an 'any' type.
      cmderr	[generateScript.sh] cmd/generateall.ts(82,49): error TS7006: Parameter 'f' implicitly has an 'any' type.
      cmderr	[generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
      cmderr	[generateScript.sh] cmd/generateall.ts(117,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
      cmderr	[generateScript.sh] cmd/generateall.ts(118,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
      cmderr	[generateScript.sh] cmd/generateall.ts(169,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i @types/node` and then add `node` to the types field in your tsconfig.
      cmderr	[generateScript.sh]     at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:500:12)
      cmderr	[generateScript.sh]     at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:504:19)
      cmderr	[generateScript.sh]     at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:739:36)
      cmderr	[generateScript.sh]     at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:955:32)
      cmderr	[generateScript.sh]     at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:1043:43)
      cmderr	[generateScript.sh]     at Module._extensions..js (node:internal/modules/cjs/loader:1252:10)
      cmderr	[generateScript.sh]     at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@3.9.10/node_modules/ts-node/src/index.ts:1046:12)
      cmderr	[generateScript.sh]     at Module.load (node:internal/modules/cjs/loader:1076:32)
      cmderr	[generateScript.sh]     at Function.Module._load (node:internal/modules/cjs/loader:911:12)
      cmderr	[generateScript.sh]     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
      cmderr	[generateScript.sh]  notice
      cmderr	[generateScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.0.0
      cmderr	[generateScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.0.0>
      cmderr	[generateScript.sh] npm notice Run `npm install -g npm@10.0.0` to update!
      cmderr	[generateScript.sh] npm notice
      error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh
      warn	Skip package processing as generation is failed
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app

    openapi-pipeline-app Bot commented Aug 4, 2023

    Copy link
    Copy Markdown

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/scom/armscom https://apiview.dev/Assemblies/Review/3880bdec3bdb4e9092781b02fa4748a0
    Java azure-resourcemanager-scom https://apiview.dev/Assemblies/Review/dd50becc5bd14723a55fecf7c6398edb
    JavaScript @azure/arm-scom https://apiview.dev/Assemblies/Review/5dd22d3c53ad4b9fbdf474760cb8bf59
    Swagger Microsoft.Scom https://apiview.dev/Assemblies/Review/abd438da9cf64a3fad6eb93fe6b84ed0

    @openapi-workflow-bot

    Copy link
    Copy Markdown

    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.

    @openapi-workflow-bot

    Copy link
    Copy Markdown

    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:

  • Follow this guidance Naming for new initial management or client libraries (new SDKs) - Overview (azure.com) to create an issue for management client library name arch board review.
  • Paste the issue link that you created in step 1 in this PR

  • Impact: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed.

    @openapi-workflow-bot

    Copy link
    Copy Markdown

    Hi @RBANSALMS, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.

    @RBANSALMS

    Copy link
    Copy Markdown
    Contributor Author

    GitHub issue for finalizing name of the NameSpace for SDK:
    https://github.com/Azure/azure-sdk-pr/issues/1187

    @RBANSALMS RBANSALMS marked this pull request as ready for review August 4, 2023 15:36
    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Aug 4, 2023
    @RBANSALMS

    Copy link
    Copy Markdown
    Contributor Author

    Link for Private Repo PR: https://github.com/Azure/azure-rest-api-specs-pr/pull/13636
    with one suppression rule and its associated reason.

    @ms-zhenhua ms-zhenhua added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Aug 10, 2023
    @maririos

    Copy link
    Copy Markdown
    Member

    /azp run

    @azure-pipelines

    Copy link
    Copy Markdown
    Azure Pipelines successfully started running 2 pipeline(s).

    @rkmanda

    rkmanda commented Aug 16, 2023

    Copy link
    Copy Markdown
    Member

    Regarding the suppression, I do not see any previous API versions in the public repo. Isnt this the first public API being published? And if so, this is a good time for you to align the folder name with the namespace name following the pascal casing guideline.

    @openapi-pipeline-app

    openapi-pipeline-app Bot commented Aug 16, 2023

    Copy link
    Copy Markdown

    Next Steps to Merge

    ⚠️ This is an experimental comment. It may not always be up-to-date. ⚠️

    ✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

    @rkmanda

    rkmanda commented Aug 17, 2023

    Copy link
    Copy Markdown
    Member

    Reconsider changing the folder name to Pascal casing. Once you are done addressing this, you may place the MergeRequested label again for a request to merge

    @RBANSALMS

    Copy link
    Copy Markdown
    Contributor Author

    Hi @rkmanda,
    Regarding the alignment of the folder name with the namespace name following the pascal casing guideline, if we do this change in the public repo, then there will be inconsistency between private repo and public repo.
    Are we fine with this?

    @RBANSALMS

    Copy link
    Copy Markdown
    Contributor Author

    Pascal casing of folder done. @rkmanda

    @RBANSALMS

    Copy link
    Copy Markdown
    Contributor Author

    /pr RequestMerge

    @mentat9

    mentat9 commented Sep 5, 2023

    Copy link
    Copy Markdown
    Member

    /azp run

    @azure-pipelines

    Copy link
    Copy Markdown
    Azure Pipelines successfully started running 2 pipeline(s).

    @mentat9

    mentat9 commented Sep 5, 2023

    Copy link
    Copy Markdown
    Member

    @RBANSALMS - Your PR needs to pass required checks before merge (azure-sdk-for-go, in this case). Add the MergeRequested label back after addressing those items. If you get stuck, you can ask for help in the API Spec Review Teams channel: https://teams.microsoft.com/l/channel/19%3a0351f5f9404446e4b4fd4eaf2c27448d%40thread.skype/API%2520Spec%2520Review?groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47. Pinned comments on that channel identify help contacts for the various SDK reviewers.

    @akshansh-MSFT

    Copy link
    Copy Markdown
    Contributor

    required checks are now passing

    @RBANSALMS

    Copy link
    Copy Markdown
    Contributor Author

    /pr RequestMerge

    @mentat9 mentat9 merged commit 238fc90 into main Sep 6, 2023
    @mentat9 mentat9 deleted the SCOMPP20230707 branch September 6, 2023 18:05
    jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
    * Base commit of SCOM MI PP 20230707 version
    
    * removing older APIs mention from the readme.md file
    
    * Removing older APIs version refs from readme files
    
    * Renaming  Microsoft.SCOM to Microsoft.Scom
    
    * Renaming  Microsoft.SCOM to Microsoft.Scom 2
    
    * go sdk error fix
    
    ---------
    
    Co-authored-by: RBANSALMS <rbansal@microsoft.com>
    Co-authored-by: Akshansh Sharma <akssharm@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-Suppression ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-MissingBaseCommit new-api-version new-rp-namespace ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS SuppressionReviewRequired

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    8 participants