azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Workspace Manager Assignments
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
- [x] 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: :warning:
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:
-
[x] 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.
Hi, @rheabansal Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| types.json | 2.0(a3bab1a) | 2.0(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 1 Warnings warning [Detail]
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: PostOperationIdContainsUrlVerb | OperationId should contain the verb: 'jobs' in:'WorkspaceManagerAssignmentJobs_Create'. Consider updating the operationId Location: Microsoft.SecurityInsights/preview/2023-03-01-preview/WorkspaceManagerAssignments.json#L297 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
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-python-track2 - track2_azure-mgmt-securityinsight - 2.0.0b2+ Removed operation group GetOperations + Removed operation group GetRecommendationsOperations + Removed operation group IncidentTasksOperations + Removed operation group UpdateOperations
️❌ azure-sdk-for-net failed [Detail]
❌Code Generator Failed [Logs] Generate from 699ac3480d9ecf099c88c01f2319a000b8b4c51f. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --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 cmderr [Autorest] No usable version of the libssl was found cmderr [Autorest] FATAL: csharp/simplifier - FAILED cmderr [Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated. cmderr [Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated. error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest warn Skip package processing as generation is failed
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from 699ac3480d9ecf099c88c01f2319a000b8b4c51f. SDK Automation 14.0.0command 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.3.1 -> 9.5.1 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.5.1> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-securityinsight [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation group WorkspaceManagerAssignmentJobsOperations info [Changelog] - Added operation group WorkspaceManagerAssignmentsOperations info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Removed operation group GetOperations info [Changelog] - Removed operation group GetRecommendationsOperations info [Changelog] - Removed operation group IncidentTasksOperations info [Changelog] - Removed operation group UpdateOperations
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 699ac3480d9ecf099c88c01f2319a000b8b4c51f. SDK Automation 14.0.0command 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]info [Changelog] **Features** info [Changelog] info [Changelog] - Added operation group WorkspaceManagerAssignmentJobs info [Changelog] - Added operation group WorkspaceManagerAssignments info [Changelog] - Added Interface AlertPropertyMapping info [Changelog] - Added Interface AssignmentItem info [Changelog] - Added Interface AzureEntityResource info [Changelog] - Added Interface ErrorAdditionalInfo info [Changelog] - Added Interface ErrorDetail info [Changelog] - Added Interface ErrorModel info [Changelog] - Added Interface ErrorResponse info [Changelog] - Added Interface Job info [Changelog] - Added Interface JobItem info [Changelog] - Added Interface JobList info [Changelog] - Added Interface SentinelEntityMapping info [Changelog] - Added Interface WorkspaceManagerAssignment info [Changelog] - Added Interface WorkspaceManagerAssignmentJobsCreateOptionalParams info [Changelog] - Added Interface WorkspaceManagerAssignmentJobsDeleteOptionalParams info [Changelog] - Added Interface WorkspaceManagerAssignmentJobsGetOptionalParams info [Changelog] - Added Interface WorkspaceManagerAssignmentJobsListNextOptionalParams info [Changelog] - Added Interface WorkspaceManagerAssignmentJobsListOptionalParams info [Changelog] - Added Interface WorkspaceManagerAssignmentList info [Changelog] - Added Interface WorkspaceManagerAssignmentsCreateOrUpdateOptionalParams info [Changelog] - Added Interface WorkspaceManagerAssignmentsDeleteOptionalParams info [Changelog] - Added Interface WorkspaceManagerAssignmentsGetOptionalParams info [Changelog] - Added Interface WorkspaceManagerAssignmentsListNextOptionalParams info [Changelog] - Added Interface WorkspaceManagerAssignmentsListOptionalParams info [Changelog] - Added Type Alias AlertProperty info [Changelog] - Added Type Alias ProvisioningState info [Changelog] - Added Type Alias Status info [Changelog] - Added Type Alias WorkspaceManagerAssignmentJobsCreateResponse info [Changelog] - Added Type Alias WorkspaceManagerAssignmentJobsGetResponse info [Changelog] - Added Type Alias WorkspaceManagerAssignmentJobsListNextResponse info [Changelog] - Added Type Alias WorkspaceManagerAssignmentJobsListResponse info [Changelog] - Added Type Alias WorkspaceManagerAssignmentsCreateOrUpdateResponse info [Changelog] - Added Type Alias WorkspaceManagerAssignmentsGetResponse info [Changelog] - Added Type Alias WorkspaceManagerAssignmentsListNextResponse info [Changelog] - Added Type Alias WorkspaceManagerAssignmentsListResponse 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] - Added Enum KnownAlertProperty info [Changelog] - Added Enum KnownProvisioningState info [Changelog] - Added Enum KnownStatus
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 699ac3480d9ecf099c88c01f2319a000b8b4c51f. SDK Automation 14.0.0command ./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 warning [Detail]
⚠️Warning [Logs] Generate from 699ac3480d9ecf099c88c01f2319a000b8b4c51f. Schema Automation 14.0.0command .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 699ac3480d9ecf099c88c01f2319a000b8b4c51f. SDK Automation 14.0.0command 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]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| swagger | Microsoft.SecurityInsights | https://apiview.dev/Assemblies/Review/844a50a0858d427295205beb7c2235e1 |
| Java | azure-resourcemanager-securityinsights | https://apiview.dev/Assemblies/Review/654d754d8b7f49e4b043859cae5aafeb |
| JavaScript | @azure/arm-securityinsight | https://apiview.dev/Assemblies/Review/dbc9856ea2b844a782426fa16e5b6761 |
Hi, @rheabansal your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
Hi! This swagger was already approved in the private repo- https://github.com/Azure/azure-rest-api-specs-pr/pull/9116
Hi! This swagger was already approved in the private repo- Azure/azure-rest-api-specs-pr#9116
Signed off base on this
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.
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.
Hi @rheabansal, 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 |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
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.
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.
Hi! If we could get a review on this PR when you get a chance that would be awesome! We have added 2 new properties & updated the examples accordingly.
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.
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.