sentinel content hub package and template API #23151

xuhumsft · 2023-03-17T06:32:35Z

ARM API Information (Control Plane)

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

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

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When 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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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

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

ARM API Review Checklist

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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- 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. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2023-03-17T06:32:38Z

Hi, @xuhumsft 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. vscswagger@microsoft.com

openapi-pipeline-app · 2023-03-17T06:32:39Z

Swagger Validation Report

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

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️LintDiff: 4 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-preview-2023-04	package-preview-2023-04(6feb597)	package-preview-2023-04(release-Sentinel-2023-04-01-preview)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
⚠️ PutInOperationName	'PUT' operation 'ContentPackage_Install' 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/2023-04-01-preview/ContentPackages.json#L148
⚠️ DeleteInOperationName	'DELETE' operation 'ContentPackage_Uninstall' should use method name 'Delete'. 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/2023-04-01-preview/ContentPackages.json#L200
⚠️ PutInOperationName	'PUT' operation 'ContentTemplate_Install' 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/2023-04-01-preview/ContentTemplates.json#L105
⚠️ UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get a template. Location: Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentTemplates.json#L148

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

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

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

openapi-pipeline-app · 2023-03-17T06:32:39Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️⚠️SDK Breaking Change Tracking warning [Detail]

Breaking Changes Tracking

⚠️azure-sdk-for-js - @azure/arm-securityinsight - 1.0.0-beta.7

+	Interface MstiDataConnectorDataTypes no longer has parameter bingSafetyPhishingURL
+	Operation Incidents.createTeam has a new signature
+	Parameter logicAppResourceId of interface PlaybookActionProperties is now required
+	Removed Enum KnownEntityKind
+	Removed Enum KnownEnum13
+	Type of parameter additionalData of interface AccountEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface AzureResourceEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface CloudApplicationEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface DnsEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface EntityCommonProperties is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface EntityEdges is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface FileEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface FileHashEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface HostEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface HuntingBookmark is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface IoTDeviceEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface IpEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface MailClusterEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface MailMessageEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface MailboxEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface MalwareEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface NicEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface ProcessEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface RegistryKeyEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface RegistryValueEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface SecurityAlert is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface SecurityGroupEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface SubmissionMailEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface ThreatIntelligenceIndicatorModel is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface UrlEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter dependencies of interface MetadataModel is changed from MetadataDependencies to MetadataDependenciesAutoGenerated
+	Type of parameter dependencies of interface MetadataPatch is changed from MetadataDependencies to MetadataDependenciesAutoGenerated
+	Type of parameter entityKind of interface ExpansionResultAggregation is changed from EntityKind to EntityKindEnum
+	Type of parameter entityKind of interface IncidentEntitiesResultsMetadata is changed from EntityKind to EntityKindEnum
+	Type of parameter kind of interface Entity is changed from EntityKind to EntityKindEnum
+	Type of parameter kind of interface EntityQueriesListOptionalParams is changed from Enum13 to Enum19
+	Type of parameter kind of interface MetadataModel is changed from Kind to string
+	Type of parameter kind of interface MetadataPatch is changed from Kind to string

️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-securityinsight - 2.0.0b2

+	Model MSTIDataConnectorDataTypes no longer has parameter bing_safety_phishing_url
+	Parameter logic_app_resource_id of model PlaybookActionProperties is now required

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 63f6f80d13db756f39d8f13f02d1fc44c15e4680. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.SecurityInsights [View full logs] [Preview SDK Changes]
- Azure.ResourceManager.SecurityInsights.1.1.0-alpha.20230331.1.nupkg
```
info	[Changelog]
```

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs] Generate from 63f6f80d13db756f39d8f13f02d1fc44c15e4680. 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
cmderr	[automation_generate.sh] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.3
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.3>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.3` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-securityinsight [View full logs] [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation EntitiesOperations.run_playbook
info	[Changelog]   - Added operation group AlertRuleOperations
info	[Changelog]   - Added operation group ContentPackageOperations
info	[Changelog]   - Added operation group ContentPackagesOperations
info	[Changelog]   - Added operation group ContentTemplateOperations
info	[Changelog]   - Added operation group ContentTemplatesOperations
info	[Changelog]   - Added operation group GetTriggeredAnalyticsRuleRunsOperations
info	[Changelog]   - Added operation group HuntCommentsOperations
info	[Changelog]   - Added operation group HuntRelationsOperations
info	[Changelog]   - Added operation group HuntsOperations
info	[Changelog]   - Added operation group ProductPackageOperations
info	[Changelog]   - Added operation group ProductPackagesOperations
info	[Changelog]   - Added operation group ProductTemplateOperations
info	[Changelog]   - Added operation group ProductTemplatesOperations
info	[Changelog]   - Added operation group TriggeredAnalyticsRuleRunOperations
info	[Changelog]   - Added operation group WorkspaceManagerAssignmentJobsOperations
info	[Changelog]   - Added operation group WorkspaceManagerAssignmentsOperations
info	[Changelog]   - Added operation group WorkspaceManagerConfigurationsOperations
info	[Changelog]   - Added operation group WorkspaceManagerGroupsOperations
info	[Changelog]   - Added operation group WorkspaceManagerMembersOperations
info	[Changelog]   - Model MTPDataConnector has a new parameter filtered_providers
info	[Changelog]   - Model MTPDataConnectorDataTypes has a new parameter alerts
info	[Changelog]   - Model MTPDataConnectorProperties has a new parameter filtered_providers
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Model MSTIDataConnectorDataTypes no longer has parameter bing_safety_phishing_url
info	[Changelog]   - Parameter logic_app_resource_id of model PlaybookActionProperties is now required

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 63f6f80d13db756f39d8f13f02d1fc44c15e4680. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-securityinsight [View full logs] [Preview SDK Changes] Breaking Change Detected

azure-arm-securityinsight-1.0.0-beta.7.tgz

Only show 120 items here, please refer to log for details.

info	[Changelog]   - Type of parameter additionalData of interface DnsEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter kind of interface Entity is changed from EntityKind to EntityKindEnum
info	[Changelog]   - Type of parameter additionalData of interface EntityCommonProperties is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface EntityEdges is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter kind of interface EntityQueriesListOptionalParams is changed from Enum13 to Enum19
info	[Changelog]   - Type of parameter entityKind of interface ExpansionResultAggregation is changed from EntityKind to EntityKindEnum
info	[Changelog]   - Type of parameter additionalData of interface FileEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface FileHashEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface HostEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface HuntingBookmark is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter entityKind of interface IncidentEntitiesResultsMetadata is changed from EntityKind to EntityKindEnum
info	[Changelog]   - Type of parameter additionalData of interface IoTDeviceEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface IpEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface MailboxEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface MailClusterEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface MailMessageEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface MalwareEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter dependencies of interface MetadataModel is changed from MetadataDependencies to MetadataDependenciesAutoGenerated
info	[Changelog]   - Type of parameter kind of interface MetadataModel is changed from Kind to string
info	[Changelog]   - Type of parameter dependencies of interface MetadataPatch is changed from MetadataDependencies to MetadataDependenciesAutoGenerated
info	[Changelog]   - Type of parameter kind of interface MetadataPatch is changed from Kind to string
info	[Changelog]   - Type of parameter additionalData of interface NicEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface ProcessEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface RegistryKeyEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface RegistryValueEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface SecurityAlert is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface SecurityGroupEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface SubmissionMailEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface ThreatIntelligenceIndicatorModel is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Type of parameter additionalData of interface UrlEntity is changed from {
info	[Changelog]         [propertyName: string]: Record<string, unknown>;
info	[Changelog]     } to {
info	[Changelog]         [propertyName: string]: any;
info	[Changelog]     }
info	[Changelog]   - Removed Enum KnownEntityKind
info	[Changelog]   - Removed Enum KnownEnum13

️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 63f6f80d13db756f39d8f13f02d1fc44c15e4680. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-securityinsights [View full logs] [Preview SDK Changes]

️❌ azure-resource-manager-schemas failed [Detail]

❌Failed [Logs] Generate from 63f6f80d13db756f39d8f13f02d1fc44c15e4680. 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]  WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
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
warn	No file changes detected after generation

❌securityinsights/resource-manager [View full logs]

️❌ azure-powershell failed [Detail]

❌Failed [Logs] Generate from 63f6f80d13db756f39d8f13f02d1fc44c15e4680. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

❌Az.securityinsights.DefaultTag [View full logs] [Preview SDK Changes]

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

openapi-pipeline-app · 2023-03-17T06:32:40Z

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.SecurityInsights	https://apiview.dev/Assemblies/Review/02caebec697c426a965b32cb809b974a
.Net	Azure.ResourceManager.SecurityInsights	There is no API change compared with the previous version
Java	azure-resourcemanager-securityinsights	https://apiview.dev/Assemblies/Review/0b29d8ed10fd408ea29767ed21fd9e64
JavaScript	@azure/arm-securityinsight	Create ApiView failed. Please ask PR assignee for help

openapi-workflow-bot · 2023-03-17T06:49:26Z

Hi @xuhumsft, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

archerzz · 2023-03-21T03:29:32Z

/azp run

azure-pipelines · 2023-03-21T03:29:42Z

Azure Pipelines successfully started running 1 pipeline(s).

raosuhas · 2023-03-23T18:06:55Z

.../resource-manager/Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentPackages.json

+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentPackages/{packageId}": {
+      "get": {
+        "x-ms-examples": {
+          "Get all available packages.": {


et all available p

update , this is not for all available packages #Resolved

raosuhas · 2023-03-23T18:07:16Z

.../resource-manager/Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentPackages.json

+            "$ref": "../../../common/2.0/types.json#/parameters/ODataTop"
+          },
+          {
+            "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken"


why do you need ODATA filters for a GET on a specific resource ? #Resolved

raosuhas · 2023-03-23T18:08:14Z

.../resource-manager/Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentPackages.json

+            "$ref": "#/parameters/PackageIdParameter"
+          },
+          {
+            "$ref": "#/parameters/PackageInstallationProperties"


PackageInstallationProperties

the incoming PUT needs to have the full resource not just the properties in the body

Ideally this should be packagemodel

@raosuhas It was package model. But I got an error from the scanner says the package Id should be removed because it is already in the url. So I removed it to satisfy the scanner.

Since packageId is part of "id" property of packageModel anyway, why is packageId property needed explicitly needed in packageModel? That would eliminate the need of separate model for request and response.

Also, ARM requires RPs to have same model for request and response in PUT APIs.

@visingla-ms
One of the scanner, I think it is the ~[Staging] Swagger LintDiff scanner, suggests me to remove PackageIdParameter in the body as it is already in the URL. If I should ignore it. please let me know.

Sorry, my question was, why not remove "packageId" property from "packageModel" itself. Then if you will use
packageModel" in request payload also, Linter won't have any issue. And, you don't "packageId" in "packageModel", as it is already part of "id" property of "packageModel"

@visingla-ms
I believe there is another rule. If the get by id API return a response object, the list APIs should return a collection of the same object. packageModel is our response object for package API. The packageId is our identifier of response object. A user would need this id to call get by id from the list in our workflow. That is the reason that we have that in the packageModel.

@xuhumsft Let's catch up offline for this point. I am finding more details about usage of free-form objects, will ping you after that.

Sure, please feel free to ping me. If you would like to schedule a meeting, please let me know I can schedule it. Thank you.

Hi @visingla-ms,
I have a discussion with the same. We would change the packageId to contentId and we still need the conentId in the body.
The contentId can be the same as the {id} part of the url but It is also possible that they are not equal.
In some cases, we allow the contentId to be the same with different contentKind. In that case, the {id} in the url would have those information to make sure no collisions. However, we still need the conentId for searching. So, we decide to have the decidated contentId in the body. the {id} could be different to avoid collisions.

...ce-manager/Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentProductPackages.json

raosuhas · 2023-03-23T18:14:24Z

...e-manager/Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentProductTemplates.json

+        "packagedContent": {
+          "type": "object",
+          "description": "the json to deploy"
+        }


free form objects are not allowed , please use the correct schema for this #Resolved

Please use valid schema or a valid primitive type for this.

@visingla-ms
This is the field of ARM templates. The schema varies from case to case. We also checked the Template Spec. They shipped the ARM template as well. It is also a free form object. If there is a better presentation of the arm templates. Please let me know and I will follow up.

raosuhas · 2023-03-23T18:15:27Z

...resource-manager/Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentTemplates.json

+            "$ref": "#/parameters/templateIdParameter"
+          },
+          {
+            "$ref": "#/parameters/templateInstallationProperties"


templateInstallationProperties

again the PUT body must be same as the response and must include name\type\id

@raosuhas the same as the packageInstallationProperties. id was removed due to the scanner result

Sorry, didn't this part: "id was removed due to the scanner result", can you please explain?

The same as the packageIdParameter. One of the scanners tells me that the id is already in the URL and I should remove it. Previously, I do include it in the body. If I should ignore that complaint, please let me know and I will reverse it back.

See my other comment on this.

please check my comment

raosuhas · 2023-03-23T18:16:30Z

...resource-manager/Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentTemplates.json

+        },
+        "mainTemplate": {
+          "description": "The JSON string of the template",
+          "type": "object"


again using freeform object like this is not allowed.

Can you please explain your scenario a bit ? How are you using the template here ? Can the user provide any template they want ? #Resolved

Please address this comment.

This is the same as the packagedContent. The mainTemplate would be the ARM templates and it varies from case to case. If there is any alternative or suggestion, please let me know. I can follow up.

openapi-workflow-bot · 2023-03-23T18:17:51Z

Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

raosuhas · 2023-03-23T18:18:35Z

Added a few comments. Please send me an email (Check current on call from the ICM for RP Manifest Approvers) if you want to further discuss the issue about using free form objects

visingla-ms · 2023-03-29T01:44:10Z

.../resource-manager/Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentPackages.json

+            "$ref": "#/parameters/PackageIdParameter"
+          },
+          {
+            "$ref": "#/parameters/PackageInstallationProperties"


PackageInstallationProperties

Since packageId is part of "id" property of packageModel anyway, why is packageId property needed explicitly needed in packageModel? That would eliminate the need of separate model for request and response.

Also, ARM requires RPs to have same model for request and response in PUT APIs.

Please check my previous comment

@visingla-ms
Please check my latest comment. I can follow up with you on Team or via emails if you have time. Thank you!

See my other comment on this.

please check my comment

visingla-ms · 2023-03-30T21:52:22Z

...resource-manager/Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentTemplates.json

+          "description": "the name of the package contains this template"
+        },
+        "mainTemplate": {
+          "description": "The JSON string of the template",


string

not string anymore? #Resolved

description is updated

openapi-pipeline-app · 2023-03-31T01:46:07Z

Swagger Validation Report

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

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️🔄LintDiff inProgress [Detail]

️🔄Avocado inProgress [Detail]

️🔄SwaggerAPIView inProgress [Detail]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️⌛PR Summary pending [Detail]

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

* Adds base for updating Microsoft.SecurityInsights from version preview/2023-03-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Workspace Manager Members (#23134) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Workspace Manager Members * udpate pattern * Workspace manager configurations (#23133) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * adding april configurations swagger * update pattern * prettier update * update readme * Workspace manager assignments (#23130) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Workspace Manager Assignments/Jobs * update readme * updated from comments * update from lint diff errors * updated descriptions * Workspace manager groups (#23135) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * april swagger for groups * update path name & pattern * [Hunts] Add hunts to Sentinel 2023-04-01-preview version (#23139) * Add hunts files * Include update in 200 description and add defaults * Add back 201 * Update relation properties * Update example --------- Co-authored-by: Derrick Lee <derricklee@microsoft.com> * Add readonly flag to providerName property (#23259) * sentinel content hub package and template API (#23151) * commit for content template and content package API * fix issues reported by swagger lint * add 201 for put requests in template service * resolve the comments * resolve comments in packageId * resolve comments * update descriptions due to lint error (#23392) * Fix policheck issue by updating the description. (#23415) * Fix polich issue by updating the description. * update the description to fix a typo. * Release sentinel 2023 04 01 preview (#23420) * Fix polich issue by updating the description. * update the description to fix a typo. * fix policheck by updating description * rename enum name to stable version to fix cross-version breaking change failure. * fix typo (#23463) --------- Co-authored-by: rheabansal <93624991+rheabansal@users.noreply.github.com> Co-authored-by: Derrick Lee <derricklee91@gmail.com> Co-authored-by: Derrick Lee <derricklee@microsoft.com> Co-authored-by: Anat Gilenson <53407600+anat-gilenson@users.noreply.github.com> Co-authored-by: xuhumsft <116764429+xuhumsft@users.noreply.github.com> Co-authored-by: Nan Zang <nazang@microsoft.com>

* Adds base for updating Microsoft.SecurityInsights from version preview/2023-03-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Workspace Manager Members (Azure#23134) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Workspace Manager Members * udpate pattern * Workspace manager configurations (Azure#23133) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * adding april configurations swagger * update pattern * prettier update * update readme * Workspace manager assignments (Azure#23130) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Workspace Manager Assignments/Jobs * update readme * updated from comments * update from lint diff errors * updated descriptions * Workspace manager groups (Azure#23135) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-02-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * april swagger for groups * update path name & pattern * [Hunts] Add hunts to Sentinel 2023-04-01-preview version (Azure#23139) * Add hunts files * Include update in 200 description and add defaults * Add back 201 * Update relation properties * Update example --------- Co-authored-by: Derrick Lee <derricklee@microsoft.com> * Add readonly flag to providerName property (Azure#23259) * sentinel content hub package and template API (Azure#23151) * commit for content template and content package API * fix issues reported by swagger lint * add 201 for put requests in template service * resolve the comments * resolve comments in packageId * resolve comments * update descriptions due to lint error (Azure#23392) * Fix policheck issue by updating the description. (Azure#23415) * Fix polich issue by updating the description. * update the description to fix a typo. * Release sentinel 2023 04 01 preview (Azure#23420) * Fix polich issue by updating the description. * update the description to fix a typo. * fix policheck by updating description * rename enum name to stable version to fix cross-version breaking change failure. * fix typo (Azure#23463) --------- Co-authored-by: rheabansal <93624991+rheabansal@users.noreply.github.com> Co-authored-by: Derrick Lee <derricklee91@gmail.com> Co-authored-by: Derrick Lee <derricklee@microsoft.com> Co-authored-by: Anat Gilenson <53407600+anat-gilenson@users.noreply.github.com> Co-authored-by: xuhumsft <116764429+xuhumsft@users.noreply.github.com> Co-authored-by: Nan Zang <nazang@microsoft.com>

openapi-assignment-bot bot assigned archerzz Mar 17, 2023

AzureRestAPISpecReview added ARMReview CI-FixRequiredOnFailure resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 17, 2023

azure-sdk mentioned this pull request Mar 17, 2023

[AutoPR @azure/arm-securityinsight] sentinel content hub package and template API azure-sdk/azure-sdk-for-js#4397

Closed

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label Mar 17, 2023

azure-sdk mentioned this pull request Mar 17, 2023

[AutoPR track2_azure-mgmt-securityinsight] sentinel content hub package and template API azure-sdk/azure-sdk-for-python#3057

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Mar 17, 2023

xuhumsft added 3 commits March 17, 2023 11:20

commit for content template and content package API

d1a9a33

fix issues reported by swagger lint

5cd1914

add 201 for put requests in template service

660a283

raosuhas reviewed Mar 23, 2023

View reviewed changes

...ce-manager/Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentProductPackages.json Show resolved Hide resolved

raosuhas reviewed Mar 23, 2023

View reviewed changes

raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 23, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 23, 2023

resolve the comments

c5c0387

azure-sdk mentioned this pull request Mar 23, 2023

[AutoPR Az.securityinsights.DefaultTag] sentinel content hub package and template API azure-sdk/azure-powershell#4951

Closed

visingla-ms reviewed Mar 29, 2023

View reviewed changes

visingla-ms added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 29, 2023

openapi-workflow-bot bot removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 29, 2023

visingla-ms reviewed Mar 30, 2023

View reviewed changes

resolve comments in packageId

fd66b6e

resolve comments

6feb597

visingla-ms added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Mar 31, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 31, 2023

raych1 assigned live1206 and unassigned archerzz Apr 3, 2023

live1206 approved these changes Apr 3, 2023

View reviewed changes

live1206 merged commit dff7fe5 into Azure:release-Sentinel-2023-04-01-preview Apr 3, 2023

xuhumsft deleted the release-Sentinel-2023-04-01-preview-contentHub branch April 3, 2023 23:57

xuhumsft mentioned this pull request Dec 13, 2023

Release release sentinel securityinsights microsoft.security insights 2023 11 01 #26873

Merged

6 tasks

sentinel content hub package and template API #23151

sentinel content hub package and template API #23151

Conversation

xuhumsft commented Mar 17, 2023 • edited Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Mar 17, 2023

openapi-pipeline-app bot commented Mar 17, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Mar 17, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Mar 17, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Mar 17, 2023

archerzz commented Mar 21, 2023

azure-pipelines bot commented Mar 21, 2023

raosuhas Mar 23, 2023 • edited by visingla-ms Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raosuhas Mar 23, 2023 • edited by visingla-ms Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xuhumsft Mar 30, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raosuhas Mar 23, 2023 • edited by visingla-ms Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raosuhas Mar 23, 2023 • edited by visingla-ms Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openapi-workflow-bot bot commented Mar 23, 2023

raosuhas commented Mar 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xuhumsft Mar 29, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

visingla-ms Mar 30, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openapi-pipeline-app bot commented Mar 31, 2023 • edited Loading

Swagger Validation Report

xuhumsft commented Mar 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Mar 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Mar 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Mar 17, 2023 •

edited

Loading

raosuhas Mar 23, 2023 •

edited by visingla-ms

Loading

raosuhas Mar 23, 2023 •

edited by visingla-ms

Loading

xuhumsft Mar 30, 2023 •

edited

Loading

raosuhas Mar 23, 2023 •

edited by visingla-ms

Loading

raosuhas Mar 23, 2023 •

edited by visingla-ms

Loading

xuhumsft Mar 29, 2023 •

edited

Loading

visingla-ms Mar 30, 2023 •

edited

Loading

openapi-pipeline-app bot commented Mar 31, 2023 •

edited

Loading