Add new kind (RestApiPoller) to DataConnectors STABLE API by sagamzu · Pull Request #30813 · Azure/azure-rest-api-specs

sagamzu · 2024-10-01T11:19:32Z

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.

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.

openapi-pipeline-app · 2024-10-01T11:19:36Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ Your PR has breaking changes in the generated SDK for Go (label: BreakingChange-Go-Sdk). Refer to step 3 in the PR workflow diagram.

openapi-pipeline-app · 2024-10-01T11:19:37Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/securityinsights/armsecurityinsights	https://apiview.dev/Assemblies/Review/06b0c4a98e094807b7c161c14692f77d?revisionId=0c281586ed4c4b02ab575c932da381f3
Swagger	Microsoft.SecurityInsights	https://apiview.dev/Assemblies/Review/d30cc3bd7c484ad880bc3b8126f67ba5?revisionId=df85c9a3c87745eba628c4501a23f53a

rkmanda · 2024-10-05T04:37:41Z

specification/securityinsights/resource-manager/readme.md

  - Microsoft.SecurityInsights/stable/2024-09-01/Watchlists.json
+suppressions:
+  - code: AvoidAdditionalProperties
+    from: dataConnectors.json


pl book an api review or modelling office hours to discuss the scenario..

sagamzu · 2024-11-05T06:24:06Z

The suppression in this file is exactly as the suppression we have in the lates preview version.

please see the suppression for version 2024-04 in file:
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/securityinsights/resource-manager/readme.md#tag-package-preview-2024-04

This change was added in this PR to our main Preview PR
https://github.com/Azure/azure-rest-api-specs/pull/29278/files

The main PR, delete but you can find the commit in the repo (see first link)

raosuhas · 2024-11-05T22:01:48Z

The suppression in this file is exactly as the suppression we have in the lates preview version.

please see the suppression for version 2024-04 in file: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/securityinsights/resource-manager/readme.md#tag-package-preview-2024-04

This change was added in this PR to our main Preview PR https://github.com/Azure/azure-rest-api-specs/pull/29278/files

The main PR, delete but you can find the commit in the repo (see first link)

@sagamzu Neither of these PRs or suppressions were approved by ARM. Both of these seem to be PRs in your internal branches. This suppression needs review again. Why are these properties freeform ? How does the customer know what to pass in there ? How do you know how to de-serialize these on your end ?

sagamzu · 2024-11-06T08:38:25Z

or suppressions were approved by ARM. Both of these seem to be PRs in your internal branches. This suppression needs review again. Why are these properties freeform ? How does the customer know what to pass in there ? How do you know how to de-serialize these on your end ?

We add this suppression after a long conversation with arm team,
I assume our main branch was approved by ARM as well.
I will add the main branch owner to the PR
@xuhumsft can you please share arm approval for this suppressions

xuhumsft · 2024-11-06T18:17:22Z

or suppressions were approved by ARM. Both of these seem to be PRs in your internal branches. This suppression needs review again. Why are these properties freeform ? How does the customer know what to pass in there ? How do you know how to de-serialize these on your end ?

We add this suppression after a long conversation with arm team, I assume our main branch was approved by ARM as well. I will add the main branch owner to the PR @xuhumsft can you please share arm approval for this suppressions

@sagamzu @raosuhas

We got the suppression approval in the last preview PR. #28437

