Adding Workspace Manager Members by rheabansal · Pull Request #21276 · Azure/azure-rest-api-specs

rheabansal · 2022-10-25T20:35:33Z

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 · 2022-10-25T20:35:35Z

Hi, @rheabansal 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 · 2022-10-25T20:35:36Z

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: 3 Errors, 0 Warnings failed [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-preview-2023-03	package-preview-2023-03(4e8c22f)	package-preview-2023-03(release-securityinsights-Microsoft.SecurityInsights-2023-03-01-preview)

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

Rule	Message	Related RPC [For API reviewers]
`❌` ResourceNameRestriction	The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/WorkspaceManagerMembers.json#L37	RPC-V2-URI-5
`❌` ResourceNameRestriction	The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/WorkspaceManagerMembers.json#L91	RPC-V2-URI-5
`❌` ResourceNameRestriction	The resource name parameter 'workspaceManagerMemberName' should be defined with a 'pattern' restriction. Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/WorkspaceManagerMembers.json#L91	RPC-V2-URI-5

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

Validation passes for Avocado.

️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️❌PrettierCheck: 3 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` HowToFix	Code style issues found path: 2023-03-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json
`❌` HowToFix	Code style issues found path: 2023-03-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json
`❌` HowToFix	Code style issues found path: 2023-03-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json

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

Validation passes for SpellCheck.

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

Validation passes for CadlValidation.

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

Validation passes for Summary.

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

openapi-pipeline-app · 2022-10-25T20:35:37Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

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

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

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.0
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_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] [Preview SDK Changes]
- Microsoft.Azure.Management.SecurityInsights.2.0.0.nupkg
- Microsoft.Azure.Management.SecurityInsights.2.0.0.symbols.nupkg

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

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

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

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation group WorkspaceManagerMembersOperations
info	[Changelog]   - Model AlertDetailsOverride has a new parameter alert_dynamic_properties
info	[Changelog]   - Model NrtAlertRule has a new parameter sentinel_entities_mappings
info	[Changelog]   - Model NrtAlertRuleTemplate has a new parameter sentinel_entities_mappings
info	[Changelog]   - Model NrtAlertRuleTemplateProperties has a new parameter sentinel_entities_mappings
info	[Changelog]   - Model QueryBasedAlertRuleTemplateProperties has a new parameter sentinel_entities_mappings
info	[Changelog]   - Model ScheduledAlertRule has a new parameter sentinel_entities_mappings
info	[Changelog]   - Model ScheduledAlertRuleCommonProperties has a new parameter sentinel_entities_mappings
info	[Changelog]   - Model ScheduledAlertRuleProperties has a new parameter sentinel_entities_mappings
info	[Changelog]   - Model ScheduledAlertRuleTemplate has a new parameter sentinel_entities_mappings
info	[Changelog]   - Model SecurityAlertTimelineItem has a new parameter intent
info	[Changelog]   - Model SecurityAlertTimelineItem has a new parameter techniques

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

️✔️Succeeded [Logs] Generate from cbcf9f2128c858143cef20ce20e89949899c6689. 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]

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

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group WorkspaceManagerMembers
info	[Changelog]   - Added Interface AlertPropertyMapping
info	[Changelog]   - Added Interface AzureEntityResource
info	[Changelog]   - Added Interface ErrorAdditionalInfo
info	[Changelog]   - Added Interface ErrorDetail
info	[Changelog]   - Added Interface ErrorResponse
info	[Changelog]   - Added Interface SentinelEntityMapping
info	[Changelog]   - Added Interface WorkspaceManagerMember
info	[Changelog]   - Added Interface WorkspaceManagerMembersCreateOrUpdateOptionalParams
info	[Changelog]   - Added Interface WorkspaceManagerMembersDeleteOptionalParams
info	[Changelog]   - Added Interface WorkspaceManagerMembersGetOptionalParams
info	[Changelog]   - Added Interface WorkspaceManagerMembersList
info	[Changelog]   - Added Interface WorkspaceManagerMembersListNextOptionalParams
info	[Changelog]   - Added Interface WorkspaceManagerMembersListOptionalParams
info	[Changelog]   - Added Type Alias AlertProperty
info	[Changelog]   - Added Type Alias WorkspaceManagerMembersCreateOrUpdateResponse
info	[Changelog]   - Added Type Alias WorkspaceManagerMembersGetResponse
info	[Changelog]   - Added Type Alias WorkspaceManagerMembersListNextResponse
info	[Changelog]   - Added Type Alias WorkspaceManagerMembersListResponse
info	[Changelog]   - Interface AlertDetailsOverride has a new optional parameter alertDynamicProperties
info	[Changelog]   - Interface NrtAlertRule has a new optional parameter sentinelEntitiesMappings
info	[Changelog]   - Interface NrtAlertRuleTemplate has a new optional parameter sentinelEntitiesMappings
info	[Changelog]   - Interface QueryBasedAlertRuleTemplateProperties has a new optional parameter sentinelEntitiesMappings
info	[Changelog]   - Interface ScheduledAlertRule has a new optional parameter sentinelEntitiesMappings
info	[Changelog]   - Interface ScheduledAlertRuleCommonProperties has a new optional parameter sentinelEntitiesMappings
info	[Changelog]   - Interface ScheduledAlertRuleTemplate has a new optional parameter sentinelEntitiesMappings
info	[Changelog]   - Interface SecurityAlertTimelineItem has a new optional parameter intent
info	[Changelog]   - Interface SecurityAlertTimelineItem has a new optional parameter techniques
info	[Changelog]   - Class SecurityInsights has a new parameter workspaceManagerMembers
info	[Changelog]   - Added Enum KnownAlertProperty

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs] Generate from cbcf9f2128c858143cef20ce20e89949899c6689. 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
cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
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 warning [Detail]

⚠️Warning [Logs] Generate from cbcf9f2128c858143cef20ce20e89949899c6689. 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

️✔️securityinsights [View full logs] [Preview Schema Changes]

️❌ azure-powershell failed [Detail]

❌Failed [Logs] Generate from cbcf9f2128c858143cef20ce20e89949899c6689. 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 [View full logs] [Preview SDK Changes]

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

openapi-pipeline-app · 2022-10-25T20:35:38Z

Generated ApiView

Language	Package Name	ApiView Link
Python	track2_azure-mgmt-securityinsight	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Java	azure-resourcemanager-securityinsights	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
JavaScript	@azure/arm-securityinsight	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

openapi-workflow-bot · 2022-10-25T20:42:51Z

Hi, @rheabansal your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

rheabansal · 2022-10-25T20:44:04Z

Hi! We initially had these reviewed in the private repo for a different date. Please see the already approved swagger from the PR in the private repo for the Workspace Manager Members here: https://github.com/Azure/azure-rest-api-specs-pr/pull/9049

zizw123 · 2022-10-25T22:17:47Z

Hi! We initially had these reviewed in the private repo for a different date. Please see the already approved swagger from the PR in the private repo for the Workspace Manager Members here: Azure/azure-rest-api-specs-pr#9049

Signed off based on this

ghost · 2022-11-13T16:02:57Z

Hi, @rheabansal. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

rheabansal · 2022-11-17T19:48:10Z

This PR was signed off by ARM previously (see history above). We had to add one more property and are reopening for review. Nothing else in the swagger has changed.

TimLovellSmith · 2022-11-18T21:12:53Z

+      "description": "The workspace manager member properties",
+      "properties": {
+        "targetWorkspaceId": {
+          "description": "Fully qualified resource ID of the target Sentinel workspace joining the given Sentinel workspace manager",


description

I've seen something about an arm-id format you can use not sure if it is working right now though.

https://azure.github.io/autorest/extensions/#x-ms-arm-id-details

TimLovellSmith · 2022-11-18T21:14:13Z

+      "properties": {
+        "nextLink": {
+          "description": "URL to fetch the next set of workspace manager members",
+          "readOnly": true,


readOnly

Q for SDK folks. Are we supposed to use format uri on these? Not sure if it matters.

TimLovellSmith

ghost · 2022-12-04T16:03:08Z

Hi, @rheabansal. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

ghost · 2022-12-19T05:02:44Z

Hi, @rheabansal. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

adding

ce261d4

openapi-assignment-bot Bot assigned dw511214992 Oct 25, 2022

rheabansal added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Oct 25, 2022

AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 25, 2022

zizw123 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 25, 2022

openapi-workflow-bot Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 25, 2022

ghost added the no-recent-activity label Nov 13, 2022

Update Member Schema

8a461a5

ghost removed the no-recent-activity label Nov 17, 2022

openapi-pipeline-app Bot added the no-recent-activity label Nov 17, 2022

ghost removed the no-recent-activity label Nov 17, 2022

openapi-pipeline-app Bot added the no-recent-activity label Nov 17, 2022

ghost removed the no-recent-activity label Nov 17, 2022

openapi-pipeline-app Bot added the no-recent-activity label Nov 17, 2022

ghost removed the no-recent-activity label Nov 17, 2022

openapi-pipeline-app Bot added the no-recent-activity label Nov 17, 2022

ghost removed the no-recent-activity label Nov 17, 2022

rheabansal added 2 commits November 17, 2022 16:34

updated naming to targetWorkspaceTenantId

f6eccdc

added new requried field

4e8c22f