Skip to content

Model validation fixes#21350

Merged
dw511214992 merged 1 commit intoAzure:release-securityinsights-Microsoft.SecurityInsights-2022-11-01-previewfrom
dosegal:release-securityinsights-Microsoft.SecurityInsights-2022-11-01-preview-fixes
Nov 7, 2022
Merged

Model validation fixes#21350
dw511214992 merged 1 commit intoAzure:release-securityinsights-Microsoft.SecurityInsights-2022-11-01-previewfrom
dosegal:release-securityinsights-Microsoft.SecurityInsights-2022-11-01-preview-fixes

Conversation

@dosegal
Copy link
Contributor

@dosegal dosegal commented Oct 31, 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 - Model Validation fixes
  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 - already deployed
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. - 2022-11-01.
  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
      -[ ] 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, @dosegal 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 Oct 31, 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.
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Oct 31, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️⚠️SDK Breaking Change Tracking warning [Detail]

    Breaking Changes Tracking


    ⚠️azure-sdk-for-js - @azure/arm-securityinsight - 1.0.0-beta.6
    -	Interface AADDataConnector no longer has parameter kind
    -	Interface ASCDataConnector no longer has parameter kind
    -	Interface AatpDataConnector no longer has parameter kind
    -	Interface AccountEntity no longer has parameter kind
    -	Interface ActivityCustomEntityQuery no longer has parameter kind
    -	Interface ActivityEntityQuery no longer has parameter kind
    -	Interface ActivityEntityQueryTemplate no longer has parameter kind
    -	Interface Anomalies no longer has parameter kind
    -	Interface AnomalySecurityMLAnalyticsSettings no longer has parameter kind
    -	Interface AwsCloudTrailDataConnector no longer has parameter kind
    -	Interface AwsS3DataConnector no longer has parameter kind
    -	Interface AzureResourceEntity no longer has parameter kind
    -	Interface CloudApplicationEntity no longer has parameter kind
    -	Interface CodelessApiPollingDataConnector no longer has parameter kind
    -	Interface CodelessUiDataConnector no longer has parameter kind
    -	Interface DnsEntity no longer has parameter kind
    -	Interface Dynamics365DataConnector no longer has parameter kind
    -	Interface EntityAnalytics no longer has parameter kind
    -	Interface ExpansionEntityQuery no longer has parameter kind
    -	Interface EyesOn no longer has parameter kind
    -	Interface FileEntity no longer has parameter kind
    -	Interface FileHashEntity no longer has parameter kind
    -	Interface FusionAlertRule no longer has parameter kind
    -	Interface FusionAlertRuleTemplate no longer has parameter kind
    -	Interface HostEntity no longer has parameter kind
    -	Interface HuntingBookmark no longer has parameter kind
    -	Interface IoTDataConnector no longer has parameter kind
    -	Interface IoTDeviceEntity no longer has parameter kind
    -	Interface IpEntity no longer has parameter kind
    -	Interface MLBehaviorAnalyticsAlertRule no longer has parameter kind
    -	Interface MLBehaviorAnalyticsAlertRuleTemplate no longer has parameter kind
    -	Interface MTPDataConnector no longer has parameter kind
    -	Interface MailClusterEntity no longer has parameter kind
    -	Interface MailMessageEntity no longer has parameter kind
    -	Interface MailboxEntity no longer has parameter kind
    -	Interface MalwareEntity no longer has parameter kind
    -	Interface McasDataConnector no longer has parameter kind
    -	Interface MdatpDataConnector no longer has parameter kind
    -	Interface MicrosoftSecurityIncidentCreationAlertRule no longer has parameter kind
    -	Interface MicrosoftSecurityIncidentCreationAlertRuleTemplate no longer has parameter kind
    -	Interface MstiDataConnector no longer has parameter kind
    -	Interface NicEntity no longer has parameter kind
    -	Interface NrtAlertRule no longer has parameter kind
    -	Interface NrtAlertRuleTemplate no longer has parameter kind
    -	Interface Office365ProjectDataConnector no longer has parameter kind
    -	Interface OfficeATPDataConnector no longer has parameter kind
    -	Interface OfficeDataConnector no longer has parameter kind
    -	Interface OfficeIRMDataConnector no longer has parameter kind
    -	Interface OfficePowerBIDataConnector no longer has parameter kind
    -	Interface ProcessEntity no longer has parameter kind
    -	Interface RegistryKeyEntity no longer has parameter kind
    -	Interface RegistryValueEntity no longer has parameter kind
    -	Interface ScheduledAlertRule no longer has parameter kind
    -	Interface ScheduledAlertRuleTemplate no longer has parameter kind
    -	Interface SecurityAlert no longer has parameter kind
    -	Interface SecurityGroupEntity no longer has parameter kind
    -	Interface SubmissionMailEntity no longer has parameter kind
    -	Interface TIDataConnector no longer has parameter kind
    -	Interface ThreatIntelligenceAlertRule no longer has parameter kind
    -	Interface ThreatIntelligenceAlertRuleTemplate no longer has parameter kind
    -	Interface ThreatIntelligenceIndicatorModel no longer has parameter kind
    -	Interface TiTaxiiDataConnector no longer has parameter kind
    -	Interface Ueba no longer has parameter kind
    -	Interface UrlEntity no longer has parameter kind
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs] Generate from 684e227bbae88287949688138ef98ff7566f9715. 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] FATAL: System.InvalidOperationException: Swagger document contains two or more x-ms-enum extensions with the same name 'Priority' and different values: Active,InProgress,Done vs. Low,Medium,High
      cmderr	[Autorest]    at AutoRest.Modeler.ObjectBuilder.BuildServiceType(String serviceTypeName, Boolean required) in /opt/vsts/work/1/s/src/ObjectBuilder.cs:line 150
      cmderr	[Autorest]    at AutoRest.Modeler.SchemaBuilder.ParentBuildServiceType(String serviceTypeName, Boolean required) in /opt/vsts/work/1/s/src/SchemaBuilder.cs:line 217
      cmderr	[Autorest]    at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in /opt/vsts/work/1/s/src/SchemaBuilder.cs:line 48
      cmderr	[Autorest]    at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in /opt/vsts/work/1/s/src/SchemaBuilder.cs:line 133
      cmderr	[Autorest]    at AutoRest.Modeler.SwaggerModeler.BuildCompositeTypes() in /opt/vsts/work/1/s/src/SwaggerModeler.cs:line 348
      cmderr	[Autorest]    at AutoRest.Modeler.SwaggerModeler.Build(ServiceDefinition serviceDefinition) in /opt/vsts/work/1/s/src/SwaggerModeler.cs:line 66
      cmderr	[Autorest]    at AutoRest.Modeler.Program.<ProcessInternal>d2.MoveNext() in /opt/vsts/work/1/s/src/Program.cs:line 60
      cmderr	[Autorest] --- End of stack trace from previous location where exception was thrown ---
      cmderr	[Autorest]    at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
      cmderr	[Autorest]    at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
      cmderr	[Autorest]    at NewPlugin.<Process>d15.MoveNext()
      cmderr	[Autorest] FATAL: csharp/imodeler1 - FAILED
      cmderr	[Autorest] FATAL: Error: Plugin imodeler1 reported failure.
      cmderr	[Autorest]   Error: Plugin imodeler1 reported failure.
      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 684e227bbae88287949688138ef98ff7566f9715. 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 GetOperations
      info	[Changelog]   - Added operation group GetRecommendationsOperations
      info	[Changelog]   - Added operation group UpdateOperations
      info	[Changelog]   - Model AlertDetailsOverride has a new parameter alert_dynamic_properties
      info	[Changelog]   - Model NrtAlertRule has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model NrtAlertRuleTemplate has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model NrtAlertRuleTemplateProperties has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model QueryBasedAlertRuleTemplateProperties has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model ScheduledAlertRule has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model ScheduledAlertRuleCommonProperties has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model ScheduledAlertRuleProperties has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model ScheduledAlertRuleTemplate has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model SecurityAlertTimelineItem has a new parameter intent
      info	[Changelog]   - Model SecurityAlertTimelineItem has a new parameter techniques
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 684e227bbae88287949688138ef98ff7566f9715. 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] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group Get
      info	[Changelog]   - Added operation group GetRecommendations
      info	[Changelog]   - Added operation group Update
      info	[Changelog]   - Added Interface AlertPropertyMapping
      info	[Changelog]   - Added Interface Content
      info	[Changelog]   - Added Interface GetRecommendationsListOptionalParams
      info	[Changelog]   - Added Interface GetSingleRecommendationOptionalParams
      info	[Changelog]   - Added Interface Instructions
      info	[Changelog]   - Added Interface Recommendation
      info	[Changelog]   - Added Interface RecommendationList
      info	[Changelog]   - Added Interface RecommendationPatch
      info	[Changelog]   - Added Interface RecommendedAction
      info	[Changelog]   - Added Interface SentinelEntityMapping
      info	[Changelog]   - Added Interface UpdateRecommendationOptionalParams
      info	[Changelog]   - Added Type Alias AlertProperty
      info	[Changelog]   - Added Type Alias Category
      info	[Changelog]   - Added Type Alias Context
      info	[Changelog]   - Added Type Alias GetRecommendationsListResponse
      info	[Changelog]   - Added Type Alias GetSingleRecommendationResponse
      info	[Changelog]   - Added Type Alias Priority
      info	[Changelog]   - Added Type Alias State
      info	[Changelog]   - Added Type Alias UpdateRecommendationResponse
      info	[Changelog]   - Interface AlertDetailsOverride has a new optional parameter alertDynamicProperties
      info	[Changelog]   - Interface NrtAlertRule has a new optional parameter sentinelEntitiesMappings
      info	[Changelog]   - Interface NrtAlertRuleTemplate has a new optional parameter sentinelEntitiesMappings
      info	[Changelog]   - Interface QueryBasedAlertRuleTemplateProperties has a new optional parameter sentinelEntitiesMappings
      info	[Changelog]   - Interface ScheduledAlertRule has a new optional parameter sentinelEntitiesMappings
      info	[Changelog]   - Interface ScheduledAlertRuleCommonProperties has a new optional parameter sentinelEntitiesMappings
      info	[Changelog]   - Interface ScheduledAlertRuleTemplate has a new optional parameter sentinelEntitiesMappings
      info	[Changelog]   - Interface SecurityAlertTimelineItem has a new optional parameter intent
      info	[Changelog]   - Interface SecurityAlertTimelineItem has a new optional parameter techniques
      info	[Changelog]   - Class SecurityInsights has a new parameter get
      info	[Changelog]   - Class SecurityInsights has a new parameter getRecommendations
      info	[Changelog]   - Class SecurityInsights has a new parameter update
      info	[Changelog]   - Added Enum KnownAlertProperty
      info	[Changelog]   - Added Enum KnownCategory
      info	[Changelog]   - Added Enum KnownContext
      info	[Changelog]   - Added Enum KnownPriority
      info	[Changelog]   - Added Enum KnownState
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Failed [Logs] Generate from 684e227bbae88287949688138ef98ff7566f9715. 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 684e227bbae88287949688138ef98ff7566f9715. 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 Oct 31, 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.
    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.

    @dw511214992 dw511214992 merged commit 0f7b70b into Azure:release-securityinsights-Microsoft.SecurityInsights-2022-11-01-preview Nov 7, 2022
    dw511214992 pushed a commit that referenced this pull request Nov 7, 2022
    #21267)
    
    * Adds base for updating Microsoft.SecurityInsights from version preview/2022-10-01-preview to version 2022-11-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * added recommendations specs (#21118)
    
    * model validation fixes (#21350)
    
    Co-authored-by: Vaspate <103540155+Vaspate@users.noreply.github.com>
    Co-authored-by: dosegal <51155368+dosegal@users.noreply.github.com>
    anandanthony pushed a commit to anandMicro/azure-rest-api-specs that referenced this pull request Dec 16, 2022
    Azure#21267)
    
    * Adds base for updating Microsoft.SecurityInsights from version preview/2022-10-01-preview to version 2022-11-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * added recommendations specs (Azure#21118)
    
    * model validation fixes (Azure#21350)
    
    Co-authored-by: Vaspate <103540155+Vaspate@users.noreply.github.com>
    Co-authored-by: dosegal <51155368+dosegal@users.noreply.github.com>
    kayousef-zz pushed a commit to kayousef-zz/azure-rest-api-specs that referenced this pull request Dec 21, 2022
    Azure#21267)
    
    * Adds base for updating Microsoft.SecurityInsights from version preview/2022-10-01-preview to version 2022-11-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * added recommendations specs (Azure#21118)
    
    * model validation fixes (Azure#21350)
    
    Co-authored-by: Vaspate <103540155+Vaspate@users.noreply.github.com>
    Co-authored-by: dosegal <51155368+dosegal@users.noreply.github.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    3 participants