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

Updating Microsoft.Security sub assessments API examples #12937

Merged
merged 4 commits into from
Feb 21, 2021

Conversation

himarkov
Copy link
Contributor

@himarkov himarkov commented Feb 10, 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
    • 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, @himarkov 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
    Copy link

    openapi-pipeline-app bot commented Feb 10, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️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 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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 10, 2021

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c2ce9ba. 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/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-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c2ce9ba. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --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.1s
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c2ce9ba. 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.
      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 IotAlertModel 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 PackageDownloads has a new parameter authorized_devices_import_template
      info	[Changelog]   - Model PackageDownloads has a new parameter wmi_tool
      info	[Changelog]   - Model PackageDownloads has a new parameter device_information_update_import_template
      info	[Changelog]   - Model PackageDownloads has a new parameter snmp
      info	[Changelog]   - Model IotAlert has a new parameter name
      info	[Changelog]   - Model IotAlert has a new parameter type
      info	[Changelog]   - Model IotAlert has a new parameter id
      info	[Changelog]   - Model IoTSecuritySolutionModel has a new parameter system_data
      info	[Changelog]   - Model IoTSecuritySolutionModel has a new parameter additional_workspaces
      info	[Changelog]   - Added operation IotDefenderSettingsOperations.download_manager_activation
      info	[Changelog]   - Added operation OnPremiseIotSensorsOperations.download_reset_password
      info	[Changelog]   - Added operation IotSensorsOperations.download_reset_password
      info	[Changelog]   - Added operation IotSensorsOperations.trigger_ti_package_update
      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
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c2ce9ba. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      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 `ConnectionFromIPNotAllowed.AsUnauthorizedOperationsNotInAllowedRange() (*UnauthorizedOperationsNotInAllowedRange, bool)`
      info	[Changelog] - New function `LocalUserNotAllowed.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `FailedLocalLoginsNotInAllowedRange.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `ConnectionFromIPNotAllowed.AsBasicThresholdCustomAlertRule() (BasicThresholdCustomAlertRule, bool)`
      info	[Changelog] - New function `ConnectionFromIPNotAllowed.AsHTTPD2CMessagesNotInAllowedRange() (*HTTPD2CMessagesNotInAllowedRange, bool)`
      info	[Changelog] - New function `PossibleAdditionalWorkspaceTypeValues() []AdditionalWorkspaceType`
      info	[Changelog] - New function `AllowlistCustomAlertRule.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `ConnectionFromIPNotAllowed.AsThresholdCustomAlertRule() (*ThresholdCustomAlertRule, bool)`
      info	[Changelog] - New function `ConnectionFromIPNotAllowed.AsLocalUserNotAllowed() (*LocalUserNotAllowed, bool)`
      info	[Changelog] - New function `HTTPD2CMessagesNotInAllowedRange.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `ActiveConnectionsNotInAllowedRange.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `MqttC2DMessagesNotInAllowedRange.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `ListCustomAlertRule.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `ConnectionToIPNotAllowed.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `ConnectionFromIPNotAllowed.AsBasicCustomAlertRule() (BasicCustomAlertRule, bool)`
      info	[Changelog] - New function `PossibleAdditionalWorkspaceDataTypeValues() []AdditionalWorkspaceDataType`
      info	[Changelog] - New function `ConnectionFromIPNotAllowed.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `CustomAlertRule.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `ConnectionFromIPNotAllowed.AsBasicListCustomAlertRule() (BasicListCustomAlertRule, bool)`
      info	[Changelog] - New function `AmqpC2DMessagesNotInAllowedRange.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `AmqpC2DRejectedMessagesNotInAllowedRange.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New function `HTTPC2DMessagesNotInAllowedRange.AsConnectionFromIPNotAllowed() (*ConnectionFromIPNotAllowed, bool)`
      info	[Changelog] - New struct `AdditionalWorkspacesProperties`
      info	[Changelog] - New struct `ConnectionFromIPNotAllowed`
      info	[Changelog] - New struct `ErrorAdditionalInfo`
      info	[Changelog] - New struct `SystemData`
      info	[Changelog] - New field `SystemData` in struct `IoTSecuritySolutionModel`
      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 `ID` in struct `IotAlert`
      info	[Changelog] - New field `Name` in struct `IotAlert`
      info	[Changelog] - New field `Type` in struct `IotAlert`
      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] - New field `AdditionalWorkspaces` in struct `IoTSecuritySolutionProperties`
      info	[Changelog]
      info	[Changelog] Total 14 breaking change(s), 92 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 `SubAssessments` has been removed
      info	[Changelog] - Const `Alerts` has been removed
      info	[Changelog] - Const `SettingKindAlertSuppressionSetting` has been removed
      info	[Changelog] - Const `Assessments` has been removed
      info	[Changelog] - Const `SecureScores` 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 `KindSetting`
      info	[Changelog] - New const `EventSourceAssessments`
      info	[Changelog] - New const `EventSourceSecureScoreControlsSnapshot`
      info	[Changelog] - New const `EventSourceSecureScores`
      info	[Changelog] - New const `EventSourceAlerts`
      info	[Changelog] - New const `EventSourceSecureScoreControls`
      info	[Changelog] - New const `KindDataExportSetting`
      info	[Changelog] - New const `EventSourceRegulatoryComplianceAssessment`
      info	[Changelog] - New const `EventSourceSecureScoresSnapshot`
      info	[Changelog] - New const `EventSourceSubAssessments`
      info	[Changelog] - New const `EventSourceRegulatoryComplianceAssessmentSnapshot`
      info	[Changelog] - New function `PossibleKindEnum1Values() []KindEnum1`
      info	[Changelog] - New function `*SettingModel.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 `DataExportSetting.AsSetting() (*Setting, bool)`
      info	[Changelog] - New function `DataExportSetting.AsBasicSetting() (BasicSetting, bool)`
      info	[Changelog] - New function `Setting.AsDataExportSetting() (*DataExportSetting, bool)`
      info	[Changelog] - New function `*SettingsList.UnmarshalJSON([]byte) error`
      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 `SecureScores` has been removed
      info	[Changelog] - Const `SettingKindDataExportSetting` has been removed
      info	[Changelog] - Const `SecureScoreControls` has been removed
      info	[Changelog] - Const `SubAssessments` has been removed
      info	[Changelog] - Const `Alerts` has been removed
      info	[Changelog] - Const `SettingKindAlertSuppressionSetting` 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 `EventSourceAlerts`
      info	[Changelog] - New const `KindSetting`
      info	[Changelog] - New const `EventSourceSecureScoresSnapshot`
      info	[Changelog] - New const `EventSourceSecureScoreControls`
      info	[Changelog] - New const `EventSourceSecureScoreControlsSnapshot`
      info	[Changelog] - New const `EventSourceSubAssessments`
      info	[Changelog] - New const `EventSourceRegulatoryComplianceAssessment`
      info	[Changelog] - New const `KindDataExportSetting`
      info	[Changelog] - New const `EventSourceSecureScores`
      info	[Changelog] - New const `EventSourceRegulatoryComplianceAssessmentSnapshot`
      info	[Changelog] - New const `EventSourceAssessments`
      info	[Changelog] - New function `*SettingModel.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `Setting.AsSetting() (*Setting, bool)`
      info	[Changelog] - New function `Setting.AsDataExportSetting() (*DataExportSetting, bool)`
      info	[Changelog] - New function `DataExportSetting.AsBasicSetting() (BasicSetting, bool)`
      info	[Changelog] - New function `PossibleKindEnum1Values() []KindEnum1`
      info	[Changelog] - New function `DataExportSetting.AsSetting() (*Setting, bool)`
      info	[Changelog] - New function `*SettingsList.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `DataExportSetting.AsDataExportSetting() (*DataExportSetting, bool)`
      info	[Changelog] - New function `Setting.AsBasicSetting() (BasicSetting, bool)`
      info	[Changelog] - New struct `ErrorAdditionalInfo`
      info	[Changelog] - New struct `SettingModel`
      info	[Changelog] - New field `AdditionalInfo` in struct `CloudErrorBody`
      info	[Changelog] - New field `Target` in struct `CloudErrorBody`
      info	[Changelog] - New field `Details` in struct `CloudErrorBody`
      info	[Changelog]
      info	[Changelog] Total 29 breaking change(s), 26 additive change(s).
      info	[Changelog]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c2ce9ba. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/azureresourceschema@3.0.92 --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 Using request for node-pre-gyp https download
      cmderr	[resource-manager] WARN template-schema-validation-tools@1.0.0 No repository field.
      cmderr	[resource-manager] optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
      cmderr	[resource-manager] npm ERR! code ELIFECYCLE
      cmderr	[resource-manager] npm ERR! errno 1
      cmderr	[resource-manager] npm ERR! template-schema-validation-tools@1.0.0 test: `mocha -r ts-node/register tests.ts`
      cmderr	[resource-manager] npm ERR! Exit status 1
      cmderr	[resource-manager] npm ERR!
      cmderr	[resource-manager] npm ERR! Failed at the template-schema-validation-tools@1.0.0 test script.
      cmderr	[resource-manager] npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
      cmderr	[resource-manager]  A complete log of this run can be found in:
      cmderr	[resource-manager] npm ERR!     /home/vsts/.npm/_logs/2021-02-21T21_44_01_458Z-debug.log
      cmderr	[resource-manager] Error: Command failed: npm run test --prefix tools
      cmderr	[resource-manager]     at checkExecSyncError (child_process.js:635:11)
      cmderr	[resource-manager]     at Object.execSync (child_process.js:671:15)
      cmderr	[resource-manager]     at Object.<anonymous> (/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas/sdkauto_afterscript.js:13:28)
      cmderr	[resource-manager]     at Module._compile (internal/modules/cjs/loader.js:999:30)
      cmderr	[resource-manager]     at Object.Module._extensions..js (internal/modules/cjs/loader.js:1027:10)
      cmderr	[resource-manager]     at Module.load (internal/modules/cjs/loader.js:863:32)
      cmderr	[resource-manager]     at Function.Module._load (internal/modules/cjs/loader.js:708:14)
      cmderr	[resource-manager]     at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:60:12)
      cmderr	[resource-manager]     at internal/main/run_main_module.js:17:47 {
      cmderr	[resource-manager]   status: 1,
      cmderr	[resource-manager]   signal: null,
      cmderr	[resource-manager]   output: [ null, null, null ],
      cmderr	[resource-manager]   pid: 3564,
      cmderr	[resource-manager]   stdout: null,
      cmderr	[resource-manager]   stderr: null
      cmderr	[resource-manager] }
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    @zhenglaizhang
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants