Release sentinel 2023 04 01 preview #23121
Merged
Conversation
This file contains 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
…w/2023-03-01-preview to version 2023-04-01-preview
|
Hi, @samuelkuangms Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @samuelkuangms your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| AlertRules.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| AlertRules.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| AutomationRules.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| AutomationRules.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| Bookmarks.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| Bookmarks.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| Enrichment.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| Entities.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| EntityQueries.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| EntityQueryTemplates.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| FileImports.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| Incidents.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| Incidents.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| Metadata.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| Metadata.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| OfficeConsents.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| OnboardingStates.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| OnboardingStates.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| Recommendations.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| SecurityMLAnalyticsSettings.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| SecurityMLAnalyticsSettings.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| Settings.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| SourceControls.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| ThreatIntelligence.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| ThreatIntelligence.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| TriggeredAnalyticsRuleRuns.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| Watchlists.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| Watchlists.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| AlertTypes.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| AlertTypes.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| EntityTypes.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| EntityTypes.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| IncidentTypes.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| IncidentTypes.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| RelationTypes.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| ThreatIntelligenceTypes.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| dataConnectors.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
| operations.json | 2023-04-01-preview(01b32d7) | 2023-02-01(main) |
| operations.json | 2023-04-01-preview(01b32d7) | 2023-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 5 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2023-04 | package-preview-2023-04(01b32d7) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 'PUT' operation 'ContentPackage_Install' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentPackages.json#L148 |
||
| 'DELETE' operation 'ContentPackage_Uninstall' should use method name 'Delete'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentPackages.json#L200 |
||
| 'PUT' operation 'ContentTemplate_Install' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentTemplates.json#L105 |
||
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get a template. Location: Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentTemplates.json#L148 |
||
| OperationId should contain the verb: 'jobs' in:'WorkspaceManagerAssignmentJobs_Create'. Consider updating the operationId Location: Microsoft.SecurityInsights/preview/2023-04-01-preview/WorkspaceManagerAssignments.json#L297 |
The following errors/warnings exist before current PR submission:
Only 21 items are listed, please refer to log for more details.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 172 Errors, 0 Warnings failed [Detail]
Tag package-preview-2023-04; Prod region: Deployed
Test run on region: westeurope; Operation coverage: total: 165, untested: 0, failed: 162, passed: 3
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 21 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_CreateOrUpdate |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_List |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_ListBookmarks |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_ListEntities |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_CreateTeam |
|
Additional properties not allowed: teamName Source: request OperationId: Incidents_CreateTeam |
|
Additional properties not allowed: teamDescription Source: request OperationId: Incidents_CreateTeam |
|
Additional properties not allowed: groupIds Source: request OperationId: Incidents_CreateTeam |
|
Additional properties not allowed: memberIds Source: request OperationId: Incidents_CreateTeam |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_RunPlaybook |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_ListAlerts |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Hunts_CreateOrUpdate |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Hunts_List |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Hunts_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Bookmarks_CreateOrUpdate |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Bookmarks_List |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Bookmarks_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: AlertRules_CreateOrUpdate |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: AlertRules_List |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacmhonjf' under resource group 'apiTest-poZRjb-23121' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: AlertRules_Get |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @samuelkuangms, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
|
Hi, @samuelkuangms, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
* Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Workspace Manager Members * udpate pattern
* Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * adding april configurations swagger * update pattern * prettier update * update readme
* Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Workspace Manager Assignments/Jobs * update readme * updated from comments * update from lint diff errors * updated descriptions
* Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * april swagger for groups * update path name & pattern
* Add hunts files * Include update in 200 description and add defaults * Add back 201 * Update relation properties * Update example --------- Co-authored-by: Derrick Lee <derricklee@microsoft.com>
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Please get breaking change reviewed and come back for ARM review |
zizw123
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
<style>
</style>
All the new changes on this branch has been reviewed and signed off by ARM review team. We have 3 breaking changes flagged and we have gone through the ARM breaking change review process, the office hour on 4/10. This is the ADO item to track the work: Scenario 17908651: Cross version validation for release-Sentinel-2023-04-01-preview - Boards (visualstudio.com) 1. One is approved by Mike. 2. Two changes on watchlist are still in review, and following up with Mike. This breaking change was introduced on 2022-01-01 Preview by the following PR.
|
|
Breaking changes previously approved in #22983 |
mikekistler
added
the
Approved-BreakingChange
|
Signing off, most commits in this PR have been signed off before, the diffs are typo fixing. |
zizw123
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
|
Sync with js sdk owner. Approved the sdk breaking. |
tadelesh
approved these changes
Apr 14, 2023
This was referenced Apr 14, 2023
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
* Adds base for updating Microsoft.SecurityInsights from version preview/2023-03-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Workspace Manager Members (Azure#23134) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Workspace Manager Members * udpate pattern * Workspace manager configurations (Azure#23133) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * adding april configurations swagger * update pattern * prettier update * update readme * Workspace manager assignments (Azure#23130) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Workspace Manager Assignments/Jobs * update readme * updated from comments * update from lint diff errors * updated descriptions * Workspace manager groups (Azure#23135) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * april swagger for groups * update path name & pattern * [Hunts] Add hunts to Sentinel 2023-04-01-preview version (Azure#23139) * Add hunts files * Include update in 200 description and add defaults * Add back 201 * Update relation properties * Update example --------- Co-authored-by: Derrick Lee <derricklee@microsoft.com> * Add readonly flag to providerName property (Azure#23259) * sentinel content hub package and template API (Azure#23151) * commit for content template and content package API * fix issues reported by swagger lint * add 201 for put requests in template service * resolve the comments * resolve comments in packageId * resolve comments * update descriptions due to lint error (Azure#23392) * Fix policheck issue by updating the description. (Azure#23415) * Fix polich issue by updating the description. * update the description to fix a typo. * Release sentinel 2023 04 01 preview (Azure#23420) * Fix polich issue by updating the description. * update the description to fix a typo. * fix policheck by updating description * rename enum name to stable version to fix cross-version breaking change failure. * fix typo (Azure#23463) --------- Co-authored-by: rheabansal <93624991+rheabansal@users.noreply.github.com> Co-authored-by: Derrick Lee <derricklee91@gmail.com> Co-authored-by: Derrick Lee <derricklee@microsoft.com> Co-authored-by: Anat Gilenson <53407600+anat-gilenson@users.noreply.github.com> Co-authored-by: xuhumsft <116764429+xuhumsft@users.noreply.github.com> Co-authored-by: Nan Zang <nazang@microsoft.com>
8 tasks
6 tasks
6 tasks
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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.
-[X] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.