Xuhumsft securityinsights microsoft.security insights 2023 11 01 #27173
Conversation
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
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| AlertRules.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| AlertRules.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| AutomationRules.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| AutomationRules.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| Bookmarks.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| Bookmarks.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| ContentPackages.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| ContentProductPackages.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| ContentProductTemplates.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| ContentTemplates.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| DataConnectors.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| Incidents.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| Incidents.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| Metadata.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| Metadata.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| OnboardingStates.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| OnboardingStates.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| SecurityMLAnalyticsSettings.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| SecurityMLAnalyticsSettings.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| SourceControls.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| ThreatIntelligence.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| ThreatIntelligence.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| Watchlists.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| Watchlists.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| AlertTypes.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| AlertTypes.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| ContentCommonTypes.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| EntityTypes.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| EntityTypes.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| IncidentTypes.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| IncidentTypes.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
| operations.json | 2023-11-01(66e7808) | 2023-02-01(main) |
| operations.json | 2023-11-01(66e7808) | 2023-10-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L1072:7 Old: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1072:7 |
|
The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.SecurityInsights/stable/2023-11-01/Watchlists.json#L469:7 Old: Microsoft.SecurityInsights/stable/2023-02-01/Watchlists.json#L469:7 |
|
The new version is missing a 'x-ms-enum' found in the old version. New: Microsoft.SecurityInsights/stable/2023-11-01/Watchlists.json#L482:9 Old: Microsoft.SecurityInsights/stable/2023-02-01/Watchlists.json#L482:9 |
The following breaking changes are detected by comparison with the latest preview version:
Only 18 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityIdentifier}/runPlaybook' removed or restructured? Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/AutomationRules.json#L220:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentIdentifier}/runPlaybook' removed or restructured? Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/AutomationRules.json#L280:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations' removed or restructured? Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/Bookmarks.json#L222:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/expand' removed or restructured? Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/Bookmarks.json#L283:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations/{relationName}' removed or restructured? Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/Bookmarks.json#L331:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/createTeam' removed or restructured? Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/Incidents.json#L218:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks' removed or restructured? Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/Incidents.json#L856:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks/{incidentTaskId}' removed or restructured? Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/Incidents.json#L907:5 |
|
| The new version is missing a definition that was found in the old version. Was 'MLBehaviorAnalyticsAlertRule' removed or renamed? New: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/AlertRules.json#L577:3 |
|
| The new version is missing a definition that was found in the old version. Was 'MLBehaviorAnalyticsAlertRuleProperties' removed or renamed? New: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/AlertRules.json#L577:3 |
|
| The new version is missing a definition that was found in the old version. Was 'MLBehaviorAnalyticsAlertRuleTemplate' removed or renamed? New: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/AlertRules.json#L577:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ThreatIntelligenceAlertRule' removed or renamed? New: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/AlertRules.json#L577:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ThreatIntelligenceAlertRuleProperties' removed or renamed? New: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/AlertRules.json#L577:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ThreatIntelligenceAlertRuleTemplate' removed or renamed? New: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/AlertRules.json#L577:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NrtAlertRuleProperties' removed or renamed? New: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/AlertRules.json#L577:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NrtAlertRuleTemplate' removed or renamed? New: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/AlertRules.json#L577:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NrtAlertRule' removed or renamed? New: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/AlertRules.json#L577:3 |
|
| The new version is missing a definition that was found in the old version. Was 'SentinelEntitiesMappings' removed or renamed? New: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/preview/2023-10-01-preview/AlertRules.json#L577:3 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 15 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-11 | package-2023-11(66e7808) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
The following errors/warnings exist before current PR submission:
Only 18 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Actions_CreateOrUpdate' Request Model: 'parameters[6].schema' Response Model: 'responses[200].schema' Location: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L329 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L1165 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L1208 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L1444 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L1610 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json#L1637 |
|
The delete response body must be empty. Location: Microsoft.SecurityInsights/stable/2023-11-01/AutomationRules.json#L151 |
|
The delete response body must be empty. Location: Microsoft.SecurityInsights/stable/2023-11-01/AutomationRules.json#L157 |
|
The resource name parameter 'relationName' should be defined with a 'pattern' restriction. Location: Microsoft.SecurityInsights/stable/2023-11-01/Incidents.json#L646 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.SecurityInsights/stable/2023-11-01/Incidents.json#L934 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.SecurityInsights/stable/2023-11-01/Incidents.json#L951 |
|
The resource name parameter 'sentinelOnboardingStateName' should be defined with a 'pattern' restriction. Location: Microsoft.SecurityInsights/stable/2023-11-01/OnboardingStates.json#L37 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.SecurityInsights/stable/2023-11-01/OnboardingStates.json#L178 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.SecurityInsights/stable/2023-11-01/OnboardingStates.json#L206 |
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.SecurityInsights/stable/2023-11-01/operations.json#L58 |
|
The resource name parameter 'settingsResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.SecurityInsights/stable/2023-11-01/SecurityMLAnalyticsSettings.json#L82 |
|
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.SecurityInsights/stable/2023-11-01/ThreatIntelligence.json#L37 |
|
Synchronous POST operations must have one of the following combinations of responses - 200 and default ; 204 and default. They also must not have other response codes. Location: Microsoft.SecurityInsights/stable/2023-11-01/ThreatIntelligence.json#L38 |
️❌Avocado: 11 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/{}/workspaces/{}/providers/Microsoft.SecurityInsights/threatIntelligence/main/createIndicator is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/securityinsights/resource-manager/readme.md json: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/{}/workspaces/{}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/securityinsights/resource-manager/readme.md json: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/{}/workspaces/{}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/securityinsights/resource-manager/readme.md json: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/{}/workspaces/{}/providers/Microsoft.SecurityInsights/threatIntelligence/main/queryIndicators is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/securityinsights/resource-manager/readme.md json: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/{}/workspaces/{}/providers/Microsoft.SecurityInsights/threatIntelligence/main/metrics is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/securityinsights/resource-manager/readme.md json: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/{}/workspaces/{}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{}/appendTags is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/securityinsights/resource-manager/readme.md json: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/{}/workspaces/{}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{}/replaceTags is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/securityinsights/resource-manager/readme.md json: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/{}/workspaces/{}/providers/Microsoft.SecurityInsights/watchlists is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/securityinsights/resource-manager/readme.md json: Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/{}/workspaces/{}/providers/Microsoft.SecurityInsights/watchlists/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/securityinsights/resource-manager/readme.md json: Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/{}/workspaces/{}/providers/Microsoft.SecurityInsights/watchlists/{}/watchlistItems is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/securityinsights/resource-manager/readme.md json: Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/{}/workspaces/{}/providers/Microsoft.SecurityInsights/watchlists/{}/watchlistItems/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/securityinsights/resource-manager/readme.md json: Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌PoliCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Click detail for error messages. Exception contact [email protected] or https://aka.ms/swaggersupport. |
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMChangesRequested
ARMReview
BreakingChangeReviewRequired
|
Please address or respond to feedback from the ARM API reviewer. |
|
Hi @xuhumsft! 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. |
This was referenced Dec 21, 2023
|
Breaking changes previously reviewed and approved in #23121 |
mikekistler
added
the
Approved-BreakingChange
xuhumsft
added
the
WaitForARMFeedback
ms-henglu
reviewed
Dec 25, 2023
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols": { |
There was a problem hiding this comment.
Should it be "sourceControls"? Please also update other places.
There was a problem hiding this comment.
I believe it is case insensitive. And since we already use this format in our preview API. I am not sure if that cause any breaking changes or trouble in customer side. However, if you think this is important, please let me know. I can change accordingly.
There was a problem hiding this comment.
Should log a work item to track this improvement, whenever there's a chance when releasing next version, you should consider fix it
ms-henglu
reviewed
Dec 25, 2023
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols/{sourceControlId}": { |
There was a problem hiding this comment.
Would you please add some explainations about why this API doesn't support delete method?
There was a problem hiding this comment.
I see, there's a seperate API to delete the source control resource. Because it requires extra access token to delete?
There was a problem hiding this comment.
please check this comment for the DELETE operations.
#26873 (comment)
ms-henglu
reviewed
Dec 25, 2023
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentproducttemplates/{templateId}": { |
There was a problem hiding this comment.
Should it be "contentProductTemplates"?
There was a problem hiding this comment.
The same as #27173 (comment)
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
xuhumsft
added
the
WaitForARMFeedback
zizw123
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
Hi @xuhumsft, please fix duplicate schema: |
|
Please request to merge again once the above comment is addressed |
|
updated according to the comments. |
|
Also check the failures in https://github.com/Azure/azure-rest-api-specs/pull/27173/checks?check_run_id=20012857275 |
Alancere
added
the
Approved-SdkBreakingChange-Go
zizw123
approved these changes
Dec 29, 2023
zizw123
deleted the
xuhumsft-securityinsights-Microsoft.SecurityInsights-2023-11-01
branch
arifibrahim4
pushed a commit
that referenced
this pull request
Feb 26, 2024
) * Adds base for updating Microsoft.SecurityInsights from version stable/2023-02-01 to version 2023-11-01 * Updates readme * Updates API version in new specs and examples * sentinel securityInsights 2023-11-01 release (#27172) * Xuhumsft securityinsights microsoft.security insights 2023 11 01 (#27207) * sentinel securityInsights 2023-11-01 release * resolve comments - remove duplicated schema
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 (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
ARMReviewlabel.Click here to see the diagram footnotes
Diagram footnotes
[1] ARM review queue (for merge queues, see [2])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. 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
Swagger-Suppression-Process
to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next 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.