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.

Sign up for GitHub

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

Jump to bottom

Microsoft.Sql - adding Managed Instance AdvancedThreatProtection APIs #19089

Merged
merged 1 commit into from
May 20, 2022
Merged

Microsoft.Sql - adding Managed Instance AdvancedThreatProtection APIs #19089

merged 1 commit into from
May 20, 2022

Conversation

cohen-uriel-ms
Copy link
Contributor

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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 date is not yet available, the month.
    This should be published with Microsoft.Sql 2022-02-01-preview API
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @cohen-uriel-ms 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 May 16, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.

    ️❌Avocado: 2 Errors, 1 Warnings failed [Detail]
    Rule Message
    ❌ MISSING_APIS_IN_DEFAULT_TAG The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag.
    readme: specification/sql/resource-manager/readme.md
    json: Microsoft.Sql/preview/2022-02-01-preview/ManagedDatabaseAdvancedThreatProtectionSettings.json
    ❌ MISSING_APIS_IN_DEFAULT_TAG The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag.
    readme: specification/sql/resource-manager/readme.md
    json: Microsoft.Sql/preview/2022-02-01-preview/ManagedInstanceAdvancedThreatProtectionSettings.json
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/sql/resource-manager/readme.md
    tag: specification/sql/resource-manager/readme.md#tag-package-composite-v5
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation

    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 16, 2022 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️SDK Breaking Change Tracking warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-net failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-python-track2 warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-java warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-js warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-resource-manager-schemas warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    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 May 16, 2022
    @ghost ghost added the SQL label May 16, 2022
    @openapi-workflow-bot
    Copy link

    Hi, @cohen-uriel-ms your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @openapi-workflow-bot
    Copy link

    Hi @cohen-uriel-ms, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
     If you need further help, please feedback via swagger feedback.

    @azure-sdk azure-sdk mentioned this pull request May 16, 2022
    Closed
    @azure-sdk azure-sdk mentioned this pull request May 16, 2022
    Closed
    This was referenced May 16, 2022
    Closed
    Closed
    Closed
    Closed
    @azure-sdk azure-sdk mentioned this pull request May 16, 2022
    Draft
    jorgecotillo
    jorgecotillo reviewed May 18, 2022
    View reviewed changes
    ...icrosoft.Sql/preview/2022-02-01-preview/ManagedDatabaseAdvancedThreatProtectionSettings.json
    }
    }
    },
    "put": {
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    "put"

    If a user can create a resource, a user should be able to delete the resource, please read our Inconsistent or Incomplete CRUD documentation: https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html#common-issues-found-in-review

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    This is not a resource, these are settings set for a Managed Instance Database. It doesn't make sense to have a DELETE operation for it. It can be either Enabled or Disabled. That's it.
    Note that this same operations (APIs) have been added for other SQL resource (regular Servers and Databases, and this adds the same for Managed Instance Servers and Databases). They have already been reviewed by ARM Review, approved and already released as part of 2021-11-01-preview.

    jorgecotillo
    jorgecotillo reviewed May 18, 2022
    View reviewed changes
    ...icrosoft.Sql/preview/2022-02-01-preview/ManagedInstanceAdvancedThreatProtectionSettings.json
    }
    }
    },
    "put": {
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    "put"

    Same as the other spec, you need to expose a DELETE API as well.

    @jorgecotillo jorgecotillo added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 19, 2022
    @raych1 raych1 merged commit 94198ce into Azure:dev-sql-Microsoft.Sql-2022-02-01-preview May 20, 2022
    @cohen-uriel-ms cohen-uriel-ms deleted the cohen-uriel-ms/dev-sql-Microsoft.Sql-2022-02-01-preview branch May 20, 2022 08:09
    ericshape pushed a commit to ericshape/azure-rest-api-specs that referenced this pull request May 31, 2022
    @cohen-uriel-ms @ericshape
    Microsoft.Sql - adding Managed Instance AdvancedThreatProtection APIs (…
    7de2a42 
    …Azure#19089)
    ericshape pushed a commit to ericshape/azure-rest-api-specs that referenced this pull request May 31, 2022
    @cohen-uriel-ms @ericshape
    Microsoft.Sql - adding Managed Instance AdvancedThreatProtection APIs (…
    12ed60d 
    …Azure#19089)
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @jorgecotillo jorgecotillo jorgecotillo left review comments

    @raych1 raych1 raych1 approved these changes

    @ericshape ericshape ericshape approved these changes

    @jamestao jamestao Awaiting requested review from jamestao jamestao is a code owner

    Assignees

    @raych1 raych1

    Labels
    Approved-Avocado ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go-V2 CI-BreakingChange-JavaScript CI-FixRequiredOnFailure SQL
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    4 participants
    @cohen-uriel-ms @ericshape @jorgecotillo @raych1