azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Azure Automation: 2022-06-30-preview API for Runtime resource
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:
- 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.
- If updating an existing version, please select the specific language 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:
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [x] 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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
-
[x] 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.
Hi, @mahakjain314 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.
️❌Breaking Change(Cross-Version): 5 Errors, 97 Warnings failed [Detail]
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| job.json | 2022-06-30-preview(dae0157) | 2019-06-01(main) |
| job.json | 2022-06-30-preview(dae0157) | 2017-05-15-preview(main) |
| runbook.json | 2022-06-30-preview(dae0157) | 2019-06-01(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 30 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 2 Errors, 1 Warnings failed [Detail]
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
|
"location":"specification/automation/resource-manager/readme.md", "tag":"package-2022-06-30-preview", "details":"swagger-document/compose - FAILED" |
|
"location":"specification/automation/resource-manager/readme.md", "tag":"package-2022-06-30-preview", "details":"Error: '$.definitions.ErrorResponse.description' has incompatible values (---Error response of an operation failure, --->- Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).)." |
| :warning: R2017 - PutRequestResponseScheme | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'RuntimeDependency_CreateOrUpdate' Request Model: 'RuntimeDependencyCreateOrUpdateParameters' Response Model: 'RuntimeDependency' Location: Microsoft.Automation/preview/2022-06-30-preview/runtimeDependency.json#L282 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| :warning: R1006 - PutInOperationName | 'PUT' operation 'RunbookDraft_ReplaceContent' 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.Automation/preview/2022-06-30-preview/runbook.json#L97 |
| :warning: R2004 - NonApplicationJsonType | Only 'application/json' content-type is supported by ARM. Location: Microsoft.Automation/preview/2022-06-30-preview/job.json#L47 |
| :warning: R2004 - NonApplicationJsonType | Only 'application/json' content-type is supported by ARM. Location: Microsoft.Automation/preview/2022-06-30-preview/job.json#L105 |
| :warning: R2004 - NonApplicationJsonType | Only 'application/json' content-type is supported by ARM. Location: Microsoft.Automation/preview/2022-06-30-preview/runbook.json#L55 |
| :warning: R2004 - NonApplicationJsonType | Only 'application/json' content-type is supported by ARM. Location: Microsoft.Automation/preview/2022-06-30-preview/runbook.json#L108 |
| :warning: R2004 - NonApplicationJsonType | Only 'application/json' content-type is supported by ARM. Location: Microsoft.Automation/preview/2022-06-30-preview/runbook.json#L343 |
| :warning: R2017 - PutRequestResponseScheme | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Runbook_CreateOrUpdate' Request Model: 'RunbookCreateOrUpdateParameters' Response Model: 'Runbook' Location: Microsoft.Automation/preview/2022-06-30-preview/runbook.json#L433 |
| :warning: R2064 - LROStatusCodesReturnTypeSchema | 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'RunbookDraft_ReplaceContent', Response code: '200' Location: Microsoft.Automation/preview/2022-06-30-preview/runbook.json#L142 |
| :warning: R4006 - DeprecatedXmsCodeGenerationSetting | The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Automation/preview/2022-06-30-preview/job.json#L6 |
| :warning: R4006 - DeprecatedXmsCodeGenerationSetting | The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Automation/preview/2022-06-30-preview/runbook.json#L6 |
| :warning: R4006 - DeprecatedXmsCodeGenerationSetting | The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Automation/preview/2022-06-30-preview/runtime.json#L6 |
| :warning: R4006 - DeprecatedXmsCodeGenerationSetting | The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Automation/preview/2022-06-30-preview/runtimeDependency.json#L6 |
️❌Avocado: 4 Errors, 1 Warnings failed [Detail]
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌SDK Track2 Validation: 5 Errors, 0 Warnings failed [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/dae0157a203a0f43df9a8ac41d09717464a9553c/specification/automation/resource-manager/readme.md#tag-package-2022-06-30-preview">automation/resource-manager/readme.md#package-2022-06-30-preview
| Rule | Message |
|---|---|
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-06-30-preview", "details":"Duplicate Schema named 'ActivityProperties' (4 differences):\n - properties.parameterSets.x-ms-identifiers.0: "name" => |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-06-30-preview", "details":"Duplicate Schema named 'Activity' (1 differences):\n - properties.properties.$ref: "#/components/schemas/schemas:24" => "#/components/schemas/schemas:1235"; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-06-30-preview", "details":"Duplicate Schema named 'ActivityListResult' (1 differences):\n - properties.value.$ref: "#/components/schemas/schemas:35" => "#/components/schemas/schemas:1246"; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-06-30-preview", "details":"Duplicate Schema named 'ErrorResponse' (4 differences):\n - properties.code: "$ref":"#/components/schemas/schemas:1296", "description":"Error code" => "description":"Error message indicating why the operation failed." => "$ref":"#/components/schemas/schemas:1362"\n - title: |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-06-30-preview", "details":"Error: 4 errors occured -- cannot continue." |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
![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 failed [Detail]
Breaking Changes Tracking
️✔️azure-sdk-for-go - armautomation - 0.7.1❌azure-sdk-for-python-track2 - track2_azure-mgmt-automation - 1.1.0b2+ Model HybridRunbookWorkerGroup no longer has parameter hybrid_runbook_workers + Operation HybridRunbookWorkerGroupOperations.update has a new parameter hybrid_runbook_worker_group_updation_parameters + Operation HybridRunbookWorkerGroupOperations.update no longer has parameter parameters
️❌ azure-sdk-for-net failed [Detail]
❌Failed [Logs] Generate from f64ac2266cc629748cd0d188e7a7a8d7cd91184b. SDK Automation 14.0.0warn 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 [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/automation/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 f64ac2266cc629748cd0d188e7a7a8d7cd91184b. 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] global `--global`, `--local` are deprecated. Use `--location=global` instead.
️✔️track2_azure-mgmt-automation [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added operation group DeletedAutomationAccountsOperations info [Changelog] - Model HybridRunbookWorkerGroupCreateOrUpdateParameters has a new parameter name info [Changelog] info [Changelog] **Breaking changes** info [Changelog] info [Changelog] - Model HybridRunbookWorkerGroup no longer has parameter hybrid_runbook_workers info [Changelog] - Operation HybridRunbookWorkerGroupOperations.update has a new parameter hybrid_runbook_worker_group_updation_parameters info [Changelog] - Operation HybridRunbookWorkerGroupOperations.update no longer has parameter parameters
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from f64ac2266cc629748cd0d188e7a7a8d7cd91184b. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️armautomation [View full logs] [Preview SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️🔄 azure-sdk-for-js inProgress [Detail]
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs] Generate from f64ac2266cc629748cd0d188e7a7a8d7cd91184b. 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
️✔️automation [View full logs] [Preview Schema Changes]
️❌ azure-powershell failed [Detail]
❌Failed [Logs] Generate from f64ac2266cc629748cd0d188e7a7a8d7cd91184b. 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.automation [View full logs] [Preview SDK Changes]
Hi @mahakjain314, 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 |
Hi, @mahakjain314 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
Hi @mahakjain314, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. 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. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Python | track2_azure-mgmt-automation | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help |
Hi, @mahakjain314. 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, @mahakjain314. 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.