removing undocumented alert rule types #12575
Merged
Conversation
This file contains 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
|
Hi, @Amitbergman 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. vsswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version is removing enum value(s) 'Anomaly' from the old version. Old: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L180:9 |
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌[Staging] SDK Track2 Validation: 8 Errors, 47 Warnings failed [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2019-01-preview-only", "details":"Duplicate Schema named AggregationsKind -- properties: "kind":"description":"The kind of the setting", "$ref":"#/components/schemas/AggregationsKind" =>, type: undefined => "string", required: ["kind"] =>, enum: undefined => ["CasesAggregation"], x-ms-enum: undefined => "modelAsString":true, "name":"AggregationsKind" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2019-01-preview-only", "details":"Duplicate Schema named AlertRuleKind -- properties: "kind":"description":"The kind of the alert rule", "$ref":"#/components/schemas/AlertRuleKind" =>, type: undefined => "string", required: ["kind"] =>, enum: undefined => ["Scheduled", "MicrosoftSecurityIncidentCreation", "Fusion", "MLBehaviorAnalytics", "ThreatIntelligence"], x-ms-enum: undefined => "modelAsString":true, "name":"AlertRuleKind", "values":["value":"Scheduled", "value":"MicrosoftSecurityIncidentCreation", "value":"Fusion", "value":"MLBehaviorAnalytics", "value":"ThreatIntelligence"] ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2019-01-preview-only", "details":"Duplicate Schema named DataConnectorKind -- properties: "kind":"description":"The kind of the data connector", "$ref":"#/components/schemas/DataConnectorKind" =>, type: undefined => "string", required: ["kind"] =>, enum: undefined => ["AzureActiveDirectory", "AzureSecurityCenter", "MicrosoftCloudAppSecurity", "ThreatIntelligence", "ThreatIntelligenceTaxii", "Office365", "OfficeATP", "AmazonWebServicesCloudTrail", "AzureAdvancedThreatProtection", "MicrosoftDefenderAdvancedThreatProtection", "Dynamics365", "MicrosoftThreatProtection", "MicrosoftThreatIntelligence"], x-ms-enum: undefined => "modelAsString":true, "name":"DataConnectorKind", "values":["value":"AzureActiveDirectory", "value":"AzureSecurityCenter", "value":"MicrosoftCloudAppSecurity", "value":"ThreatIntelligence", "value":"ThreatIntelligenceTaxii", "value":"Office365", "value":"OfficeATP", "value":"AmazonWebServicesCloudTrail", "value":"AzureAdvancedThreatProtection", "value":"MicrosoftDefenderAdvancedThreatProtection", "value":"Dynamics365", "value":"MicrosoftThreatProtection", "value":"MicrosoftThreatIntelligence"] ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2019-01-preview-only", "details":"Duplicate Schema named EntityKind -- properties: "kind":"description":"The kind of the entity.", "$ref":"#/components/schemas/EntityKind" =>, type: undefined => "string", required: ["kind"] =>, enum: undefined => ["Account", "Host", "File", "AzureResource", "CloudApplication", "DnsResolution", "FileHash", "Ip", "Malware", "Process", "RegistryKey", "RegistryValue", "SecurityGroup", "Url", "IoTDevice", "SecurityAlert", "Bookmark", "Mailbox", "MailCluster", "MailMessage", "SubmissionMail"], x-ms-enum: undefined => "modelAsString":true, "name":"EntityKind", "values":["description":"Entity represents account in the system.", "value":"Account", "description":"Entity represents host in the system.", "value":"Host", "description":"Entity represents file in the system.", "value":"File", "description":"Entity represents azure resource in the system.", "value":"AzureResource", "description":"Entity represents cloud application in the system.", "value":"CloudApplication", "description":"Entity represents dns resolution in the system.", "value":"DnsResolution", "description":"Entity represents file hash in the system.", "value":"FileHash", "description":"Entity represents ip in the system.", "value":"Ip", "description":"Entity represents malware in the system.", "value":"Malware", "description":"Entity represents process in the system.", "value":"Process", "description":"Entity represents registry key in the system.", "value":"RegistryKey", "description":"Entity represents registry value in the system.", "value":"RegistryValue", "description":"Entity represents security group in the system.", "value":"SecurityGroup", "description":"Entity represents url in the system.", "value":"Url", "description":"Entity represents IoT device in the system.", "value":"IoTDevice", "description":"Entity represents security alert in the system.", "value":"SecurityAlert", "description":"Entity represents bookmark in the system.", "value":"Bookmark", "description":"Entity represents mail cluster in the system.", "value":"MailCluster", "description":"Entity represents mail message in the system.", "value":"MailMessage", "description":"Entity represents mailbox in the system.", "value":"Mailbox", "description":"Entity represents submission mail in the system.", "value":"SubmissionMail"] ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2019-01-preview-only", "details":"Duplicate Schema named EntityQueryKind -- properties: "kind":"description":"The kind of the entity query", "$ref":"#/components/schemas/EntityQueryKind" =>, type: undefined => "string", required: ["kind"] =>, enum: undefined => ["Expansion", "Insight"], x-ms-enum: undefined => "modelAsString":true, "name":"EntityQueryKind", "values":["value":"Expansion", "value":"Insight"] ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2019-01-preview-only", "details":"Duplicate Schema named ThreatIntelligenceResourceKind -- properties: "kind":"description":"The kind of the entity.", "$ref":"#/components/schemas/ThreatIntelligenceResourceKind" =>, type: undefined => "string", required: ["kind"] =>, enum: undefined => ["indicator"], x-ms-enum: undefined => "modelAsString":true, "name":"ThreatIntelligenceResourceKind", "values":["description":"Entity represents threat intelligence indicator in the system.", "value":"indicator"] ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2019-01-preview-only", "details":"Duplicate Schema named ThreatIntelligenceSortingCriteria -- properties: "itemKey":"description":"Column name", "$ref":"#/components/schemas/schemas:852", "sortOrder":"description":"Sorting order (ascending/descending/unsorted).", "$ref":"#/components/schemas/ThreatIntelligenceSortingCriteria" =>, type: undefined => "string", enum: undefined => ["unsorted", "ascending", "descending"], x-ms-enum: undefined => "modelAsString":true, "name":"ThreatIntelligenceSortingCriteria", "values":["value":"unsorted", "value":"ascending", "value":"descending"] ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2019-01-preview-only", "details":"Error: Plugin prechecker reported failure." |
| "readme":"securityinsights/resource-manager/readme.md", "tag":"package-2019-01-preview-only", "details":"The schema 'MLBehaviorAnalyticsAlertRuleTemplate-properties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"securityinsights/resource-manager/readme.md", "tag":"package-2019-01-preview-only", "details":"The schema 'ActionsList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
Hi @Amitbergman, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
This was referenced Jan 24, 2021
|
hi @ArcturusZhang could you pls help to confirm impact to Go SDK? thanks. |
|
@yungezz this package has accumulated quite a lot breaking changes unreleased. But for the changes particular in this PR, @Amitbergman do we have a reason of removing those? |
|
Hey @yungezz , @ArcturusZhang , The situation is this: Thanks, |
thanks for context @Amitbergman . So this PR is fixing Swagger to align with existing service behavior right? The team is on holiday will be back at end of next week. @ArcturusZhang does it make sense for you? |
Amitbergman
commented
Feb 12, 2021
There was a problem hiding this comment.
Hey @yungezz , @ArcturusZhang ,
Thanks for your explanations.
The situation is this:
I accidently added this "Anomaly" to the types, since I did not know that this feature is in private preview.
In this PR, I just want to fix this mistake, this feature is not public yet but it is in the swagger which is a problem, no?
Thanks,
Amitthanks for context @Amitbergman . So this PR is fixing Swagger to align with existing service behavior right? The team is on holiday will be back at end of next week. @ArcturusZhang does it make sense for you?
right. Sure, no problem, I will also be back at the end of next week so we are good :)
| "value": "ThreatIntelligence" | ||
| }, | ||
| { | ||
| "value": "Anomaly" |
There was a problem hiding this comment.
Hey @yungezz , I have accidentely added these types 2 days ago, and I want to remove them and add them properly (with the relevant properties)
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
Well, bad news is that we just released a new package of securityinsight 11 days ago: https://github.com/Azure/azure-sdk-for-go/tree/master/services/preview/securityinsight/mgmt/2019-01-01-preview/securityinsight |
hi @Amitbergman could you pls confirm are these two private preview features, and customer impact of the change. thanks. |
These are indeed private preview features, and there is no customer impact in this change. Thanks,Amit |
Thanks. HI @ArcturusZhang I plan to merge this PR given no customer impact. Just to double confirm, is it ok from Go SDK perspective? |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
please go ahead |
yungezz
approved these changes
Mar 9, 2021
This was referenced Mar 9, 2021
Merged
MirzaSikander
pushed a commit
to MirzaSikander/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2021
|
Probably not the best place to ask but thought I'd just drop in - @Amitbergman as the cats now out the bag on this, any ETA on when these are coming public preview and back into the API Schema so we can get these in the SDK? Thanks. Generally as someone who has had previous access to PP the faster my org can get stuff in code the better |
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.