Skip to content

Conversation

@dosiso
Copy link
Contributor

@dosiso dosiso commented Mar 1, 2023

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
      Limit OData top value to 1000 resources (incidents) in new unpublished 2023-03-01-preview API version (in continuation to Limit top incidents resource types #22790 ), according to ARM restrictions of 8MB per response.
    • 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  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.

@dosiso dosiso requested a review from samuelkuangms March 1, 2023 13:06
@openapi-workflow-bot
Copy link

Hi, @dosiso 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 Mar 1, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 26 Errors, 3 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    Incidents.json 2023-03-01-preview(5ff50a6) 2023-02-01(main)
    Incidents.json 2023-03-01-preview(5ff50a6) 2023-02-01-preview(main)

    The following breaking changes are detected by comparison with the latest stable version:

    Rule Message
    1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
    New: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1393:9
    Old: Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json#L1184:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
    New: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1397:9
    Old: Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json#L1189:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1268:9
    Old: Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json#L1054:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L269:5
    Old: stable/2023-02-01/common/EntityTypes.json#L269:5
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2023-03-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2023-02-01/common/EntityTypes.json#L240:9
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1321:9
    Old: Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json#L1096:9
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1325:9
    Old: Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json#L1132:9
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1318:9
    Old: Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json#L1239:9
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-preview-2023-03 package-preview-2023-03(5ff50a6) package-preview-2023-03(release-Sentinel-2023-03-01-preview)

    The following errors/warnings exist before current PR submission:

    Rule Message
    GetCollectionResponseSchema The response in the GET collection operation 'IncidentRelations_List' does not match the response definition in the individual GET operation 'IncidentRelations_Get' .
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L640
    ResourceNameRestriction The resource name parameter 'relationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L704
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1251
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1338
    GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1553
    GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1561
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1073
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1191
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1299
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1408
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1426
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1440
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/Incidents.json#L1480
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️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 Mar 1, 2023

    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-python-track2 - track2_azure-mgmt-securityinsight - 2.0.0b2
    +	Model MSTIDataConnectorDataTypes no longer has parameter bing_safety_phishing_url
    +	Parameter logic_app_resource_id of model PlaybookActionProperties is now required
    ️✔️azure-sdk-for-js - @azure/arm-securityinsight - 1.0.0-beta.7
    +	Interface MstiDataConnectorDataTypes no longer has parameter bingSafetyPhishingURL
    +	Operation Incidents.createTeam has a new signature
    +	Parameter logicAppResourceId of interface PlaybookActionProperties is now required
    +	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;
        }
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from b39347b73a40f5264365afbd2513c382af733b55. 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 b39347b73a40f5264365afbd2513c382af733b55. 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] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.3.1 -> 9.5.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.5.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.5.1` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-securityinsight [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation EntitiesOperations.run_playbook
      info	[Changelog]   - Added operation group AlertRuleOperations
      info	[Changelog]   - Added operation group GetTriggeredAnalyticsRuleRunsOperations
      info	[Changelog]   - Added operation group TriggeredAnalyticsRuleRunOperations
      info	[Changelog]   - Model MTPDataConnector has a new parameter filtered_providers
      info	[Changelog]   - Model MTPDataConnectorDataTypes has a new parameter alerts
      info	[Changelog]   - Model MTPDataConnectorProperties has a new parameter filtered_providers
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model MSTIDataConnectorDataTypes no longer has parameter bing_safety_phishing_url
      info	[Changelog]   - Parameter logic_app_resource_id of model PlaybookActionProperties is now required
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from b39347b73a40f5264365afbd2513c382af733b55. 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] Breaking Change Detected
      Only show 120 items here, please refer to log for details.
      info	[Changelog]   - Type of parameter additionalData of interface AzureResourceEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface CloudApplicationEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface DnsEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface EntityCommonProperties is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface EntityEdges is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface FileEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface FileHashEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface HostEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface HuntingBookmark is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface IoTDeviceEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface IpEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface MailboxEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface MailClusterEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface MailMessageEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface MalwareEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface NicEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface ProcessEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface RegistryKeyEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface RegistryValueEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface SecurityAlert is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface SecurityGroupEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface SubmissionMailEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface ThreatIntelligenceIndicatorModel is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface UrlEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Failed [Logs] Generate from b39347b73a40f5264365afbd2513c382af733b55. 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]
      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 b39347b73a40f5264365afbd2513c382af733b55. 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 Mar 1, 2023

    Generated ApiView

    Language Package Name ApiView Link
    swagger Microsoft.SecurityInsights https://apiview.dev/Assemblies/Review/482a21605d5d400b93d528957e069223
    Java azure-resourcemanager-securityinsights https://apiview.dev/Assemblies/Review/38ffcd3c22ff45c093a16b025682cfd6
    .Net Azure.ResourceManager.SecurityInsights There is no API change compared with the previous version
    JavaScript @azure/arm-securityinsight https://apiview.dev/Assemblies/Review/d7a423a4e0c941f3a19a51cb5867e43f

    @dosiso dosiso requested a review from anat-gilenson March 1, 2023 13:07
    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required resource-manager labels Mar 1, 2023
    @openapi-workflow-bot
    Copy link

    Hi @dosiso, 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.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @dw511214992
    Copy link
    Member

    dw511214992 commented Mar 2, 2023

    The breaking change is not caused by this PR change. So add label to suppress it when this PR is going to be merged.

    @dw511214992 dw511214992 added Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 and removed Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 labels Mar 2, 2023
    @dosiso
    Copy link
    Contributor Author

    dosiso commented Mar 12, 2023

    @chunyu3 please review if needed & merge this PR.

    @chunyu3
    Copy link
    Member

    chunyu3 commented Mar 15, 2023

    The breaking changes are not related with this PR. approve it

    @chunyu3 chunyu3 added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 15, 2023
    @chunyu3 chunyu3 merged commit 70ecabf into Azure:release-Sentinel-2023-03-01-preview Mar 15, 2023
    @samuelkuangms
    Copy link
    Contributor

    @chunyu3 and @dosiso, the release-Sentinel-2023-03-01-preview has been closed, the change in your PR will not be merged to main branch.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-JavaScript FixS360 resource-manager

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    5 participants