Azure
Move Computeschedule from private to public preview
ARM (Control Plane) API Specification Update Pull Request
[!TIP] Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
- [ ] New resource provider.
- [ ] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
- [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
- [ ] Update existing version to fix OpenAPI spec quality issues in S360.
- [x] Other, please clarify:
- Move private preview API to public preview
- Other PR reviews of this RP in the private repo Initial commit merged, new version merged, struct fix merged
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
- [x] I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the suppressions guide to get approval.
Getting help
- First, please carefully read through this PR description, from top to bottom. Please fill out the
Purpose of this PRandDue diligence checklist. - If you don't have permissions to remove or add labels to the PR, request
write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories - To understand what you must do next to merge this PR, see the
Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
- If the PR CI checks appear to be stuck in
queuedstate, please add a comment with contents/azp run. This should result in a new comment denoting aPR validation pipelinehas started and the checks should be updated after few minutes. - If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
Next Steps to Merge
✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?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) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-06-01-preview | package-2024-06-01-preview(13d705d) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ComputeSchedule/preview/2024-06-01-preview/computeschedule.json#L490 |
️❌Avocado: 46 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 36 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
- For more instructions, please refer to the FAQ .
️✔️Succeeded in generating from 1c74765055a13c97795433e0fdefcc5985705612. SDK Automation 14.0.0command ./eng/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json warn Warning: cannot find emitter config for azure-sdk-for-java in tspconfig.yaml for typespec project specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml. This SDK will be skipped from the generation for this project. Please add the right emitter config in the 'tspconfig.yaml' file. The example project can be found at https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml.
️✔️azure-resourcemanager-computeschedule [Preview SDK Changes]info [Changelog]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
- For more instructions, please refer to the FAQ .
️✔️Succeeded in generating from 1c74765055a13c97795433e0fdefcc5985705612. 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 warn Warning: cannot find emitter config for azure-sdk-for-go in tspconfig.yaml for typespec project specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml. This SDK will be skipped from the generation for this project. Please add the right emitter config in the 'tspconfig.yaml' file. The example project can be found at https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml. command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/computeschedule/armcomputeschedule [Preview SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
- For more instructions, please refer to the FAQ .
️✔️Succeeded in generating from 1c74765055a13c97795433e0fdefcc5985705612. 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 Warning: File azure-sdk-for-js_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel. command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json warn Warning: cannot find emitter config for azure-sdk-for-js in tspconfig.yaml for typespec project specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml. This SDK will be skipped from the generation for this project. Please add the right emitter config in the 'tspconfig.yaml' file. The example project can be found at https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml.
️✔️@azure/arm-computeschedule [Preview SDK Changes]
️❌ azure-resource-manager-schemas failed [Detail]
- For more instructions, please refer to the FAQ .
❌Code Generator Failed in generating from 1c74765055a13c97795433e0fdefcc5985705612. 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] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az' cmderr [initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'... cmderr [initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types' cmderr [initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'... cmderr [initScript.sh] npm notice cmderr [initScript.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.2 cmderr [initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.2 cmderr [initScript.sh] npm notice To update run: npm install -g [email protected] cmderr [initScript.sh] npm notice error Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh warn Warning: File azure-resource-manager-schemas_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel. command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json cmderr [generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500 cmderr [generateScript.sh] return new TSError(diagnosticText, diagnosticCodes) cmderr [generateScript.sh] ^ cmderr [generateScript.sh] TSError: ⨯ Unable to compile TypeScript: cmderr [generateScript.sh] cmd/generateall.ts(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(42,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type. cmderr [generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type. cmderr [generateScript.sh] cmd/generateall.ts(94,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(105,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig. cmderr [generateScript.sh] at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500:12) cmderr [generateScript.sh] at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:504:19) cmderr [generateScript.sh] at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:739:36) cmderr [generateScript.sh] at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:955:32) cmderr [generateScript.sh] at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1043:43) cmderr [generateScript.sh] at Module._extensions..js (node:internal/modules/cjs/loader:1422:10) cmderr [generateScript.sh] at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1046:12) cmderr [generateScript.sh] at Module.load (node:internal/modules/cjs/loader:1203:32) cmderr [generateScript.sh] at Function.Module._load (node:internal/modules/cjs/loader:1019:12) cmderr [generateScript.sh] at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12) error Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh warn Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel. warn Warning: cannot find emitter config for azure-resource-manager-schemas in tspconfig.yaml for typespec project specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml. This SDK will be skipped from the generation for this project. Please add the right emitter config in the 'tspconfig.yaml' file. The example project can be found at https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml. warn Warning: cannot find emitter config for azure-resource-manager-schemas in tspconfig.yaml for typespec project specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml. This SDK will be skipped from the generation for this project. Please add the right emitter config in the 'tspconfig.yaml' file. The example project can be found at https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml.
️⚠️ azure-powershell warning [Detail]
- For more instructions, please refer to the FAQ .
⚠️Warning in generating from 1c74765055a13c97795433e0fdefcc5985705612. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json warn Warning: cannot find emitter config for azure-powershell in tspconfig.yaml for typespec project specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml. This SDK will be skipped from the generation for this project. Please add the right emitter config in the 'tspconfig.yaml' file. The example project can be found at https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml. command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
⚠️Az.computeschedule.DefaultTag [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/computeschedule/armcomputeschedule | https://apiview.dev/Assemblies/Review/aabd514dc61f4726b1adcafa35b4c0e7?revisionId=767a75c9df2c4d3da842a2deb28105b5 |
| Java | azure-resourcemanager-computeschedule | https://apiview.dev/Assemblies/Review/5097351b92ac4aa796623f11befc0711?revisionId=c1ceb66f695a48e887f63ce51cf2e95c |
| JavaScript | @azure/arm-computeschedule | https://apiview.dev/Assemblies/Review/4c90a15f611446ecb8a2654f22852f38?revisionId=14723bedba754d6fbcdd578d9849520d |
| TypeSpec | ComputeSchedule.Management | https://apiview.dev/Assemblies/Review/93c109ec11084e879cfb876223974e73?revisionId=c14ec7d9e09c49308ce18fab41afd2fa |
| Swagger | Microsoft.ComputeSchedule | https://apiview.dev/Assemblies/Review/3f2821b4180241b39bb23443a9a67701?revisionId=37360a3569584a838942cf7366311fa3 |
Please fix the spellCheck failures by using the appropriate camelCase or PascalCase naming styles in each context, and/or using the common-types LocationParameter definition.
Please fix avocado warnings about unreferenced examples: https://github.com/Azure/azure-rest-api-specs/pull/29660/checks?check_run_id=26913650209
Please fix avocado warnings about readme file not including all APIs/jsons in the default tag, or reply with justifications for e.g. deprecated APIs
Per above comments, please look into the tool validation errors and then remove ARMChangesRequested tag, to unblock the actual manual ARM review.
Please fix avocado warnings about readme file not including all APIs/jsons in the default tag, or reply with justifications for e.g. deprecated APIs
Hello, the files in question are from a deprecated API version.
Can you please explain a bit more about this PR ? Are you adding the 3 different api versions ? Are these aapi versions already reviewed and signed off in the private repo ?
Can you please explain a bit more about this PR ? Are you adding the 3 different api versions ? Are these aapi versions already reviewed and signed off in the private repo ?
I am adding one api version to the public repo, the 2024-06-01-preview version, this is the merged version in the private repo, it has gone through review and sign-off in the private repo.
Would it make it easier if I remove the other versions from this particular PR?
Can you please explain a bit more about this PR ? Are you adding the 3 different api versions ? Are these aapi versions already reviewed and signed off in the private repo ?
I am adding one api version to the public repo, the
2024-06-01-previewversion, this is the merged version in the private repo, it has gone through review and sign-off in the private repo.Would it make it easier if I remove the other versions from this particular PR?
Yeah it would be easier if we just have one PR per version. And If the changes are no different from the private repo then we can sign off on them much easier
Can you please explain a bit more about this PR ? Are you adding the 3 different api versions ? Are these aapi versions already reviewed and signed off in the private repo ?
I am adding one api version to the public repo, the
2024-06-01-previewversion, this is the merged version in the private repo, it has gone through review and sign-off in the private repo. Would it make it easier if I remove the other versions from this particular PR?Yeah it would be easier if we just have one PR per version. And If the changes are no different from the private repo then we can sign off on them much easier
I've updated this PR to reflect only the version we want to release.
Can you please explain a bit more about this PR ? Are you adding the 3 different api versions ? Are these aapi versions already reviewed and signed off in the private repo ?
I am adding one api version to the public repo, the
2024-06-01-previewversion, this is the merged version in the private repo, it has gone through review and sign-off in the private repo. Would it make it easier if I remove the other versions from this particular PR?Yeah it would be easier if we just have one PR per version. And If the changes are no different from the private repo then we can sign off on them much easier
I've updated this PR to reflect only the version we want to release.
Thanks ..
The 2024-06-01-preview is this any different from the one in the private repo ? What are the changes that need to be reviewed that are different from the private repo ?
Can you please explain a bit more about this PR ? Are you adding the 3 different api versions ? Are these aapi versions already reviewed and signed off in the private repo ?
I am adding one api version to the public repo, the
2024-06-01-previewversion, this is the merged version in the private repo, it has gone through review and sign-off in the private repo. Would it make it easier if I remove the other versions from this particular PR?Yeah it would be easier if we just have one PR per version. And If the changes are no different from the private repo then we can sign off on them much easier
I've updated this PR to reflect only the version we want to release.
Thanks ..
The 2024-06-01-preview is this any different from the one in the private repo ? What are the changes that need to be reviewed that are different from the private repo ?
This 2024-06-01-preview version isn't different from what is in the private repo, they're the same spec files. This PR is to move the private specs to the public repo for public preview release.
Comparing this version with the one from the private repo, you are missing some examples files (10 vs 18)
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}