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

iotDefenderSettings - Add onboardingKind property #13434

Merged
merged 3 commits into from
Mar 18, 2021

Conversation

liranc
Copy link
Contributor

@liranc liranc commented Mar 16, 2021

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.

  1. 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
  2. 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.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. 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:

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
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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 16, 2021

    Swagger Validation Report

    ️❌BreakingChange: 10 Errors, 0 Warnings failed [Detail]

    Rule Message
    1034 - AddedRequiredProperty The new version has new required property 'onboardingKind' that was not found in the old version.
    New: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L297:7
    Old: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L297:7
    1034 - AddedRequiredProperty The new version has new required property 'onboardingKind' that was not found in the old version.
    New: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L282:9
    Old: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L282:9
    1034 - AddedRequiredProperty The new version has new required property 'onboardingKind' that was not found in the old version.
    New: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L294:5
    Old: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L294:5
    1034 - AddedRequiredProperty The new version has new required property 'onboardingKind' that was not found in the old version.
    New: Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json#L297:7
    Old: Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json#L297:7
    1034 - AddedRequiredProperty The new version has new required property 'onboardingKind' that was not found in the old version.
    New: Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json#L282:9
    Old: Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json#L282:9
    1034 - AddedRequiredProperty The new version has new required property 'onboardingKind' that was not found in the old version.
    New: Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json#L294:5
    Old: Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json#L294:5
    1041 - AddedPropertyInResponse The new version has a new property 'onboardingKind' in response that was not found in the old version.
    New: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L297:7
    Old: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L297:7
    1041 - AddedPropertyInResponse The new version has a new property 'onboardingKind' in response that was not found in the old version.
    New: Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json#L297:7
    Old: Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json#L297:7
    1045 - AddedOptionalProperty The new version has a new optional property 'onboardingKind' that was not found in the old version.
    New: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L297:7
    Old: Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json#L297:7
    1045 - AddedOptionalProperty The new version has a new optional property 'onboardingKind' that was not found in the old version.
    New: Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json#L297:7
    Old: Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json#L297:7
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION 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.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️❌[Staging] SDK Track2 Validation: 3 Errors, 35 Warnings failed [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    PreCheck/DuplicateSchema "readme":"security/resource-manager/readme.md",
    "tag":"package-composite-v3",
    "details":"Duplicate Schema named ExternalSecuritySolutionKind -- type: undefined => "string",
    properties: "kind":"description":"The kind of the external solution",
    "$ref":"#/components/schemas/ExternalSecuritySolutionKind" =>,
    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."
    PreCheck/DuplicateSchema "readme":"security/resource-manager/readme.md",
    "tag":"package-composite-v3",
    "details":"Duplicate Schema named AadConnectivityState -- type: undefined => "string",
    properties: "connectivityState":"$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."
    AutorestCore/Exception "readme":"security/resource-manager/readme.md",
    "tag":"package-composite-v3",
    "details":"Error: Plugin prechecker reported failure."
    ⚠️ PreCheck/SchemaMissingType "readme":"iotsecurity/resource-manager/readme.md",
    "tag":"2021-02-01-preview",
    "details":"The schema 'ErrorResponseModel-error' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"iotsecurity/resource-manager/readme.md",
    "tag":"2021-02-01-preview",
    "details":"The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"iotsecurity/resource-manager/readme.md",
    "tag":"2021-02-01-preview",
    "details":"The schema 'ProxyResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"iotsecurity/resource-manager/readme.md",
    "tag":"2021-02-01-preview",
    "details":"The schema 'ErrorDetail' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"iotsecurity/resource-manager/readme.md",
    "tag":"2021-02-01-preview",
    "details":"The schema 'ErrorResponse' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"iotsecurity/resource-manager/readme.md",
    "tag":"2021-02-01-preview",
    "details":"The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/CheckDuplicateSchemas "readme":"iotsecurity/resource-manager/readme.md",
    "tag":"2021-02-01-preview",
    "details":"Checking for duplicate schemas,
    this could take a (long) while. Run with --verbose for more detail."
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 16, 2021

    Swagger Generation Artifacts

    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from d9b7c90. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      warn		specification/iotsecurity/resource-manager/readme.md skipped due to azure-resource-manager-schemas not found in swagger-to-sdk
      command	autorest --use=@autorest/[email protected] --version=3.0.6374 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/security/resource-manager/readme.md
    • ️✔️security [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN
      cmderr	[resource-manager] Using request for node-pre-gyp https download
      cmderr	[resource-manager] npm WARN [email protected] No repository field.
      cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from d9b7c90. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      warn		specification/iotsecurity/resource-manager/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️azure-mgmt-security [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model PackageDownloads has a new parameter authorized_devices_import_template
      info	[Changelog]   - Model PackageDownloads has a new parameter device_information_update_import_template
      info	[Changelog]   - Model PackageDownloads has a new parameter wmi_tool
      info	[Changelog]   - Model PackageDownloads has a new parameter snmp
      info	[Changelog]   - Model IoTSecuritySolutionModel has a new parameter additional_workspaces
      info	[Changelog]   - Model IoTSecuritySolutionModel has a new parameter system_data
      info	[Changelog]   - Model IotAlert has a new parameter type
      info	[Changelog]   - Model IotAlert has a new parameter id
      info	[Changelog]   - Model IotAlert has a new parameter name
      info	[Changelog]   - Model IotAlertModel has a new parameter type
      info	[Changelog]   - Model IotAlertModel has a new parameter id
      info	[Changelog]   - Model IotAlertModel has a new parameter name
      info	[Changelog]   - Added operation IotDefenderSettingsOperations.download_manager_activation
      info	[Changelog]   - Added operation IotSensorsOperations.trigger_ti_package_update
      info	[Changelog]   - Added operation IotSensorsOperations.download_reset_password
      info	[Changelog]   - Added operation OnPremiseIotSensorsOperations.download_reset_password
      info	[Changelog]   - Added operation AlertsOperations.simulate
      info	[Changelog]   - Added operation AlertsOperations.get_subscription_level
      info	[Changelog]   - Added operation AlertsOperations.update_subscription_level_state_to_activate
      info	[Changelog]   - Added operation AlertsOperations.list_subscription_level_by_region
      info	[Changelog]   - Added operation AlertsOperations.list_resource_group_level_by_region
      info	[Changelog]   - Added operation AlertsOperations.update_resource_group_level_state_to_activate
      info	[Changelog]   - Added operation AlertsOperations.update_subscription_level_state_to_dismiss
      info	[Changelog]   - Added operation AlertsOperations.get_resource_group_level
      info	[Changelog]   - Added operation AlertsOperations.update_resource_group_level_state_to_dismiss
      info	[Changelog]   - Added operation group IotSitesOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Operation IotSensorsOperations.create_or_update has a new signature
      info	[Changelog]   - Model IotDefenderSettingsModel has a new required parameter onboarding_kind
      info	[Changelog]   - Operation IotDefenderSettingsOperations.create_or_update has a new signature
      info	[Changelog]   - Removed operation AlertsOperations.update_subscription_level_alert_state_to_dismiss
      info	[Changelog]   - Removed operation AlertsOperations.update_subscription_level_alert_state_to_reactivate
      info	[Changelog]   - Removed operation AlertsOperations.update_resource_group_level_alert_state_to_dismiss
      info	[Changelog]   - Removed operation AlertsOperations.list_resource_group_level_alerts_by_region
      info	[Changelog]   - Removed operation AlertsOperations.list_subscription_level_alerts_by_region
      info	[Changelog]   - Removed operation AlertsOperations.update_resource_group_level_alert_state_to_reactivate
      info	[Changelog]   - Removed operation AlertsOperations.get_subscription_level_alert
      info	[Changelog]   - Removed operation AlertsOperations.get_resource_group_level_alerts
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from d9b7c90. 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 [email protected]/[email protected] --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
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/security/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
    • ️✔️Microsoft.Azure.Management.SecurityCenter [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from d9b7c90. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      warn		specification/iotsecurity/resource-manager/readme.md skipped due to azure-sdk-for-go not found in swagger-to-sdk
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️preview/security/mgmt/v3.0/security [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 40 items here, please refer to log for details.
      info	[Changelog] - New function `DirectMethodInvokesNotInAllowedRange.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `ConnectionToIPNotAllowed.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `AlertsClient.ListSubscriptionLevelByRegionPreparer(context.Context) (*http.Request, error)`
      info	[Changelog] - New function `ConnectionFromIPNotAllowed.AsListCustomAlertRule() (*ListCustomAlertRule, bool)`
      info	[Changelog] - New function `ConnectionFromIPNotAllowed.AsMqttC2DRejectedMessagesNotInAllowedRange() (*MqttC2DRejectedMessagesNotInAllowedRange, bool)`
      info	[Changelog] - New function `AlertsClient.UpdateResourceGroupLevelStateToDismissResponder(*http.Response) (autorest.Response, error)`
      info	[Changelog] - New function `AlertsClient.UpdateResourceGroupLevelStateToDismissPreparer(context.Context, string, string) (*http.Request, error)`
      info	[Changelog] - New function `ListCustomAlertRule.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `PossibleCreatedByTypeValues() []CreatedByType`
      info	[Changelog] - New function `ProcessNotAllowed.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `PossibleOnboardingKindValues() []OnboardingKind`
      info	[Changelog] - New function `ConnectionFromIPNotAllowed.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `AlertsClient.ListResourceGroupLevelByRegionResponder(*http.Response) (AlertList, error)`
      info	[Changelog] - New function `ConnectionFromIPNotAllowed.AsHTTPC2DRejectedMessagesNotInAllowedRange() (*HTTPC2DRejectedMessagesNotInAllowedRange, bool)`
      info	[Changelog] - New function `AlertsClient.ListSubscriptionLevelByRegionComplete(context.Context) (AlertListIterator, error)`
      info	[Changelog] - New struct `AdditionalWorkspacesProperties`
      info	[Changelog] - New struct `AlertSimulatorBundlesRequestProperties`
      info	[Changelog] - New struct `AlertSimulatorRequestBody`
      info	[Changelog] - New struct `AlertSimulatorRequestProperties`
      info	[Changelog] - New struct `AlertsSimulateFuture`
      info	[Changelog] - New struct `ConnectionFromIPNotAllowed`
      info	[Changelog] - New struct `ErrorAdditionalInfo`
      info	[Changelog] - New struct `ServerVulnerabilityAssessmentDeleteFuture`
      info	[Changelog] - New struct `SystemData`
      info	[Changelog] - New field `ID` in struct `IotAlertModel`
      info	[Changelog] - New field `Name` in struct `IotAlertModel`
      info	[Changelog] - New field `Type` in struct `IotAlertModel`
      info	[Changelog] - New field `OnboardingKind` in struct `IotDefenderSettingsProperties`
      info	[Changelog] - New field `ID` in struct `IotAlert`
      info	[Changelog] - New field `Name` in struct `IotAlert`
      info	[Changelog] - New field `Type` in struct `IotAlert`
      info	[Changelog] - New field `SensorType` in struct `IotSensorProperties`
      info	[Changelog] - New field `SystemData` in struct `IoTSecuritySolutionModel`
      info	[Changelog] - New field `Target` in struct `CloudErrorBody`
      info	[Changelog] - New field `Details` in struct `CloudErrorBody`
      info	[Changelog] - New field `AdditionalInfo` in struct `CloudErrorBody`
      info	[Changelog] - New field `AdditionalWorkspaces` in struct `IoTSecuritySolutionProperties`
      info	[Changelog]
      info	[Changelog] Total 50 breaking change(s), 172 additive change(s).
      info	[Changelog]
    • ️✔️preview/security/mgmt/v2.0/security [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 40 items here, please refer to log for details.
      info	[Changelog] - Const `SettingKindDataExportSetting` has been removed
      info	[Changelog] - Const `SecureScoreControls` has been removed
      info	[Changelog] - Const `SettingKindAlertSuppressionSetting` has been removed
      info	[Changelog] - Const `SubAssessments` has been removed
      info	[Changelog] - Const `SecureScores` has been removed
      info	[Changelog] - Const `Alerts` has been removed
      info	[Changelog] - Function `SettingResource.MarshalJSON` has been removed
      info	[Changelog] - Function `PossibleSettingKindValues` has been removed
      info	[Changelog] - Struct `SettingResource` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `EventSourceSecureScoresSnapshot`
      info	[Changelog] - New const `EventSourceRegulatoryComplianceAssessmentSnapshot`
      info	[Changelog] - New const `EventSourceAssessments`
      info	[Changelog] - New const `EventSourceSecureScoreControls`
      info	[Changelog] - New const `EventSourceSubAssessments`
      info	[Changelog] - New const `EventSourceRegulatoryComplianceAssessment`
      info	[Changelog] - New const `EventSourceSecureScores`
      info	[Changelog] - New const `KindSetting`
      info	[Changelog] - New const `EventSourceAlerts`
      info	[Changelog] - New const `EventSourceSecureScoreControlsSnapshot`
      info	[Changelog] - New const `KindDataExportSetting`
      info	[Changelog] - New function `*SettingsList.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `Setting.AsDataExportSetting() (*DataExportSetting, bool)`
      info	[Changelog] - New function `Setting.AsSetting() (*Setting, bool)`
      info	[Changelog] - New function `DataExportSetting.AsBasicSetting() (BasicSetting, bool)`
      info	[Changelog] - New function `DataExportSetting.AsSetting() (*Setting, bool)`
      info	[Changelog] - New function `Setting.AsBasicSetting() (BasicSetting, bool)`
      info	[Changelog] - New function `*SettingModel.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `DataExportSetting.AsDataExportSetting() (*DataExportSetting, bool)`
      info	[Changelog] - New function `PossibleKindEnum1Values() []KindEnum1`
      info	[Changelog] - New struct `ErrorAdditionalInfo`
      info	[Changelog] - New struct `SettingModel`
      info	[Changelog] - New field `Target` in struct `CloudErrorBody`
      info	[Changelog] - New field `Details` in struct `CloudErrorBody`
      info	[Changelog] - New field `AdditionalInfo` in struct `CloudErrorBody`
      info	[Changelog]
      info	[Changelog] Total 29 breaking change(s), 26 additive change(s).
      info	[Changelog]
    • ️✔️preview/security/mgmt/v1.0/security [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 40 items here, please refer to log for details.
      info	[Changelog] - Const `Assessments` has been removed
      info	[Changelog] - Const `Alerts` has been removed
      info	[Changelog] - Const `SecureScoreControls` has been removed
      info	[Changelog] - Const `SettingKindAlertSuppressionSetting` has been removed
      info	[Changelog] - Const `SubAssessments` has been removed
      info	[Changelog] - Const `SettingKindDataExportSetting` has been removed
      info	[Changelog] - Function `PossibleSettingKindValues` has been removed
      info	[Changelog] - Function `SettingResource.MarshalJSON` has been removed
      info	[Changelog] - Struct `SettingResource` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `EventSourceSubAssessments`
      info	[Changelog] - New const `EventSourceSecureScores`
      info	[Changelog] - New const `EventSourceRegulatoryComplianceAssessment`
      info	[Changelog] - New const `EventSourceAssessments`
      info	[Changelog] - New const `EventSourceRegulatoryComplianceAssessmentSnapshot`
      info	[Changelog] - New const `EventSourceSecureScoresSnapshot`
      info	[Changelog] - New const `EventSourceSecureScoreControlsSnapshot`
      info	[Changelog] - New const `EventSourceSecureScoreControls`
      info	[Changelog] - New const `KindDataExportSetting`
      info	[Changelog] - New const `KindSetting`
      info	[Changelog] - New const `EventSourceAlerts`
      info	[Changelog] - New function `*SettingsList.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `Setting.AsSetting() (*Setting, bool)`
      info	[Changelog] - New function `DataExportSetting.AsDataExportSetting() (*DataExportSetting, bool)`
      info	[Changelog] - New function `Setting.AsBasicSetting() (BasicSetting, bool)`
      info	[Changelog] - New function `*SettingModel.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `DataExportSetting.AsSetting() (*Setting, bool)`
      info	[Changelog] - New function `Setting.AsDataExportSetting() (*DataExportSetting, bool)`
      info	[Changelog] - New function `PossibleKindEnum1Values() []KindEnum1`
      info	[Changelog] - New function `DataExportSetting.AsBasicSetting() (BasicSetting, bool)`
      info	[Changelog] - New struct `ErrorAdditionalInfo`
      info	[Changelog] - New struct `SettingModel`
      info	[Changelog] - New field `Details` in struct `CloudErrorBody`
      info	[Changelog] - New field `AdditionalInfo` in struct `CloudErrorBody`
      info	[Changelog] - New field `Target` in struct `CloudErrorBody`
      info	[Changelog]
      info	[Changelog] Total 29 breaking change(s), 26 additive change(s).
      info	[Changelog]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from d9b7c90. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      warn		specification/iotsecurity/resource-manager/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/security/resource-manager/readme.md
    • ️✔️@azure/arm-security [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/securityCenter.js → ./dist/arm-security.js...
      cmderr	[npmPack] created ./dist/arm-security.js in 1.4s
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @liranc liranc added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 16, 2021
    @openapi-workflow-bot
    Copy link

    Hi @liranc, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

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

    @openapi-workflow-bot
    Copy link

    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.

    @liranc
    Copy link
    Contributor Author

    liranc commented Mar 16, 2021

    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.

    @ruowan This PR contains breaking changes (new property for existing api-version), however this is a preview API version, so AFAIK this alert can be ignored.
    Can you confirm?

    @ruowan
    Copy link
    Member

    ruowan commented Mar 17, 2021

    The PR have breaking changes in public preview, it still need to go through breaking change review process.

    @ruowan ruowan added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 18, 2021
    MirzaSikander pushed a commit to MirzaSikander/azure-rest-api-specs that referenced this pull request Mar 22, 2021
    * onboardingKind field
    
    * Missing property in PUT example
    
    Co-authored-by: Liran Chen <[email protected]>
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * onboardingKind field
    
    * Missing property in PUT example
    
    Co-authored-by: Liran Chen <[email protected]>
    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 CI-BreakingChange-Go CI-BreakingChange-Python WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants