Add Security Settings new API version supporting AlertSyncSettings #14374
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
|
Hi, @yibirnba 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. [email protected] |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.Security/stable/2021-06-01/settings.json#L265 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/ExternalSecuritySolutions' Location: Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json#L76 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/ExternalSecuritySolutions/{externalSecuritySolutionsName}' Location: Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json#L118 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Security/preview/2017-08-01-preview/securityContacts.json#L185 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json#L216 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Security/preview/2019-01-01-preview/automations.json#L239 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json#L182 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Security/stable/2020-01-01/assessmentMetadata.json#L248 |
|
The integer type does not have a format, please add it. Location: Microsoft.Security/preview/2017-08-01-preview/compliances.json#L163 |
|
The integer type does not have a format, please add it. Location: Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json#L371 |
|
The integer type does not have a format, please add it. Location: Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json#L376 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/security/resource-manager/readme.md tag: specification/security/resource-manager/readme.md#tag-package-composite-v3 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 11 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- current:stable/2021-06-01/settings.json compared with base:preview/2017-08-01-preview/settings.json
- current:stable/2021-06-01/settings.json compared with base:stable/2019-01-01/settings.json
The following breaking changes are detected by comparison with latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"security/resource-manager/readme.md",
"tag":"package-composite-v3",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"security/resource-manager/readme.md",
"tag":"package-composite-v3",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
"readme":"security/resource-manager/readme.md", "tag":"package-composite-v3", "details":"Duplicate Schema named ExternalSecuritySolutionKind -- type: undefined => "string", properties: "kind":"x-ms-enum":"name":"ExternalSecuritySolutionKind", "modelAsString":true, "values":["value":"CEF", "value":"ATA", "value":"AAD"], "$ref":"#/components/schemas/ExternalSecuritySolutionKind", "description":"The kind of the external solution" =>, enum: undefined => ["CEF", "ATA", "AAD"], x-ms-enum: undefined => "name":"ExternalSecuritySolutionKind", "modelAsString":true, "values":["value":"CEF", "value":"ATA", "value":"AAD"] ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"security/resource-manager/readme.md", "tag":"package-composite-v3", "details":"Duplicate Schema named AadConnectivityState -- type: undefined => "string", properties: "connectivityState":"x-ms-enum":"name":"AadConnectivityState", "modelAsString":true, "values":["value":"Discovered", "value":"NotLicensed", "value":"Connected"], "$ref":"#/components/schemas/AadConnectivityState" =>, title: undefined => "The connectivity state of the external AAD solution ", enum: undefined => ["Discovered", "NotLicensed", "Connected"], x-ms-enum: undefined => "name":"AadConnectivityState", "modelAsString":true, "values":["value":"Discovered", "value":"NotLicensed", "value":"Connected"] ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"security/resource-manager/readme.md", "tag":"package-composite-v3", "details":"Error: Plugin prechecker reported failure." |
| 💬 AutorestCore/Exception | "readme":"security/resource-manager/readme.md", "tag":"package-composite-v3", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
yibirnba
added
the
DoNotMerge
|
Hi @yibirnba, 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. |
This was referenced May 12, 2021
This was referenced May 12, 2021
|
can you please look at this PR? |
|
Hi, @yibirnba your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @ruowan |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, You are adding a new api-version. Please wait for arm review |
| "description": "the kind of the settings string", | ||
| "enum": [ | ||
| "DataExportSettings", | ||
| "AlertSuppressionSetting", |
There was a problem hiding this comment.
Why is AlertSuppressionSetting not used in plural way? Other setting names DataExportSettings, AlertSyncSettings are plural.
RamyasreeChakka
added
ARMSignedOff
|
Signed off from ARM side, added ARMSignedOff label. |
JeffreyRichter
approved these changes
May 26, 2021
JeffreyRichter
added
the
Approved-BreakingChange
RamyasreeChakka
approved these changes
May 27, 2021
|
@ruowan Hi ruowan, we got signoff from ARM team and breaking change team. |
ruowan
removed
the
DoNotMerge
|
@ArcturusZhang Could you help to take a look at the SDK track2 breaking change. |
yibirnba
added
the
DoNotMerge
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Hi, @yibirnba. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
ghost
added
the
ArcturusZhang
added
the
Approved-SdkBreakingChange-Go
ArcturusZhang
approved these changes
Jun 21, 2021
yibirnba
removed
the
DoNotMerge
This was referenced Jun 22, 2021
Closed
This was referenced Jun 22, 2021
26 tasks
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
11 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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.