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

Metadata-Microsoft-Security-Insights-Metadata-API-Update #15780

Merged
merged 13 commits into from
Sep 21, 2021

Conversation

RishabhTyagiHub
Copy link
Contributor

@RishabhTyagiHub RishabhTyagiHub commented Aug 24, 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?
    • 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 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  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, @RishabhTyagiHub 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.

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Aug 24, 2021
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 24, 2021

    Swagger Validation Report

    ️❌BreakingChange: 12 Errors, 0 Warnings failed [Detail]
    Rule Message
    1041 - AddedPropertyInResponse The new version has a new property 'categories' in response that was not found in the old version.
    New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L653:7
    Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L601:7
    1041 - AddedPropertyInResponse The new version has a new property 'providers' in response that was not found in the old version.
    New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L653:7
    Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L601:7
    1041 - AddedPropertyInResponse The new version has a new property 'firstPublishDate' in response that was not found in the old version.
    New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L653:7
    Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L601:7
    1041 - AddedPropertyInResponse The new version has a new property 'lastPublishDate' in response that was not found in the old version.
    New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L653:7
    Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L601:7
    1045 - AddedOptionalProperty The new version has a new optional property 'categories' that was not found in the old version.
    New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L653:7
    Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L601:7
    1045 - AddedOptionalProperty The new version has a new optional property 'providers' that was not found in the old version.
    New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L653:7
    Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L601:7
    1045 - AddedOptionalProperty The new version has a new optional property 'firstPublishDate' that was not found in the old version.
    New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L653:7
    Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L601:7
    1045 - AddedOptionalProperty The new version has a new optional property 'lastPublishDate' that was not found in the old version.
    New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L653:7
    Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L601:7
    1045 - AddedOptionalProperty The new version has a new optional property 'categories' that was not found in the old version.
    New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L707:7
    Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L639:7
    1045 - AddedOptionalProperty The new version has a new optional property 'providers' that was not found in the old version.
    New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L707:7
    Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L639:7
    1045 - AddedOptionalProperty The new version has a new optional property 'firstPublishDate' that was not found in the old version.
    New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L707:7
    Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L639:7
    1045 - AddedOptionalProperty The new version has a new optional property 'lastPublishDate' that was not found in the old version.
    New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L707:7
    Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L639:7
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    R4017 - TopLevelResourcesListBySubscription The top-level resource 'EntityQueryTemplate' does not have list by subscription operation, please add it.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityQueryTemplates.json#L175
    R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.SecurityInsights/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json#L37
    R4037 - MissingTypeObject The schema 'RepoList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/SourceControls.json#L287
    R4037 - MissingTypeObject The schema 'WatchlistList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Watchlists.json#L448
    R4037 - MissingTypeObject The schema 'WatchlistItemList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Watchlists.json#L598
    R4037 - MissingTypeObject The schema 'EntityQueryList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityQueries.json#L258
    ⚠️ R1006 - PutInOperationName 'PUT' operation 'ProductSettings_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L185
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'ProductSettings_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L38
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'SentinelOnboardingStates_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json#L187
    ⚠️ R2057 - InvalidSkuModel Sku Model definition 'Sku' is not valid. A Sku model must have 'name' property. It can also have 'tier', 'size', 'family', 'capacity' as optional properties.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L400
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SourceControlModel'. Consider using the plural form of 'SourceControl' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/SourceControls.json#L48
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'comments' with immediate parent 'Incident', must have a list by immediate parent operation.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L1938
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'relations' with immediate parent 'Incident', must have a list by immediate parent operation.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L3385
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'watchlistItems' with immediate parent 'Watchlist', must have a list by immediate parent operation.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Watchlists.json#L618
    ⚠️ R3017 - GuidUsage Guid used in model definition 'AccountEntityProperties' for property 'objectGuid'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L947
    ⚠️ R3017 - GuidUsage Guid used in model definition 'ClientInfo' for property 'objectId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L1187
    ⚠️ R3017 - GuidUsage Guid used in model definition 'IncidentOwnerInfo' for property 'objectId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L2173
    ⚠️ R3017 - GuidUsage Guid used in model definition 'IoTDeviceEntityProperties' for property 'iotSecurityAgentId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L2467
    ⚠️ R3017 - GuidUsage Guid used in model definition 'MailboxEntityProperties' for property 'externalDirectoryObjectId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L2636
    ⚠️ R3017 - GuidUsage Guid used in model definition 'MailMessageEntityProperties' for property 'networkMessageId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L2857
    ⚠️ R3017 - GuidUsage Guid used in model definition 'SecurityGroupEntityProperties' for property 'objectGuid'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L3884
    ⚠️ R3017 - GuidUsage Guid used in model definition 'SubmissionMailEntityProperties' for property 'networkMessageId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L3923
    ⚠️ R3017 - GuidUsage Guid used in model definition 'UserInfo' for property 'objectId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Watchlists.json#L700
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDomainJoined
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L937
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDomainJoined
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L1699
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isVolumeAnomaly
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json#L2720
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L292
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L320
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L348
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: customerManagedKey
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.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 Aug 24, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌[Staging] SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-securityinsight - 1.0.0b1
    ️✔️azure-sdk-for-go - securityinsight/mgmt/v1.0/securityinsight - Approved - v56.3.0
    azure-sdk-for-go - securityinsight/mgmt/2020-01-01/securityinsight - Approved - v57.2.0
    +	Const `CaseSeverityCritical` has been removed
    +	Const `CaseSeverityHigh` has been removed
    +	Const `CaseSeverityInformational` has been removed
    +	Const `CaseSeverityLow` has been removed
    +	Const `CaseSeverityMedium` has been removed
    +	Const `KindBasicSettingsKindSettings` has been removed
    +	Const `KindBasicSettingsKindToggleSettings` has been removed
    +	Const `KindBasicSettingsKindUebaSettings` has been removed
    +	Const `LicenseStatusDisabled` has been removed
    +	Const `LicenseStatusEnabled` has been removed
    +	Const `SettingKindToggleSettings` has been removed
    +	Const `SettingKindUebaSettings` has been removed
    +	Const `StatusInMcasDisabled` has been removed
    +	Const `StatusInMcasEnabled` has been removed
    +	Function `*ToggleSettings.UnmarshalJSON` has been removed
    +	Function `*UebaSettings.UnmarshalJSON` has been removed
    +	Function `PossibleCaseSeverityValues` has been removed
    +	Function `PossibleKindBasicSettingsValues` has been removed
    +	Function `PossibleLicenseStatusValues` has been removed
    +	Function `PossibleSettingKindValues` has been removed
    +	Function `PossibleStatusInMcasValues` has been removed
    +	Function `Settings.AsBasicSettings` has been removed
    +	Function `Settings.AsSettings` has been removed
    +	Function `Settings.AsToggleSettings` has been removed
    +	Function `Settings.AsUebaSettings` has been removed
    +	Function `Settings.MarshalJSON` has been removed
    +	Function `ToggleSettings.AsBasicSettings` has been removed
    +	Function `ToggleSettings.AsSettings` has been removed
    +	Function `ToggleSettings.AsToggleSettings` has been removed
    +	Function `ToggleSettings.AsUebaSettings` has been removed
    +	Function `ToggleSettings.MarshalJSON` has been removed
    +	Function `UebaSettings.AsBasicSettings` has been removed
    +	Function `UebaSettings.AsSettings` has been removed
    +	Function `UebaSettings.AsToggleSettings` has been removed
    +	Function `UebaSettings.AsUebaSettings` has been removed
    +	Function `UebaSettings.MarshalJSON` has been removed
    +	Function `UebaSettingsProperties.MarshalJSON` has been removed
    +	Struct `Settings` has been removed
    +	Struct `ToggleSettingsProperties` has been removed
    +	Struct `ToggleSettings` has been removed
    +	Struct `UebaSettingsProperties` has been removed
    +	Struct `UebaSettings` has been removed
    +	Type of `IncidentInfo.Severity` has been changed from `CaseSeverity` to `IncidentSeverity`
    azure-sdk-for-go - preview/securityinsight/mgmt/2019-01-01-preview/securityinsight - Approved - v57.2.0
    +	Const `KindAggregations` has been removed
    +	Const `KindBasicEntityKindAccount` has been removed
    +	Const `KindBasicEntityKindAzureResource` has been removed
    +	Const `KindBasicEntityKindBookmark` has been removed
    +	Const `KindBasicEntityKindCloudApplication` has been removed
    +	Const `KindBasicEntityKindDNSResolution` has been removed
    +	Const `KindBasicEntityKindEntity` has been removed
    +	Const `KindBasicEntityKindFileHash` has been removed
    +	Const `KindBasicEntityKindFile` has been removed
    +	Const `KindBasicEntityKindHost` has been removed
    +	Const `KindBasicEntityKindIP` has been removed
    +	Const `KindBasicEntityKindIoTDevice` has been removed
    +	Const `KindBasicEntityKindMailCluster` has been removed
    +	Const `KindBasicEntityKindMailMessage` has been removed
    +	Const `KindBasicEntityKindMailbox` has been removed
    +	Const `KindBasicEntityKindMalware` has been removed
    +	Const `KindBasicEntityKindProcess` has been removed
    +	Const `KindBasicEntityKindRegistryKey` has been removed
    +	Const `KindBasicEntityKindRegistryValue` has been removed
    +	Const `KindBasicEntityKindSecurityAlert` has been removed
    +	Const `KindBasicEntityKindSecurityGroup` has been removed
    +	Const `KindBasicEntityKindSubmissionMail` has been removed
    +	Const `KindBasicEntityKindURL` has been removed
    +	Const `KindCasesAggregation` has been removed
    +	Function `PossibleKindBasicEntityValues` has been removed
    +	Function `ThreatIntelligenceIndicatorsClient.ListComplete` parameter(s) have been changed from `(context.Context, string, string, string, string, *int32, string, string)` to `(context.Context, string, string, string, string, string, *int32, string)`
    +	Function `ThreatIntelligenceIndicatorsClient.ListPreparer` parameter(s) have been changed from `(context.Context, string, string, string, string, *int32, string, string)` to `(context.Context, string, string, string, string, string, *int32, string)`
    +	Function `ThreatIntelligenceIndicatorsClient.List` parameter(s) have been changed from `(context.Context, string, string, string, string, *int32, string, string)` to `(context.Context, string, string, string, string, string, *int32, string)`
    +	Type of `AccountEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `Aggregations.Kind` has been changed from `Kind` to `KindBasicAggregations`
    +	Type of `AzureResourceEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `CasesAggregation.Kind` has been changed from `Kind` to `KindBasicAggregations`
    +	Type of `CloudApplicationEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `DNSEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `Entity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `FileEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `FileHashEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `HostEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `HuntingBookmark.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `IPEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `IncidentInfo.Severity` has been changed from `CaseSeverity` to `IncidentSeverity`
    +	Type of `IoTDeviceEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `MailClusterEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `MailMessageEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `MailboxEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `MalwareEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `ProcessEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `RegistryKeyEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `RegistryValueEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `SecurityAlert.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `SecurityGroupEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `SubmissionMailEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    +	Type of `URLEntity.Kind` has been changed from `KindBasicEntity` to `Kind`
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0cfcacb. 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/securityinsights/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.SecurityInsights [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0cfcacb. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️securityinsight/mgmt/2020-01-01/securityinsight [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `IncidentInfo.Severity` has been changed from `CaseSeverity` to `IncidentSeverity`
      info	[Changelog] - Const `LicenseStatusDisabled` has been removed
      info	[Changelog] - Const `CaseSeverityLow` has been removed
      info	[Changelog] - Const `KindBasicSettingsKindSettings` has been removed
      info	[Changelog] - Const `CaseSeverityHigh` has been removed
      info	[Changelog] - Const `StatusInMcasDisabled` has been removed
      info	[Changelog] - Const `SettingKindToggleSettings` has been removed
      info	[Changelog] - Const `StatusInMcasEnabled` has been removed
      info	[Changelog] - Const `CaseSeverityCritical` has been removed
      info	[Changelog] - Const `LicenseStatusEnabled` has been removed
      info	[Changelog] - Const `KindBasicSettingsKindToggleSettings` has been removed
      info	[Changelog] - Const `CaseSeverityInformational` has been removed
      info	[Changelog] - Const `SettingKindUebaSettings` has been removed
      info	[Changelog] - Const `KindBasicSettingsKindUebaSettings` has been removed
      info	[Changelog] - Const `CaseSeverityMedium` has been removed
      info	[Changelog] - Function `PossibleKindBasicSettingsValues` has been removed
      info	[Changelog] - Function `UebaSettings.AsSettings` has been removed
      info	[Changelog] - Function `PossibleCaseSeverityValues` has been removed
      info	[Changelog] - Function `ToggleSettings.AsBasicSettings` has been removed
      info	[Changelog] - Function `*UebaSettings.UnmarshalJSON` has been removed
      info	[Changelog] - Function `Settings.AsBasicSettings` has been removed
      info	[Changelog] - Function `UebaSettings.MarshalJSON` has been removed
      info	[Changelog] - Function `ToggleSettings.MarshalJSON` has been removed
      info	[Changelog] - Function `Settings.AsToggleSettings` has been removed
      info	[Changelog] - Function `ToggleSettings.AsToggleSettings` has been removed
      info	[Changelog] - Function `UebaSettings.AsToggleSettings` has been removed
      info	[Changelog] - Function `Settings.AsSettings` has been removed
      info	[Changelog] - Function `UebaSettings.AsUebaSettings` has been removed
      info	[Changelog] - Function `PossibleSettingKindValues` has been removed
      info	[Changelog] - Function `UebaSettings.AsBasicSettings` has been removed
      info	[Changelog] - Function `PossibleLicenseStatusValues` has been removed
      info	[Changelog] - Function `UebaSettingsProperties.MarshalJSON` has been removed
      info	[Changelog] - Function `ToggleSettings.AsUebaSettings` has been removed
      info	[Changelog] - Function `Settings.MarshalJSON` has been removed
      info	[Changelog] - Function `PossibleStatusInMcasValues` has been removed
      info	[Changelog] - Function `Settings.AsUebaSettings` has been removed
      info	[Changelog] - Function `*ToggleSettings.UnmarshalJSON` has been removed
      info	[Changelog] - Function `ToggleSettings.AsSettings` has been removed
      info	[Changelog] - Struct `Settings` has been removed
      info	[Changelog] - Struct `ToggleSettings` has been removed
      info	[Changelog] - Struct `ToggleSettingsProperties` has been removed
      info	[Changelog] - Struct `UebaSettings` has been removed
      info	[Changelog] - Struct `UebaSettingsProperties` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog]
      info	[Changelog] Total 49 breaking change(s), 0 additive change(s).
      info	[Changelog]
    • ️✔️preview/securityinsight/mgmt/2019-01-01-preview/securityinsight [View full logsBreaking Change Detected
      Only show 60 items here, please refer to log for details.
      info	[Changelog] - New const `KindDNSResolution`
      info	[Changelog] - New const `KindIP`
      info	[Changelog] - New const `KindURL`
      info	[Changelog] - New const `KindMailbox`
      info	[Changelog] - New const `KindAzureResource`
      info	[Changelog] - New const `KindAccount`
      info	[Changelog] - New const `KindMailMessage`
      info	[Changelog] - New const `KindBookmark`
      info	[Changelog] - New const `KindRegistryValue`
      info	[Changelog] - New const `KindFile`
      info	[Changelog] - New const `KindSecurityAlert`
      info	[Changelog] - New const `KindBasicSettingsKindAnomalies`
      info	[Changelog] - New const `KindIoTDevice`
      info	[Changelog] - New const `KindRegistryKey`
      info	[Changelog] - New const `SettingKindAnomalies`
      info	[Changelog] - New const `KindFileHash`
      info	[Changelog] - New const `KindProcess`
      info	[Changelog] - New const `KindCloudApplication`
      info	[Changelog] - New const `KindBasicAggregationsKindCasesAggregation`
      info	[Changelog] - New function `Anomalies.AsIPSyncer() (*IPSyncer, bool)`
      info	[Changelog] - New function `IPGeodataClient.GetResponder(*http.Response) (EnrichmentIPGeodata, error)`
      info	[Changelog] - New function `DomainWhoisClient.GetPreparer(context.Context, string, string) (*http.Request, error)`
      info	[Changelog] - New function `NewDomainWhoisClient(string) DomainWhoisClient`
      info	[Changelog] - New function `AnomaliesProperties.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `Settings.AsAnomalies() (*Anomalies, bool)`
      info	[Changelog] - New function `Anomalies.AsSettings() (*Settings, bool)`
      info	[Changelog] - New function `Anomalies.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `IPGeodataClient.Get(context.Context, string, string) (EnrichmentIPGeodata, error)`
      info	[Changelog] - New function `NewDomainWhoisClientWithBaseURI(string, string) DomainWhoisClient`
      info	[Changelog] - New function `PossibleKindBasicAggregationsValues() []KindBasicAggregations`
      info	[Changelog] - New function `Anomalies.AsAnomalies() (*Anomalies, bool)`
      info	[Changelog] - New function `IPSyncer.AsAnomalies() (*Anomalies, bool)`
      info	[Changelog] - New function `Anomalies.AsBasicSettings() (BasicSettings, bool)`
      info	[Changelog] - New function `EntityAnalytics.AsAnomalies() (*Anomalies, bool)`
      info	[Changelog] - New function `Anomalies.AsEntityAnalytics() (*EntityAnalytics, bool)`
      info	[Changelog] - New function `DomainWhoisClient.Get(context.Context, string, string) (EnrichmentDomainWhois, error)`
      info	[Changelog] - New function `Anomalies.AsUeba() (*Ueba, bool)`
      info	[Changelog] - New function `*Anomalies.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `IPGeodataClient.GetPreparer(context.Context, string, string) (*http.Request, error)`
      info	[Changelog] - New function `EyesOn.AsAnomalies() (*Anomalies, bool)`
      info	[Changelog] - New function `IPGeodataClient.GetSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `Ueba.AsAnomalies() (*Anomalies, bool)`
      info	[Changelog] - New function `DomainWhoisClient.GetResponder(*http.Response) (EnrichmentDomainWhois, error)`
      info	[Changelog] - New function `DomainWhoisClient.GetSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `NewIPGeodataClient(string) IPGeodataClient`
      info	[Changelog] - New function `NewIPGeodataClientWithBaseURI(string, string) IPGeodataClient`
      info	[Changelog] - New function `Anomalies.AsEyesOn() (*EyesOn, bool)`
      info	[Changelog] - New struct `Anomalies`
      info	[Changelog] - New struct `AnomaliesProperties`
      info	[Changelog] - New struct `DomainWhoisClient`
      info	[Changelog] - New struct `EnrichmentDomainWhois`
      info	[Changelog] - New struct `EnrichmentDomainWhoisContact`
      info	[Changelog] - New struct `EnrichmentDomainWhoisContacts`
      info	[Changelog] - New struct `EnrichmentDomainWhoisDetails`
      info	[Changelog] - New struct `EnrichmentDomainWhoisRegistrarDetails`
      info	[Changelog] - New struct `EnrichmentIPGeodata`
      info	[Changelog] - New struct `IPGeodataClient`
      info	[Changelog]
      info	[Changelog] Total 53 breaking change(s), 75 additive change(s).
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 0cfcacb. 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
    • ️✔️track2_azure-mgmt-securityinsight [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model TIDataConnector has a new parameter tip_lookback_period
      info	[Changelog]   - Model OfficeDataConnectorDataTypes has a new parameter teams
      info	[Changelog]   - Model Operation has a new parameter origin
      info	[Changelog]   - Model Bookmark has a new parameter query_end_time
      info	[Changelog]   - Model Bookmark has a new parameter event_time
      info	[Changelog]   - Model Bookmark has a new parameter query_start_time
      info	[Changelog]   - Added operation ActionsOperations.delete
      info	[Changelog]   - Added operation ActionsOperations.create_or_update
      info	[Changelog]   - Added operation ActionsOperations.get
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Operation IncidentCommentsOperations.create_comment has a new signature
      info	[Changelog]   - Parameter trigger_uri of model ActionRequestProperties is now required
      info	[Changelog]   - Removed operation AlertRulesOperations.create_or_update_action
      info	[Changelog]   - Removed operation AlertRulesOperations.delete_action
      info	[Changelog]   - Removed operation AlertRulesOperations.get_action
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0cfcacb. 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.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/securityinsights/resource-manager/readme.md
    • ️✔️@azure/arm-securityinsight [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/securityInsights.js → ./dist/arm-securityinsight.js...
      cmderr	[npmPack] created ./dist/arm-securityinsight.js in 371ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 0cfcacb. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh]
      cmderr	[initScript.sh]  The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh]  so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh]
      cmderr	[initScript.sh]  This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh]
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      cmderr	[generateScript.sh] (node:2705) UnhandledPromiseRejectionWarning: SyntaxError: Unexpected end of JSON input
      cmderr	[generateScript.sh]     at JSON.parse (<anonymous>)
      cmderr	[generateScript.sh]     at Object.readJsonFile (/home/vsts/work/1/s/azure-resource-manager-schemas/generator/utils.ts:174:17)
      cmderr	[generateScript.sh]     at getCurrentTemplateRefs (/home/vsts/work/1/s/azure-resource-manager-schemas/generator/generate.ts:290:21)
      cmderr	[generateScript.sh]     at /home/vsts/work/1/s/azure-resource-manager-schemas/generator/generate.ts:297:29
      cmderr	[generateScript.sh] (Use `node --trace-warnings ...` to show where the warning was created)
      cmderr	[generateScript.sh] (node:2705) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
      cmderr	[generateScript.sh] (node:2705) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
    • ️✔️securityinsights [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost
    Copy link

    ghost commented Aug 24, 2021

    Thank you for your contribution RishabhTyagiHub! We will review the pull request and get back to you soon.

    @ghost
    Copy link

    ghost commented Aug 24, 2021

    CLA assistant check
    All CLA requirements met.

    @openapi-workflow-bot
    Copy link

    Hi @RishabhTyagiHub, 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

    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.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 13, 2021
    @RishabhTyagiHub RishabhTyagiHub marked this pull request as ready for review September 13, 2021 17:23
    @zhenglaizhang
    Copy link
    Contributor

    @ArcturusZhang pls help check go SDK breaking change.

    @ArcturusZhang ArcturusZhang added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Sep 16, 2021
    @zhenglaizhang zhenglaizhang merged commit 0cfcacb into Azure:main Sep 21, 2021
    Hardell pushed a commit to Hardell/azure-rest-api-specs that referenced this pull request Sep 27, 2021
    * Metadata-Microsoft-Security-Insights-Metadata-API-Update
    
    * newcommit
    
    * Metadata-Swagger-Update-SVG
    
    * Metadata-Update-Svg-Patch
    
    * Metadata-Swagger-Update
    
    * Updating-Example-Files
    
    * Update date to date-time
    
    * change-datetime-to-date
    
    * Remove-SVG-3
    
    * Metadata-Swagger-Update
    
    * Category-to-Categories
    
    * Update-publish-date-in-examples
    
    * Update-publish-date-in-examples
    
    Co-authored-by: Rishabh Tyagi <rishabhtyagi@microsoft.com>
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    * Metadata-Microsoft-Security-Insights-Metadata-API-Update
    
    * newcommit
    
    * Metadata-Swagger-Update-SVG
    
    * Metadata-Update-Svg-Patch
    
    * Metadata-Swagger-Update
    
    * Updating-Example-Files
    
    * Update date to date-time
    
    * change-datetime-to-date
    
    * Remove-SVG-3
    
    * Metadata-Swagger-Update
    
    * Category-to-Categories
    
    * Update-publish-date-in-examples
    
    * Update-publish-date-in-examples
    
    Co-authored-by: Rishabh Tyagi <rishabhtyagi@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 Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go CI-BreakingChange-Go customer-reported Issues that are reported by GitHub users external to the Azure organization.
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants