Add stable version for Connectordefinitions API#30812
Merged
xuhumsft merged 5 commits intoAzure:dev-Sentinel-securityinsights-Microsoft.SecurityInsights-2024-09-01from Nov 6, 2024
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Generated ApiView
|
This was referenced Oct 1, 2024
stavbella
force-pushed
the
AddStableVersionForConnectorDefinitionsApi
branch
from
00d9f56 to
ac6b8a6
Compare
stavbella
force-pushed
the
AddStableVersionForConnectorDefinitionsApi
branch
from
ac6b8a6 to
80aeca7
Compare
xuhumsft
added
the
WaitForARMFeedback
mentat9
reviewed
Oct 15, 2024
| "status": { | ||
| "$ref": "#/definitions/AvailabilityStatus" | ||
| }, | ||
| "isPreview": { |
Member
Contributor
Author
There was a problem hiding this comment.
@mentat9
The reason we didnt use Enum, was to save backword compatability for the customers, since thery are using today the same object in another API. This was the Product Manager desicion.
This API was review in preview version.
we want to have exactly the same api in Stable version.
mentat9
reviewed
Oct 15, 2024
| "description": "The exposure status of the connector to the customers.", | ||
| "type": "object", | ||
| "properties": { | ||
| "status": { |
Member
There was a problem hiding this comment.
Why not use string enum, and combine it with isPreview boolean, e.g.
availability: {
Disabled (==None),
PrivatePreview (==FeatureFlag+isPreview)
Private (==FeatureFLag),
Preview (==Available+isPreview),
Public (==Available),
Internal
}
. . . or similar names you like better.
This approach is easier for clients to understand/use, and designs out wrong combinations (like None + isPreview), but still allows easily adding new availability values.
mentat9
reviewed
Oct 15, 2024
| ], | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { |
Member
mentat9
reviewed
Oct 15, 2024
| "description": "An Azure resource, which encapsulate the entire info requires to display a data connector page in Azure portal,\r\nand the info required to define data connections.", | ||
| "type": "object", | ||
| "properties": { | ||
| "kind": { |
Member
mentat9
reviewed
Oct 15, 2024
| "connectorUiConfig" | ||
| ], | ||
| "properties": { | ||
| "createdTimeUtc": { |
Member
mentat9
reviewed
Oct 15, 2024
| "description": "Gets or sets the connector definition created date in UTC format.", | ||
| "type": "string" | ||
| }, | ||
| "lastModifiedUtc": { |
Member
mentat9
reviewed
Oct 15, 2024
| ], | ||
| "type": "object", | ||
| "properties": { | ||
| "id": { |
Member
mentat9
reviewed
Oct 15, 2024
| "description": "Gets or sets custom connector id. optional field.", | ||
| "type": "string" | ||
| }, | ||
| "title": { |
Member
mentat9
reviewed
Oct 15, 2024
| }, | ||
| "logo": { | ||
| "description": "Gets or sets the connector logo to be used when displaying the connector within Azure Sentinel's connector's gallery.\r\nThe logo value should be in SVG format.", | ||
| "type": "string" |
Member
mentat9
reviewed
Oct 15, 2024
| "description": "Gets or sets the connector logo to be used when displaying the connector within Azure Sentinel's connector's gallery.\r\nThe logo value should be in SVG format.", | ||
| "type": "string" | ||
| }, | ||
| "isConnectivityCriteriasMatchSome": { |
Member
mentat9
reviewed
Oct 15, 2024
| ], | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { |
Member
mentat9
reviewed
Oct 15, 2024
| "description": "Instruction steps to enable the connector.", | ||
| "type": "object", | ||
| "properties": { | ||
| "title": { |
Member
mentat9
reviewed
Oct 15, 2024
| }, | ||
| "x-ms-identifiers": [] | ||
| }, | ||
| "innerSteps": { |
Member
mentat9
reviewed
Oct 15, 2024
| "description": "Gets or sets the instruction type parameters settings.", | ||
| "type": "object" | ||
| }, | ||
| "type": { |
Member
mentat9
reviewed
Oct 15, 2024
| "description": "Gets or sets the required tenant permissions for the connector.", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" |
Member
mentat9
reviewed
Oct 15, 2024
| "description": "Gets or sets the required licenses for the user to create connections.", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" |
Member
mentat9
reviewed
Oct 15, 2024
| "properties": { | ||
| "provider": { | ||
| "description": "Gets or sets the provider name.", | ||
| "type": "string" |
Member
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
Contributor
Author
|
Data connector definition API reviewed in Preview version. The customers are using this API for a while, the feature is in GA for a few month and we want to have exactly the same API in Stable version. Please see the Preview PR: and you can see the merged code here: |
xuhumsft
added
WaitForARMFeedback
raosuhas
added
the
ARMSignedOff
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
xuhumsft
merged commit c632444
into
Azure:dev-Sentinel-securityinsights-Microsoft.SecurityInsights-2024-09-01
xuhumsft
added a commit
that referenced
this pull request
Nov 20, 2024
…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>
pjpatel12
pushed a commit
to pjpatel12/azure-rest-api-specs
that referenced
this pull request
Apr 29, 2025
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection 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!
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:
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 ApiViewcomment 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
Purpose of this PRandDue diligence checklist.write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.Add stable version for Connectordefinitions API.
Please note that this is exactly the same doc as we have for the lates preview version