Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Microsoft.IotSecurity/defenderSetting - Fix deviceQuota minimum value #16034

Merged
merged 1 commit into from
Sep 15, 2021

Conversation

liranc
Copy link
Contributor

@liranc liranc commented Sep 14, 2021

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. Answer - Already deployed
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. Answer - As soon as possible.
  4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the 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 refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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 label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] 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.
  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a 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
Copy link

Hi, @liranc 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-workflow-bot
    Copy link

    [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
    Copy link

    openapi-pipeline-app bot commented Sep 14, 2021

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    1036 - ConstraintChanged The new version has a different 'minimum' value than the previous one.
    New: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L298:9
    Old: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L298:9
    1037 - ConstraintIsWeaker The new version has a less constraining 'minimum' value than the previous one.
    New: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L298:9
    Old: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L298:9
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    R4009 - RequiredReadOnlySystemData The response of operation:'DefenderSettings_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L74
    R4009 - RequiredReadOnlySystemData The response of operation:'DefenderSettings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L108
    ⚠️ R2004 - NonApplicationJsonType Only 'application/json' content-type is supported by ARM.
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L243
    ⚠️ R2004 - NonApplicationJsonType Only 'application/json' content-type is supported by ARM.
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/sensors.json#L208
    ⚠️ R2004 - NonApplicationJsonType Only 'application/json' content-type is supported by ARM.
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/sensors.json#L251
    ⚠️ R2004 - NonApplicationJsonType Only 'application/json' content-type is supported by ARM.
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/onPremiseSensors.json#L205
    ⚠️ R2004 - NonApplicationJsonType Only 'application/json' content-type is supported by ARM.
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/onPremiseSensors.json#L248
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'Sites_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/sites.json#L38
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'Sensors_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/sensors.json#L38
    ⚠️ 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
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: dynamicLearning
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/sensors.json#L375
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: learningMode
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/sensors.json#L381
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: tiAutomaticUpdates
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/sensors.json#L419
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create or update IoT Defender settings
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/operations.json#L21
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Download activation file
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/onPremiseSensors.json#L194
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Download file for reset password of the sensor
    Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/onPremiseSensors.json#L237
    ️️✔️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

    ️️✔️[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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 14, 2021

    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 c3f1473. 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
    Copy link

    Hi @liranc, 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.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @jianyexi jianyexi assigned ruowan and unassigned jianyexi Sep 14, 2021
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 14, 2021
    @ruowan ruowan merged commit c3f1473 into Azure:main Sep 15, 2021
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    Co-authored-by: Liran Chen <lirche@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants