Add alerts and recommendations resources #14599

orkayam · 2021-05-30T07:43:59Z

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.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet. 01st of July 2021
When you expect to publish swagger? Please provide date, or month to public if date is not available yet. ASAP
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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.
- Adding new API(s)
- Adding a new API version
- Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
- Adding a new service
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.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

openapi-workflow-bot · 2021-05-30T07:44:01Z

Hi, @orkayam Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-pipeline-app · 2021-05-30T07:44:02Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️LintDiff: 2 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- iotsecurity/resource-manager/readme.md tag:2021-07-01-preview
Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- iotsecurity/resource-manager/readme.md tag:default

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R2029 - PageableOperation	Based on the response model schema, operation 'AlertTypes_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.IoTSecurity/preview/2021-07-01-preview/alertTypes.json#L38
⚠️ R2029 - PageableOperation	Based on the response model schema, operation 'RecommendationTypes_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.IoTSecurity/preview/2021-07-01-preview/recommendationTypes.json#L38

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/operations.json#L137
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: toBeExportedForCustomer Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/operations.json#L306

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

iotsecurity/resource-manager/readme.md#2021-07-01-preview

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"iotsecurity/resource-manager/readme.md",
"tag":"2021-07-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"iotsecurity/resource-manager/readme.md",
"tag":"2021-07-01-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"iotsecurity/resource-manager/readme.md",
"tag":"2021-07-01-preview",
"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).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-05-30T07:44:02Z

[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.

openapi-pipeline-app · 2021-05-30T07:44:03Z

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⚠️ azure-sdk-for-net warning [Detail]

⚠️Warning [Logs]Release - Generate from 63cc98a. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/iotsecurity/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
warn	No file changes detected after generation
warn	No package detected after generation

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-05-30T07:46:00Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

orkayam · 2021-05-30T09:15:13Z

/azp run

azure-pipelines · 2021-05-30T09:15:22Z

Azure Pipelines successfully started running 1 pipeline(s).

majastrz · 2021-06-02T17:09:24Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

Your PR was flagged for modifying an existing API version. You should either introduce a new API version to add these resource types or work with the breaking changes board to get an exception.

orkayam · 2021-06-03T05:39:45Z

Hi @marcin ***@***.***>, The label was removed, also - it was added when I opened the PR but I fixed it (I created a new version: 2021-07-01-preview). Thanks, Orel. From: Marcin Jastrzebski ***@***.***> Sent: Wednesday, June 2, 2021 8:10 PM To: Azure/azure-rest-api-specs ***@***.***> Cc: Orel Kayam ***@***.***>; Mention ***@***.***> Subject: Re: [Azure/azure-rest-api-specs] Add alerts and recommendations resources (#14599) NewApiVersionRequired reason: A service's API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service's contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can't trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features. Your PR was flagged for modifying an existing API version. You should either introduce a new API version to add these resource types or work with the breaking changes board to get an exception. - You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgh.neting.cc%2FAzure%2Fazure-rest-api-specs%2Fpull%2F14599%23issuecomment-853228766&data=04%7C01%7Corel.kayam%40microsoft.com%7C626823a0713f47e88f4208d925e9350a%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637582505824678591%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=ZlMRmRQLXcVqH%2B5qcrs9XDMdCyRBHjkfU8cpvCzvzeY%3D&reserved=0>, or unsubscribe<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgh.neting.cc%2Fnotifications%2Funsubscribe-auth%2FAQK7234RBCXSNMZIVMYUJ6TTQZQVHANCNFSM45ZCI7AA&data=04%7C01%7Corel.kayam%40microsoft.com%7C626823a0713f47e88f4208d925e9350a%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637582505824688584%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=xV0hR8NX2wAt6WWfJuRlhtrnywvvAhiG7TB0PpcHmuY%3D&reserved=0>.

j5lim · 2021-06-07T21:48:33Z

@orkayam Please complete the ARM API Review Checklist in the PR description. Without it ARM team won't start review. Especially the second one (the first commit should be a copy of the existing api-version so that the reviewers can just diff the 1st commit and the last one to see what changed in the new api-version). Thanks.

orkayam · 2021-06-08T05:28:11Z

@j5lim

@orkayam Please complete the ARM API Review Checklist in the PR description. Without it ARM team won't start review. Especially the second one (the first commit should be a copy of the existing api-version so that the reviewers can just diff the 1st commit and the last one to see what changed in the new api-version). Thanks.

These are new resources in a new API version, so what diff can take place?

j5lim · 2021-06-08T17:34:59Z

@j5lim

@orkayam Please complete the ARM API Review Checklist in the PR description. Without it ARM team won't start review. Especially the second one (the first commit should be a copy of the existing api-version so that the reviewers can just diff the 1st commit and the last one to see what changed in the new api-version). Thanks.

These are new resources in a new API version, so what diff can take place?

It is okay if these are new resources. But please complete the ARM API Review Checklist.

orkayam · 2021-06-08T17:39:03Z

@j5lim

@orkayam Please complete the ARM API Review Checklist in the PR description. Without it ARM team won't start review. Especially the second one (the first commit should be a copy of the existing api-version so that the reviewers can just diff the 1st commit and the last one to see what changed in the new api-version). Thanks.

These are new resources in a new API version, so what diff can take place?

It is okay if these are new resources. But please complete the ARM API Review Checklist.

@j5lim - all the questions are answered/checked.. is there something missing?

openapi-workflow-bot · 2021-06-08T17:42:36Z

Hi, @orkayam your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @jianyexi

j5lim

It is a migration from a Microsoft.Security api-version + adding system data. Approved from ARM side.

* add new resources * Add resources to markdown * Modify routes * Add systemData * Add systemData to defenderSettings * Add missing parameter * Add more systemData * Fix example * Add new API version * Remove redundant change * update markdown * Add operations to new API version * Update list filters * update description * update examples * Update examples * Add missing properties * Add missing properties * Rename property Co-authored-by: Orel Kayam <orkayam@microsoft.com>

Orel Kayam added 2 commits May 30, 2021 10:40

add new resources

1744269

Add resources to markdown

3c66b9f

openapi-assignment-bot bot assigned jianyexi May 30, 2021

orkayam added the NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR label May 30, 2021

openapi-pipeline-app bot added the NewApiVersionRequired label May 30, 2021

Modify routes

a9c2dcf

orkayam changed the title ~~add new resources~~ Add alerts and recommendations resources May 30, 2021

Orel Kayam added 5 commits May 30, 2021 11:23

Add systemData

4952a97

Add systemData to defenderSettings

0ba5be2

Add missing parameter

2ee8ce0

Add more systemData

6307a61

Fix example

3b5d8f7

orkayam added DoNotMerge <valid label in PR review process> use to hold merge after approval and removed NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR labels May 30, 2021

Orel Kayam added 3 commits May 30, 2021 12:03

Add new API version

5ba9009

Remove redundant change

1c4b533

update markdown

08e8bd4

Add operations to new API version

7d7b8c1

orkayam requested a review from markcowl May 30, 2021 09:32

orkayam added NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR and removed DoNotMerge <valid label in PR review process> use to hold merge after approval labels May 30, 2021

orkayam force-pushed the master branch from 64dccea to 7d7b8c1 Compare May 30, 2021 14:55

Update list filters

943ef53

update description

c99f5a6

orkayam added DoNotMerge <valid label in PR review process> use to hold merge after approval and removed NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR labels May 31, 2021

Orel Kayam added 5 commits May 31, 2021 17:26

update examples

44be757

Update examples

6fbbe62

Add missing properties

0a48817

Add missing properties

14b3231

Rename property

87128e0

orkayam removed the NewApiVersionRequired label Jun 3, 2021

openapi-pipeline-app bot added the NewApiVersionRequired label Jun 3, 2021

orkayam removed NewApiVersionRequired DoNotMerge <valid label in PR review process> use to hold merge after approval labels Jun 3, 2021

openapi-pipeline-app bot added the NewApiVersionRequired label Jun 3, 2021

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 8, 2021

j5lim approved these changes Jun 8, 2021

View reviewed changes

j5lim added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 8, 2021

jianyexi merged commit 63cc98a into Azure:master Jun 13, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add alerts and recommendations resources #14599

Add alerts and recommendations resources #14599

orkayam commented May 30, 2021 •

edited

Loading

openapi-workflow-bot bot commented May 30, 2021

openapi-pipeline-app bot commented May 30, 2021 •

edited

Loading

openapi-workflow-bot bot commented May 30, 2021

openapi-pipeline-app bot commented May 30, 2021 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented May 30, 2021

orkayam commented May 30, 2021

azure-pipelines bot commented May 30, 2021

majastrz commented Jun 2, 2021

orkayam commented Jun 3, 2021 via email

j5lim commented Jun 7, 2021

orkayam commented Jun 8, 2021 •

edited

Loading

j5lim commented Jun 8, 2021

orkayam commented Jun 8, 2021

openapi-workflow-bot bot commented Jun 8, 2021

j5lim left a comment

Add alerts and recommendations resources #14599

Add alerts and recommendations resources #14599

Conversation

orkayam commented May 30, 2021 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 30, 2021

openapi-pipeline-app bot commented May 30, 2021 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented May 30, 2021

openapi-pipeline-app bot commented May 30, 2021 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented May 30, 2021

orkayam commented May 30, 2021

azure-pipelines bot commented May 30, 2021

majastrz commented Jun 2, 2021

orkayam commented Jun 3, 2021 via email

j5lim commented Jun 7, 2021

orkayam commented Jun 8, 2021 • edited Loading

j5lim commented Jun 8, 2021

orkayam commented Jun 8, 2021

openapi-workflow-bot bot commented Jun 8, 2021

j5lim left a comment

Choose a reason for hiding this comment

orkayam commented May 30, 2021 •

edited

Loading

openapi-pipeline-app bot commented May 30, 2021 •

edited

Loading

openapi-pipeline-app bot commented May 30, 2021 •

edited

Loading

orkayam commented Jun 8, 2021 •

edited

Loading