Skip to content

SecurityMLAnalyticsSettings to Microsoft.SecurityInsights-2022-11-01-stable#20944

Merged
dw511214992 merged 2 commits intoAzure:release-securityinsights-Microsoft.SecurityInsights-2022-11-01from
jungph808:dev-securityinsights-Microsoft.SecurityInsights-2022-11-01-SecurityMLAnalyticsSettings
Oct 12, 2022
Merged

SecurityMLAnalyticsSettings to Microsoft.SecurityInsights-2022-11-01-stable#20944
dw511214992 merged 2 commits intoAzure:release-securityinsights-Microsoft.SecurityInsights-2022-11-01from
jungph808:dev-securityinsights-Microsoft.SecurityInsights-2022-11-01-SecurityMLAnalyticsSettings

Conversation

@jungph808
Copy link
Contributor

@jungph808 jungph808 commented Sep 29, 2022

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:

  1. 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
  2. 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. November 2022
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. November 2022
  4. 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):

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
      -[x] 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
Copy link

Hi, @jungph808 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
    Copy link

    openapi-pipeline-app bot commented Sep 29, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.9.7)] new version base version
    SecurityMLAnalyticsSettings.json 2022-11-01(bc5f758) 2022-10-01-preview(main)
    ️⚠️LintDiff: 3 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-11 package-2022-11(bc5f758) package-2022-11(release-securityinsights-Microsoft.SecurityInsights-2022-11-01)

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

    Rule Message Related RPC [For API reviewers]
    ⚠️ R3017 - GuidUsage Guid used in model definition 'AnomalySecurityMLAnalyticsSettingsProperties' for property 'settingsDefinitionId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/stable/2022-11-01/SecurityMLAnalyticsSettings.json#L388
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled
    Location: Microsoft.SecurityInsights/stable/2022-11-01/SecurityMLAnalyticsSettings.json#L328
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDefaultSettings
    Location: Microsoft.SecurityInsights/stable/2022-11-01/SecurityMLAnalyticsSettings.json#L379
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/bc5f7583382354681445c987887181d13857ae79/specification/securityinsights/resource-manager/readme.md#tag-package-2022-11">securityinsights/resource-manager/readme.md#package-2022-11
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ Modeler/MissingType "readme":"securityinsights/resource-manager/readme.md",
    "tag":"package-2022-11",
    "details":"The schema 'components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2022-11-01/ThreatIntelligence.json#/components/schemas/components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties"


    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"securityinsights/resource-manager/readme.md",
    "tag":"package-2022-11",
    "details":"Schema 'MCASDataConnectorDataTypes' has a property 'alerts' that is already declared the parent schema 'AlertsDataTypeOfDataConnector' but isn't significantly different. The property has been removed from MCASDataConnectorDataTypes"
    ⚠️ UnkownSecurityScheme "readme":"securityinsights/resource-manager/readme.md",
    "tag":"package-2022-11",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️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
    Copy link

    openapi-pipeline-app bot commented Sep 29, 2022

    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-net failed [Detail]
    • Failed [Logs] Generate from 7fe34459a10562e99c79e8abfafb9d062743c117. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      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/securityinsights/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
      cmderr	[Autorest] No usable version of the libssl was found
      cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
      cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
      warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 7fe34459a10562e99c79e8abfafb9d062743c117. 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
    • ️✔️track2_azure-mgmt-securityinsight [View full logs]  [Preview SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group SecurityMLAnalyticsSettingsOperations
      info	[Changelog]   - Model FusionAlertRule has a new parameter techniques
      info	[Changelog]   - Model FusionAlertRuleTemplate has a new parameter techniques
      info	[Changelog]   - Model IncidentOwnerInfo has a new parameter owner_type
      info	[Changelog]   - Model ScheduledAlertRule has a new parameter techniques
      info	[Changelog]   - Model ScheduledAlertRuleProperties has a new parameter techniques
      info	[Changelog]   - Model ScheduledAlertRuleTemplate has a new parameter techniques
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 7fe34459a10562e99c79e8abfafb9d062743c117. 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-securityinsight [View full logs]  [Preview SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 7fe34459a10562e99c79e8abfafb9d062743c117. 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-securityinsights [View full logs]  [Preview SDK Changes]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 7fe34459a10562e99c79e8abfafb9d062743c117. 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
    • ️✔️securityinsights [View full logs]  [Preview Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs] Generate from 7fe34459a10562e99c79e8abfafb9d062743c117. 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.securityinsights [View full logs]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 29, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Python track2_azure-mgmt-securityinsight Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    JavaScript @azure/arm-securityinsight Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @openapi-workflow-bot
    Copy link

    Hi @jungph808, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @jungph808
    Copy link
    Contributor Author

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 10, 2022
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 10, 2022
    @jungph808 jungph808 marked this pull request as draft October 11, 2022 15:28
    @jungph808 jungph808 marked this pull request as ready for review October 12, 2022 02:57
    @dw511214992 dw511214992 merged commit 5b1d4a4 into Azure:release-securityinsights-Microsoft.SecurityInsights-2022-11-01 Oct 12, 2022
    dw511214992 pushed a commit that referenced this pull request Nov 21, 2022
    * Adds base for updating Microsoft.SecurityInsights from version stable/2022-08-01 to version 2022-11-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * SecurityMLAnalyticsSettings to Microsoft.SecurityInsights-2022-11-01-stable (#20944)
    
    * update
    
    * update api versions
    
    * Automation rules 2022-11-01 - alert & update triggers (#21205)
    
    * Automation rules 2022-11-01 stable version
    
    * preetier
    
    * Remove unused url parameters
    
    Co-authored-by: jungph808 <100548649+jungph808@users.noreply.github.com>
    Co-authored-by: Dor Siso <60354892+dosiso@users.noreply.github.com>
    anandanthony pushed a commit to anandMicro/azure-rest-api-specs that referenced this pull request Dec 16, 2022
    …e#21540)
    
    * Adds base for updating Microsoft.SecurityInsights from version stable/2022-08-01 to version 2022-11-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * SecurityMLAnalyticsSettings to Microsoft.SecurityInsights-2022-11-01-stable (Azure#20944)
    
    * update
    
    * update api versions
    
    * Automation rules 2022-11-01 - alert & update triggers (Azure#21205)
    
    * Automation rules 2022-11-01 stable version
    
    * preetier
    
    * Remove unused url parameters
    
    Co-authored-by: jungph808 <100548649+jungph808@users.noreply.github.com>
    Co-authored-by: Dor Siso <60354892+dosiso@users.noreply.github.com>
    kayousef-zz pushed a commit to kayousef-zz/azure-rest-api-specs that referenced this pull request Dec 21, 2022
    …e#21540)
    
    * Adds base for updating Microsoft.SecurityInsights from version stable/2022-08-01 to version 2022-11-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * SecurityMLAnalyticsSettings to Microsoft.SecurityInsights-2022-11-01-stable (Azure#20944)
    
    * update
    
    * update api versions
    
    * Automation rules 2022-11-01 - alert & update triggers (Azure#21205)
    
    * Automation rules 2022-11-01 stable version
    
    * preetier
    
    * Remove unused url parameters
    
    Co-authored-by: jungph808 <100548649+jungph808@users.noreply.github.com>
    Co-authored-by: Dor Siso <60354892+dosiso@users.noreply.github.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-FixRequiredOnFailure ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants