Skip to content

Conversation

@abhishek-corp
Copy link
Member

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

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, @abhishek-corp 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 Dec 5, 2022

    Swagger pipeline can not start as the pull request has merge conflicts.

    1 similar comment
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 5, 2022

    Swagger pipeline can not start as the pull request has merge conflicts.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 5, 2022

    Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

    abhishek-corp and others added 3 commits December 10, 2022 15:27
    * Added ImpactedResources for Tenant.
    
    * Added new API listSecurityAdvisoryImpactedResources for Subscriptions and Tenants.
    
    * Added Tenant ImpactedResources, SecurityImpactedResources.
    
    * Changes to examples for Subscription ImpactedResources.
    
    * Added resourceName pattern for ImpactedResourceNameParameter.
    
    * Changes to example - SecurityAdvisoryImpactedResources_ListByTenantId_ListByEventId. Removed subscriptionId from unique resourceId.
    * added fetchEventDetails initial commit
    
    * linter fixes
    
    * removed filterparam
    
    * re-add incorrectly deleted filter parameter
    
    * removed query start time parameter
    * Added EmergingIssues API paths from 2018-07-01.
    
    * Fix LintDiff error - x-ms-identifiers
    
    * Fix LintDiff error - MissingTypeObject
    
    * Changed resource definition from v1 to v3.
    @abhishek-corp abhishek-corp marked this pull request as ready for review December 28, 2022 21:22
    @abhishek-corp
    Copy link
    Member Author

    All new commits after rebase from previous version have been signed off by ARM.

    @abhishek-corp abhishek-corp added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 28, 2022
    }
    },
    "/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/listSecurityAdvisoryImpactedResources": {
    "post": {
    Copy link

    Choose a reason for hiding this comment

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

    Why use "POST" instead of GET at multiple resources.

    Copy link
    Member Author

    Choose a reason for hiding this comment

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

    This URL path should have RBAC controls. Subscription Reader roles can access GET API. We want users with only certain roles (more restrictive than Subscription/Tenant reader) to access data from this API.

    Here is the stack overflow question, we asked https://stackoverflow.microsoft.com/questions/328094

    Copy link
    Member Author

    Choose a reason for hiding this comment

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

    Here is the merge PR for the relevant commit - #21758

    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @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 Dec 29, 2022
    @abhishek-corp abhishek-corp added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 31, 2022
    @NetRock NetRock added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Dec 31, 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 Dec 31, 2022
    @abhishek-corp abhishek-corp added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Jan 6, 2023
    * Adding 2 new fields to AvailabilityStatuses response.
    
    * Modified availabilitystatuses examples, changes to descriptions.
    
    * Modified availabilitystatuses examples - 2
    @ghost
    Copy link

    ghost commented Feb 5, 2023

    Hi, @abhishek-corp. 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
    Copy link

    ghost commented Feb 20, 2023

    Hi, @abhishek-corp. 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

    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript 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.

    6 participants