Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add triggeredAnalyticsRuleRuns API #21977

Conversation

laithhisham
Copy link
Contributor

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 upcoming 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.
    12/27/2022
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    12/26/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, @laithhisham 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 Dec 22, 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.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    compared tags (via openapi-validator v2.0.0) new version base version
    package-preview-2023-02 package-preview-2023-02(27e96dc) package-preview-2023-02(release-Sentinel-2023-02-01-preview)
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️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 Dec 22, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking


    ⚠️azure-sdk-for-js - @azure/arm-securityinsight - 1.0.0-beta.6
    +	Interface BookmarkRelationsListNextOptionalParams no longer has parameter filter
    +	Interface BookmarkRelationsListNextOptionalParams no longer has parameter orderby
    +	Interface BookmarkRelationsListNextOptionalParams no longer has parameter skipToken
    +	Interface BookmarkRelationsListNextOptionalParams no longer has parameter top
    +	Interface EntitiesRelationsListNextOptionalParams no longer has parameter filter
    +	Interface EntitiesRelationsListNextOptionalParams no longer has parameter orderby
    +	Interface EntitiesRelationsListNextOptionalParams no longer has parameter skipToken
    +	Interface EntitiesRelationsListNextOptionalParams no longer has parameter top
    +	Interface EntityQueriesListNextOptionalParams no longer has parameter kind
    +	Interface FileImportsListNextOptionalParams no longer has parameter filter
    +	Interface FileImportsListNextOptionalParams no longer has parameter orderby
    +	Interface FileImportsListNextOptionalParams no longer has parameter skipToken
    +	Interface FileImportsListNextOptionalParams no longer has parameter top
    +	Interface IncidentCommentsListNextOptionalParams no longer has parameter filter
    +	Interface IncidentCommentsListNextOptionalParams no longer has parameter orderby
    +	Interface IncidentCommentsListNextOptionalParams no longer has parameter skipToken
    +	Interface IncidentCommentsListNextOptionalParams no longer has parameter top
    +	Interface IncidentRelationsListNextOptionalParams no longer has parameter filter
    +	Interface IncidentRelationsListNextOptionalParams no longer has parameter orderby
    +	Interface IncidentRelationsListNextOptionalParams no longer has parameter skipToken
    +	Interface IncidentRelationsListNextOptionalParams no longer has parameter top
    +	Interface IncidentsListNextOptionalParams no longer has parameter filter
    +	Interface IncidentsListNextOptionalParams no longer has parameter orderby
    +	Interface IncidentsListNextOptionalParams no longer has parameter skipToken
    +	Interface IncidentsListNextOptionalParams no longer has parameter top
    +	Interface MetadataListNextOptionalParams no longer has parameter filter
    +	Interface MetadataListNextOptionalParams no longer has parameter orderby
    +	Interface MetadataListNextOptionalParams no longer has parameter skip
    +	Interface MetadataListNextOptionalParams no longer has parameter top
    +	Interface ThreatIntelligenceIndicatorsListNextOptionalParams no longer has parameter filter
    +	Interface ThreatIntelligenceIndicatorsListNextOptionalParams no longer has parameter orderby
    +	Interface ThreatIntelligenceIndicatorsListNextOptionalParams no longer has parameter skipToken
    +	Interface ThreatIntelligenceIndicatorsListNextOptionalParams no longer has parameter top
    +	Interface WatchlistItemsListNextOptionalParams no longer has parameter skipToken
    +	Interface WatchlistsListNextOptionalParams no longer has parameter skipToken
    +	Operation Incidents.createTeam has a new signature
    +	Removed Enum KnownEnum13
    +	Type of parameter actionType of interface AutomationRuleAction is changed from "ModifyProperties" | "RunPlaybook" to "AddIncidentTask" | "ModifyProperties" | "RunPlaybook"
    +	Type of parameter additionalData of interface AccountEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface AzureResourceEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface CloudApplicationEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface DnsEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface EntityCommonProperties is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface EntityEdges is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface FileEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface FileHashEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface HostEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface HuntingBookmark is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface IoTDeviceEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface IpEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface MailClusterEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface MailMessageEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface MailboxEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface MalwareEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface NicEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface ProcessEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface RegistryKeyEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface RegistryValueEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface SecurityAlert is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface SecurityGroupEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface SubmissionMailEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface ThreatIntelligenceIndicatorModel is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter additionalData of interface UrlEntity is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: any;
        }
    +	Type of parameter kind of interface EntityQueriesListOptionalParams is changed from Enum13 to Enum14
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d05158e54e1f9c22cf2f52b64d9e2ddccc7105fe. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    • ️✔️Azure.ResourceManager.SecurityInsights [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from d05158e54e1f9c22cf2f52b64d9e2ddccc7105fe. 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]
      cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.4.0` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-securityinsight [View full logs]  [Preview SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group AlertRuleOperations
      info	[Changelog]   - Added operation group GetTriggeredAnalyticsRuleRunsOperations
      info	[Changelog]   - Added operation group TriggeredAnalyticsRuleRunOperations
    ️❌ azure-sdk-for-js failed [Detail]
    • Failed [Logs] Generate from d05158e54e1f9c22cf2f52b64d9e2ddccc7105fe. 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
      cmderr	[automation_generate.sh] [ERROR] Error:
      cmderr	[automation_generate.sh] [ERROR] An error occurred while run build for readme file: "specification/securityinsights/resource-manager/readme.md":
      cmderr	[automation_generate.sh] [ERROR] Err: Error: Command failed: rush build -t @azure/arm-securityinsight
      cmderr	[automation_generate.sh] [ERROR] Stderr: "null"
      cmderr	[automation_generate.sh] [ERROR] Stdout: "null"
      cmderr	[automation_generate.sh] [ERROR] ErrorStack: "Error: Command failed: rush build -t @azure/arm-securityinsight
      cmderr	[automation_generate.sh] [ERROR]     at checkExecSyncError (node:child_process:861:11)
      cmderr	[automation_generate.sh] [ERROR]     at Object.execSync (node:child_process:932:15)
      cmderr	[automation_generate.sh] [ERROR]     at Object.<anonymous> (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/hlc/generateMgmt.js:87:33)
      cmderr	[automation_generate.sh] [ERROR]     at Generator.next (<anonymous>)
      cmderr	[automation_generate.sh] [ERROR]     at fulfilled (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:112:62)
      cmderr	[automation_generate.sh] [ERROR]     at processTicksAndRejections (node:internal/process/task_queues:96:5)"
    • @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]
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Failed [Logs] Generate from d05158e54e1f9c22cf2f52b64d9e2ddccc7105fe. 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
      warn	No file changes detected after generation
    • securityinsights/resource-manager [View full logs
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs] Generate from d05158e54e1f9c22cf2f52b64d9e2ddccc7105fe. 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-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 22, 2022
    @openapi-workflow-bot
    Copy link

    Hi, @laithhisham your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 22, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Java azure-resourcemanager-securityinsights Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    .Net Azure.ResourceManager.SecurityInsights 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 @laithhisham, 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.

    @raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Dec 22, 2022
    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @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 Dec 22, 2022
    @raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Dec 22, 2022
    @openapi-workflow-bot openapi-workflow-bot bot removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Dec 22, 2022
    @dw511214992
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @dw511214992 dw511214992 merged commit e45c95c into Azure:release-Sentinel-2023-02-01-preview Jan 30, 2023
    dw511214992 pushed a commit that referenced this pull request Feb 6, 2023
    * Adds base for updating Microsoft.SecurityInsights from version preview/2022-12-01-preview to version 2023-02-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * add microsoft purview information protection connector kind (#22150)
    
    * Add triggeredAnalyticsRuleRuns API (#21977)
    
    * Add triggeredAnalyticsRuleRuns API
    
    * fix examples path
    
    * run prettier
    
    * fix lint
    
    * fix prettier
    
    * Update readme.md
    
    * draft
    
    * draft
    
    * fixing comments
    
    * fixing nit and param name
    
    * adding requires
    
    * fixing idention
    
    * Update TriggeredAnalyticsRuleRuns.json
    
    adding location header
    
    * Update TriggeredAnalyticsRuleRuns.json
    
    closing headers
    
    * Update TriggeredAnalyticsRuleRuns.json
    
    fixing warnings
    
    * Update TriggeredAnalyticsRuleRuns.json
    
    fixing lint warnings pt 2
    
    * Update TriggeredAnalyticsRuleRuns.json
    
    fixing flatten position
    
    ---------
    
    Co-authored-by: Rotemdvir1 <rotemdvir@microsoft.com>
    Co-authored-by: Rotemdvir1 <95570648+Rotemdvir1@users.noreply.github.com>
    
    * MTP data connector- filter alerts by provider (#22245)
    
    * MTP data connector- filter alerts by provider
    
    * validations
    
    ---------
    
    Co-authored-by: Alexander Feldsher <66358192+alfeldsh@users.noreply.github.com>
    Co-authored-by: Laith Hisham <49263932+laithhisham@users.noreply.github.com>
    Co-authored-by: Rotemdvir1 <rotemdvir@microsoft.com>
    Co-authored-by: Rotemdvir1 <95570648+Rotemdvir1@users.noreply.github.com>
    Co-authored-by: sivanguetta <46525261+sivanguetta@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-BreakingChange-JavaScript CI-FixRequiredOnFailure resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants