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

Adding Workspace Manager Configurations #21275

Conversation

rheabansal
Copy link
Contributor

@rheabansal rheabansal commented Oct 25, 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
  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.

@openapi-workflow-bot
Copy link

Hi, @rheabansal 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 Oct 25, 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.
    compared tags (via openapi-validator v1.13.0) new version base version
    package-preview-2023-03 package-preview-2023-03(d9145f5) package-preview-2023-03(release-securityinsights-Microsoft.SecurityInsights-2023-03-01-preview)
    ️️✔️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 25, 2022

    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 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d2d10c25d0fa7181fe111f8c383ae0fb6d154f6b. 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 [email protected]/[email protected] --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
    • ️✔️Microsoft.Azure.Management.SecurityInsights [View full logs]  [Preview SDK Changes]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from d2d10c25d0fa7181fe111f8c383ae0fb6d154f6b. 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 WorkspaceManagerConfigurationsOperations
      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 d2d10c25d0fa7181fe111f8c383ae0fb6d154f6b. 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 WorkspaceManagerConfigurations
      info	[Changelog]   - Added Interface AlertPropertyMapping
      info	[Changelog]   - Added Interface AzureEntityResource
      info	[Changelog]   - Added Interface ErrorAdditionalInfo
      info	[Changelog]   - Added Interface ErrorDetail
      info	[Changelog]   - Added Interface ErrorResponse
      info	[Changelog]   - Added Interface SentinelEntityMapping
      info	[Changelog]   - Added Interface WorkspaceManagerConfiguration
      info	[Changelog]   - Added Interface WorkspaceManagerConfigurationList
      info	[Changelog]   - Added Interface WorkspaceManagerConfigurationsCreateOrUpdateOptionalParams
      info	[Changelog]   - Added Interface WorkspaceManagerConfigurationsDeleteOptionalParams
      info	[Changelog]   - Added Interface WorkspaceManagerConfigurationsGetOptionalParams
      info	[Changelog]   - Added Interface WorkspaceManagerConfigurationsListNextOptionalParams
      info	[Changelog]   - Added Interface WorkspaceManagerConfigurationsListOptionalParams
      info	[Changelog]   - Added Type Alias AlertProperty
      info	[Changelog]   - Added Type Alias Mode
      info	[Changelog]   - Added Type Alias WorkspaceManagerConfigurationsCreateOrUpdateResponse
      info	[Changelog]   - Added Type Alias WorkspaceManagerConfigurationsGetResponse
      info	[Changelog]   - Added Type Alias WorkspaceManagerConfigurationsListNextResponse
      info	[Changelog]   - Added Type Alias WorkspaceManagerConfigurationsListResponse
      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 workspaceManagerConfigurations
      info	[Changelog]   - Added Enum KnownAlertProperty
      info	[Changelog]   - Added Enum KnownMode
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from d2d10c25d0fa7181fe111f8c383ae0fb6d154f6b. 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
    • ️✔️securityinsights [View full logs]  [Preview Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs] Generate from d2d10c25d0fa7181fe111f8c383ae0fb6d154f6b. 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 25, 2022

    Generated ApiView

    Language Package Name ApiView Link
    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.
    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.
    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.

    @rheabansal rheabansal changed the title adding configurations Adding Workspace Manager Configurations Oct 25, 2022
    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 25, 2022
    @rheabansal rheabansal added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Oct 25, 2022
    @openapi-workflow-bot
    Copy link

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

    @rheabansal
    Copy link
    Contributor Author

    Hi! We already had a PR with this swagger approved in the private repo- https://github.com/Azure/azure-rest-api-specs-pr/pull/9070

    @zizw123 zizw123 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 25, 2022
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 25, 2022
    @zizw123
    Copy link

    zizw123 commented Oct 25, 2022

    Signed off based on the private repo

    @ghost
    Copy link

    ghost commented Nov 13, 2022

    Hi, @rheabansal. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Nov 13, 2022
    @ghost ghost closed this Nov 28, 2022
    @ghost
    Copy link

    ghost commented Nov 28, 2022

    Hi, @rheabansal. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    This pull request was closed.
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review DoNotMerge <valid label in PR review process> use to hold merge after approval resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants