Automation rules 2022-11-01 - alert & update triggers#21205
Merged
dw511214992 merged 3 commits intoAzure:release-securityinsights-Microsoft.SecurityInsights-2022-11-01from Oct 24, 2022
Conversation
|
Hi, @dosiso Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.1)] | new version | base version |
|---|---|---|
| AutomationRules.json | 2022-11-01(ce2f697) | 2022-08-01(main) |
| AutomationRules.json | 2022-11-01(ce2f697) | 2022-10-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️⚠️LintDiff: 7 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-11 | package-2022-11(ce2f697) | 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] |
|---|---|---|
| 'AutomationRulePropertyArrayChangedConditionSupportedArrayType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L370 |
||
| 'AutomationRulePropertyArrayChangedConditionSupportedChangeType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L402 |
||
| 'AutomationRulePropertyArrayChangedValuesCondition' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L419 |
||
| 'AutomationRulePropertyChangedConditionSupportedChangedType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L430 |
||
| 'AutomationRulePropertyChangedConditionSupportedPropertyType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L452 |
||
| 'AutomationRulePropertyValuesChangedCondition' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L824 |
||
| 'propertyValues' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L836 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Guid used in model definition 'PlaybookActionProperties' for property 'tenantId'. 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/AutomationRules.json#L1000 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L901 |
|
| The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L7 |
|
| 'AutomationRule' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L248 |
|
| 'order' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L274 |
|
| 'AutomationRulePropertyConditionSupportedOperator' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L479 |
|
| 'AutomationRulePropertyValuesCondition' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L844 |
|
| 'propertyValues' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L853 |
|
| 'AutomationRulesList' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L878 |
|
| 'value' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L881 |
|
| 'nextLink' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L887 |
|
| 'ConditionType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L929 |
|
| 'IncidentPropertiesAction' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L956 |
|
| 'PlaybookActionProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L990 |
|
| 'triggersOn' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L1058 |
|
| 'triggersWhen' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json#L1080 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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.
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Oct 20, 2022
|
Hi, @dosiso your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
ityankel
approved these changes
Oct 24, 2022
...yinsights/resource-manager/Microsoft.SecurityInsights/stable/2022-11-01/AutomationRules.json
Show resolved
Hide resolved
Contributor
Author
|
@dw511214992 can we go ahead & merge PR? |
9ab5c65
into
Azure:release-securityinsights-Microsoft.SecurityInsights-2022-11-01
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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.
-[ ] 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.