…30800) * Copy files from stable/2024-03-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-09-01 Updated the API version from stable/2024-03-01 to stable/2024-09-01. * Added tag for 2024-09-01 in readme file * fix validation error * fix lint diff error - rleationTypes * suppress addtional properties in alertRules * update the common type version to resolve go-sdk error * fix prettier error * fix the model validation error * fix the prettier error * Watchlists 2024-09-01 (#31040) * Watchlists 2024-09-01 * Fix errors * prettier run * address pr feedback * address pr feedback * Add stable version for Connectordefinitions API (#30812) * add stable version for definition API * update readme file * update readme file * update cSpell * Create sdk-suppressions.yaml --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> * Add new kind (RestApiPoller) to DataConnectors STABLE API (#30813) * add restApiPoller kind to dataConnectors * exe prettier * fix prettier check (#31449) * Update readme.python.md * Update sdk-suppressions.yaml * Fix some typos in DataConnectors and DataConnectorDefinitions APIs (#31581) * Update sdk-suppressions.yaml * DataConnectors - MDTI and PMDTI connectors 2024-09-01 (#31491) * fix prettier check * mdti stable swagger * pmdti stable swagger * fix example name * fix pmdti swagger * add pmdti examples * fix spellcheck * fix enums * prettier fix * update lookback * lookback period for pmdti * fix date-time format in examples * minor format fix --------- Co-authored-by: xuhumsft <116764429+xuhumsft@users.noreply.github.com> --------- Co-authored-by: nbatyrbb <115049492+nbatyrbb@users.noreply.github.com> Co-authored-by: sagamzu <52034287+sagamzu@users.noreply.github.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Chenjie Shi <tadelesh.shi@live.cn> Co-authored-by: ni-bhandari <120053375+ni-bhandari@users.noreply.github.com>

…zure#30800) * Copy files from stable/2024-03-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-09-01 Updated the API version from stable/2024-03-01 to stable/2024-09-01. * Added tag for 2024-09-01 in readme file * fix validation error * fix lint diff error - rleationTypes * suppress addtional properties in alertRules * update the common type version to resolve go-sdk error * fix prettier error * fix the model validation error * fix the prettier error * Watchlists 2024-09-01 (Azure#31040) * Watchlists 2024-09-01 * Fix errors * prettier run * address pr feedback * address pr feedback * Add stable version for Connectordefinitions API (Azure#30812) * add stable version for definition API * update readme file * update readme file * update cSpell * Create sdk-suppressions.yaml --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> * Add new kind (RestApiPoller) to DataConnectors STABLE API (Azure#30813) * add restApiPoller kind to dataConnectors * exe prettier * fix prettier check (Azure#31449) * Update readme.python.md * Update sdk-suppressions.yaml * Fix some typos in DataConnectors and DataConnectorDefinitions APIs (Azure#31581) * Update sdk-suppressions.yaml * DataConnectors - MDTI and PMDTI connectors 2024-09-01 (Azure#31491) * fix prettier check * mdti stable swagger * pmdti stable swagger * fix example name * fix pmdti swagger * add pmdti examples * fix spellcheck * fix enums * prettier fix * update lookback * lookback period for pmdti * fix date-time format in examples * minor format fix --------- Co-authored-by: xuhumsft <116764429+xuhumsft@users.noreply.github.com> --------- Co-authored-by: nbatyrbb <115049492+nbatyrbb@users.noreply.github.com> Co-authored-by: sagamzu <52034287+sagamzu@users.noreply.github.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Chenjie Shi <tadelesh.shi@live.cn> Co-authored-by: ni-bhandari <120053375+ni-bhandari@users.noreply.github.com>

AzureRestAPISpecReview added the resource-manager label Oct 1, 2024

sagamzu marked this pull request as ready for review October 1, 2024 13:10

xuhumsft added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 1, 2024

rkmanda reviewed Oct 5, 2024

View reviewed changes

rkmanda added the ARMChangesRequested label Oct 5, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 5, 2024

sagamzu added 2 commits October 15, 2024 09:53

add restApiPoller kind to dataConnectors

744368c

exe prettier

7058613

stavbella force-pushed the AddRestApiPollerKindToDataConnectorApi branch from c13b2f3 to 7058613 Compare October 15, 2024 07:01

azure-sdk added the BreakingChange-Go-Sdk label Oct 15, 2024

azure-sdk mentioned this pull request Oct 15, 2024

[AutoPR sdk/resourcemanager/securityinsights/armsecurityinsights] Add new kind (RestApiPoller) to DataConnectors STABLE API azure-sdk/azure-sdk-for-go#11844

Closed

xuhumsft added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested labels Nov 5, 2024

raosuhas added the ARMChangesRequested label Nov 5, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 5, 2024

xuhumsft added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested labels Nov 6, 2024

raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 6, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 6, 2024

xuhumsft merged commit 18fcc1b into Azure:dev-Sentinel-securityinsights-Microsoft.SecurityInsights-2024-09-01 Nov 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new kind (RestApiPoller) to DataConnectors STABLE API#30813

Add new kind (RestApiPoller) to DataConnectors STABLE API#30813
xuhumsft merged 2 commits intoAzure:dev-Sentinel-securityinsights-Microsoft.SecurityInsights-2024-09-01from
sagamzu:AddRestApiPollerKindToDataConnectorApi

sagamzu commented Oct 1, 2024 •

edited by xuhumsft

Loading

Uh oh!

openapi-pipeline-app bot commented Oct 1, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Oct 1, 2024 •

edited

Loading

Uh oh!

rkmanda Oct 5, 2024

Uh oh!

sagamzu commented Nov 5, 2024

Uh oh!

raosuhas commented Nov 5, 2024

Uh oh!

sagamzu commented Nov 6, 2024 •

edited

Loading

Uh oh!

xuhumsft commented Nov 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

sagamzu commented Oct 1, 2024 • edited by xuhumsft Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

Uh oh!

openapi-pipeline-app bot commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app bot commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

rkmanda Oct 5, 2024

Choose a reason for hiding this comment

Uh oh!

sagamzu commented Nov 5, 2024

Uh oh!

raosuhas commented Nov 5, 2024

Uh oh!

sagamzu commented Nov 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xuhumsft commented Nov 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

sagamzu commented Oct 1, 2024 •

edited by xuhumsft

Loading

openapi-pipeline-app bot commented Oct 1, 2024 •

edited

Loading

openapi-pipeline-app bot commented Oct 1, 2024 •

edited

Loading

sagamzu commented Nov 6, 2024 •

edited

Loading