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

Provider sync properties #22198

Merged

Conversation

dosiso
Copy link
Contributor

@dosiso dosiso commented Jan 15, 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
    • 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
      -[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, @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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 15, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 1 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.2)] new version base version
    Incidents.json 2023-02-01(11c7e58) 2022-11-01(main)

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

    Rule Message
    Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/11c7e588fa7247f6661ff6c5d948ec59ee5b3d8e/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json",
    "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json",
    "details":"Command failed: dotnet /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.46/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/@azure/oad/dlls/OpenApiDiff.dll -o /tmp/old-resolved.json -n /tmp/new-resolved.json\nUnhandled exception. Newtonsoft.Json.JsonSerializationException: Error converting value True to type 'AutoRest.Swagger.Model.Schema'. Path 'definitions.UrlEntityProperties.properties.additionalData.additionalProperties',
    line 1,
    position 74112.\n ---> System.ArgumentException: Could not cast or convert from System.Boolean to AutoRest.Swagger.Model.Schema.\n at Newtonsoft.Json.Utilities.ConvertUtils.EnsureTypeAssignable(Object value,
    Type initialType,
    Type targetType)\n at Newtonsoft.Json.Utilities.ConvertUtils.ConvertOrCast(Object initialValue,
    CultureInfo culture,
    Type targetType)\n at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.EnsureType(JsonReader reader,
    Object value,
    CultureInfo culture,
    JsonContract contract,
    Type targetType)\n --- End"
    ️️✔️LintDiff succeeded [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2023-02 package-2023-02(11c7e58) package-2023-02(release-Sentinel-2023-02-01)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ResourceNameRestriction The resource name parameter 'relationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json#L640
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]
    ️❌ModelValidation: 5 Errors, 0 Warnings failed [Detail]
    Rule Message
    INVALID_TYPE Expected type object but found type string
    Url: stable/2023-02-01/common/EntityTypes.json#L2272:35
    ExampleUrl: 2023-02-01/examples/incidents/GetAllIncidentAlerts.json#L41:44
    INVALID_TYPE Expected type object but found type string
    Url: stable/2023-02-01/common/EntityTypes.json#L2272:35
    ExampleUrl: 2023-02-01/examples/incidents/GetAllIncidentBookmarks.json#L37:25
    INVALID_TYPE Expected type object but found type string
    Url: stable/2023-02-01/common/EntityTypes.json#L2272:35
    ExampleUrl: 2023-02-01/examples/incidents/GetAllIncidentBookmarks.json#L38:29
    INVALID_TYPE Expected type object but found type string
    Url: stable/2023-02-01/common/EntityTypes.json#L2272:35
    ExampleUrl: 2023-02-01/examples/incidents/GetAllIncidentBookmarks.json#L67:25
    INVALID_TYPE Expected type object but found type string
    Url: stable/2023-02-01/common/EntityTypes.json#L2272:35
    ExampleUrl: 2023-02-01/examples/incidents/GetAllIncidentBookmarks.json#L68:29
    ️️✔️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-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 15, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 15, 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-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 67dbf37389d2accc7f7d322c651b621d30e951b8. 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 67dbf37389d2accc7f7d322c651b621d30e951b8. 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.2 -> 9.3.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.3.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` 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 SecurityMLAnalyticsSettingsOperations
      info	[Changelog]   - Model FusionAlertRule has a new parameter techniques
      info	[Changelog]   - Model FusionAlertRuleTemplate has a new parameter techniques
      info	[Changelog]   - Model Incident has a new parameter provider_incident_id
      info	[Changelog]   - Model Incident has a new parameter provider_name
      info	[Changelog]   - Model IncidentAdditionalData has a new parameter provider_incident_url
      info	[Changelog]   - Model IncidentOwnerInfo has a new parameter owner_type
      info	[Changelog]   - Model ScheduledAlertRule has a new parameter techniques
      info	[Changelog]   - Model ScheduledAlertRuleProperties has a new parameter techniques
      info	[Changelog]   - Model ScheduledAlertRuleTemplate has a new parameter techniques
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 67dbf37389d2accc7f7d322c651b621d30e951b8. 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]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 67dbf37389d2accc7f7d322c651b621d30e951b8. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-securityinsights [View full logs]  [Preview SDK Changes]
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Failed [Logs] Generate from 67dbf37389d2accc7f7d322c651b621d30e951b8. 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 67dbf37389d2accc7f7d322c651b621d30e951b8. 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
    Copy link

    Hi, @dosiso your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 15, 2023

    Generated ApiView

    Language Package Name ApiView Link
    JavaScript @azure/arm-securityinsight https://apiview.dev/Assemblies/Review/436d0833fc694ccfbd36f4e7156a27ff
    .Net Azure.ResourceManager.SecurityInsights There is no API change compared with the previous version

    @ruowan
    Copy link
    Member

    ruowan commented Jan 16, 2023

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    Copy link
    Contributor

    @roherzbe roherzbe left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Looks great :)

    @dosiso dosiso marked this pull request as ready for review January 17, 2023 09:10
    @ruowan ruowan added Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 18, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 18, 2023
    @ruowan ruowan removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 labels Jan 18, 2023
    @ruowan
    Copy link
    Member

    ruowan commented Jan 24, 2023

    After sync with PR author offline, the model validation is not related with this PR changes. And PR author will create a separate PR to fix it.

    @ruowan ruowan merged commit 10ae699 into Azure:release-Sentinel-2023-02-01 Jan 24, 2023
    dw511214992 pushed a commit that referenced this pull request Feb 22, 2023
    * Adds base for updating Microsoft.SecurityInsights from version stable/2022-11-01 to version 2023-02-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Provider sync properties (#22198)
    
    * Alert Rules - add alert details override changes and PUT example (#22196)
    
    * add alert details override changes and PUT example
    
    * add missing brace
    
    * add closing brace for alertDetailsOverride
    
    * add dynamic properties to 200 response
    
    * add dynamic details to 201 response
    
    ---------
    
    Co-authored-by: ShaniFelig <[email protected]>
    
    * Release Metadata 2023-02-01 stable version. (#22161)
    
    * Release Metadata 2023-02-01 stable version.
    
    * Fix Swagger spec validation errors.
    
    * Revert Metadata service version to 2022-12-01-preview
    
    * Bring back changes for version 2023-02-01
    
    * Fix model validation
    
    ---------
    
    Co-authored-by: Dor Siso <[email protected]>
    Co-authored-by: ShaniFelig <[email protected]>
    Co-authored-by: ShaniFelig <[email protected]>
    Co-authored-by: Samuel Kuang <[email protected]>
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    * Adds base for updating Microsoft.SecurityInsights from version stable/2022-11-01 to version 2023-02-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Provider sync properties (Azure#22198)
    
    * Alert Rules - add alert details override changes and PUT example (Azure#22196)
    
    * add alert details override changes and PUT example
    
    * add missing brace
    
    * add closing brace for alertDetailsOverride
    
    * add dynamic properties to 200 response
    
    * add dynamic details to 201 response
    
    ---------
    
    Co-authored-by: ShaniFelig <[email protected]>
    
    * Release Metadata 2023-02-01 stable version. (Azure#22161)
    
    * Release Metadata 2023-02-01 stable version.
    
    * Fix Swagger spec validation errors.
    
    * Revert Metadata service version to 2022-12-01-preview
    
    * Bring back changes for version 2023-02-01
    
    * Fix model validation
    
    ---------
    
    Co-authored-by: Dor Siso <[email protected]>
    Co-authored-by: ShaniFelig <[email protected]>
    Co-authored-by: ShaniFelig <[email protected]>
    Co-authored-by: Samuel Kuang <[email protected]>
    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.

    5 participants