azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Dev sentinel securityinsights microsoft.security insights 2024 09 01

Open xuhumsft opened this issue 1 year ago • 4 comments

ARM (Control Plane) API Specification Update Pull Request

[!TIP] Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • [ ] New resource provider.
  • [ ] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • [ ] Update existing version to fix OpenAPI spec quality issues in S360.
  • [ ] Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • [ ] Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:

  • [ ] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • [ ] I have reviewed following Resource Provider guidelines, including ARM resource provider contract and REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run. This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

xuhumsft avatar Sep 30 '24 18:09 xuhumsft

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Fix the errors here or add a suppression adding a reasoning for why you cant fix it

https://github.com/Azure/azure-rest-api-specs/pull/30800/checks?check_run_id=30872281352

https://github.com/Azure/autorest/blob/main/docs/generate/suppress-warnings.md

rkmanda avatar Oct 05 '24 04:10 rkmanda

Changes from the following PR is granted with ARMSignedOff label https://github.com/Azure/azure-rest-api-specs/pull/31040

xuhumsft avatar Oct 23 '24 21:10 xuhumsft

For the suppression, it is approved in the last preview PR. https://github.com/Azure/azure-rest-api-specs/pull/28437

xuhumsft avatar Nov 06 '24 23:11 xuhumsft

Please fill out the Purpose of this PR and Due diligence checklist.

razvanbadea-msft avatar Nov 12 '24 09:11 razvanbadea-msft

/azp run

razvanbadea-msft avatar Nov 12 '24 09:11 razvanbadea-msft

Azure Pipelines successfully started running 2 pipeline(s).

azure-pipelines[bot] avatar Nov 12 '24 09:11 azure-pipelines[bot]

/azp run

msyyc avatar Nov 15 '24 01:11 msyyc

Azure Pipelines successfully started running 3 pipeline(s).

azure-pipelines[bot] avatar Nov 15 '24 01:11 azure-pipelines[bot]

API change check

APIView has identified API level changes in this PR and created following API reviews.

common

azure-sdk avatar Nov 15 '24 01:11 azure-sdk

@razvanbadea-msft I fixed the typo, string format and V3 comments. https://github.com/Azure/azure-rest-api-specs/pull/31581

The rest (like enum, additonalPropertyValidation..) reviewed during the Preview version.

We had a long discussion therewith ARM team... I joined a few ARM meetings, discuss with PMs and the API approved by ARM. This version is exactly the same definition as we have in Preview version and we want to have the same API (This API is in GA already for a few month with the preview definition)

if you need more explanation let me know, and i will join to ARM meeting

sagamzu avatar Nov 17 '24 09:11 sagamzu