DataConnectors - MDTI and PMDTI connectors 2024-09-01 by ni-bhandari · Pull Request #31491 · Azure/azure-rest-api-specs

ni-bhandari · 2024-11-11T00:44:18Z

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-11-11T00:44:31Z

Next Steps to Merge

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

openapi-pipeline-app · 2024-11-11T00:44:31Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/securityinsights/armsecurityinsights	https://apiview.dev/Assemblies/Review/06b0c4a98e094807b7c161c14692f77d?revisionId=91a7087e0b60427995da5efb641ed9d1
Python	azure-mgmt-securityinsight	https://apiview.dev/Assemblies/Review/36adc9563fba4ee0a3c59bc34463bf0a?revisionId=d6d03787ee034f64950fe3201b844777

...tyinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-09-01/DataConnectors.json

razvanbadea-msft · 2024-11-13T09:51:15Z

...tyinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-09-01/DataConnectors.json

+          "description": "The lookback period for the feed to be imported.",
+          "type": "string"
+        },
+        "requiredSKUsPresent": {


requiredSKUsPresent

you should replace this with an enum to have values like [PremiumSKU. None] so that in case a new type apears you can add it to the enum.

Enums are always a more flexible and future proof option because they allow additional values to be added in the future in a non-breaking way, e.g. [Enabled, Disabled, Suspended, Deallocated].

reviewing this.

Hi, @razvanbadea-msft , I reviewed this with my team, and we think that the boolean value here is sufficient for the purposes of this API. If, in the future, there are other types of connectors that require different types of SKUs, then that would not affect this field much. If we have such a connector, say ConnectorX, then the value of "requiredSkusPresent" will be calculated differently for ConnectorX than for this (PMDTI) connector, but the resulting values for this field would still be either true or false.
Our backend is capable of handling different SKUs required by different connector types and checking if they are present for the respective customer (the caller does not need all the details), and in the response, we are just presenting whether the customer meets the requirements to use this particular connector. Also, we do not need the caller to handle other states like Disabled, Suspended, etc. as we have the "state" property of the connector for that purpose.

tadelesh · 2024-11-14T00:25:01Z

approved go breaking change since they are not introduced in this pr.

…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>

xuhumsft and others added 6 commits November 6, 2024 15:43

fix prettier check

bf44b95

mdti stable swagger

1798130

pmdti stable swagger

a8fe0e5

fix example name

2044fd7

fix pmdti swagger

729a251

add pmdti examples

383f3d0

AzureRestAPISpecReview added the resource-manager label Nov 11, 2024

azure-sdk mentioned this pull request Nov 11, 2024

[AutoPR sdk/resourcemanager/securityinsights/armsecurityinsights] DataConnectors - MDTI and PMDTI connectors 2024-09-01 azure-sdk/azure-sdk-for-go#12118

Closed

azure-sdk added the BreakingChange-Go-Sdk label Nov 11, 2024

azure-sdk mentioned this pull request Nov 11, 2024

[AutoPR Azure.ResourceManager.SecurityInsights] DataConnectors - MDTI and PMDTI connectors 2024-09-01 azure-sdk/azure-sdk-for-net#9789

Closed

fix spellcheck

685af85

This was referenced Nov 11, 2024

[AutoPR Az.securityinsights.DefaultTag] DataConnectors - MDTI and PMDTI connectors 2024-09-01 azure-sdk/azure-powershell#8305

Closed

[AutoPR @azure/arm-securityinsight] DataConnectors - MDTI and PMDTI connectors 2024-09-01 azure-sdk/azure-sdk-for-js#12778

Closed

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

ni-bhandari added 2 commits November 11, 2024 12:29

fix enums

9bf6e2d

prettier fix

b41d4ec

razvanbadea-msft reviewed Nov 13, 2024

View reviewed changes

...tyinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-09-01/DataConnectors.json Outdated Show resolved Hide resolved

razvanbadea-msft reviewed Nov 13, 2024

View reviewed changes

razvanbadea-msft added the ARMChangesRequested label Nov 13, 2024

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

tadelesh added the BreakingChange-Go-Sdk-Approved label Nov 14, 2024

ni-bhandari added 2 commits November 13, 2024 21:55

update lookback

eb3042a

lookback period for pmdti

4f50e35

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

ni-bhandari added 2 commits November 19, 2024 14:51

fix date-time format in examples

169a632

minor format fix

5a8d5d6

azure-sdk mentioned this pull request Nov 19, 2024

[AutoPR azure-mgmt-securityinsight] DataConnectors - MDTI and PMDTI connectors 2024-09-01 azure-sdk/azure-sdk-for-python#9514

Closed

ms-bogdan-rotaru added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 20, 2024

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

xuhumsft merged commit 7074122 into Azure:dev-Sentinel-securityinsights-Microsoft.SecurityInsights-2024-09-01 Nov 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DataConnectors - MDTI and PMDTI connectors 2024-09-01#31491

DataConnectors - MDTI and PMDTI connectors 2024-09-01#31491
xuhumsft merged 13 commits intoAzure:dev-Sentinel-securityinsights-Microsoft.SecurityInsights-2024-09-01from
ni-bhandari:nibhandari/stable-mdti-swagger

ni-bhandari commented Nov 11, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Nov 11, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Nov 11, 2024 •

edited

Loading

Uh oh!

Uh oh!

razvanbadea-msft Nov 13, 2024

Uh oh!

ni-bhandari Nov 14, 2024

Uh oh!

ni-bhandari Nov 19, 2024

Uh oh!

tadelesh commented Nov 14, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

ni-bhandari commented Nov 11, 2024 • edited 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 Nov 11, 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 Nov 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

Uh oh!

razvanbadea-msft Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

ni-bhandari Nov 14, 2024

Choose a reason for hiding this comment

Uh oh!

ni-bhandari Nov 19, 2024

Choose a reason for hiding this comment

Uh oh!

tadelesh commented Nov 14, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

ni-bhandari commented Nov 11, 2024 •

edited

Loading

openapi-pipeline-app bot commented Nov 11, 2024 •

edited

Loading

openapi-pipeline-app bot commented Nov 11, 2024 •

edited

Loading