azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Compute GalleryRP release 2023-07-03
This release is for 1 feature from the GalleryRP team. Please treat this PR with priority.
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.
[!NOTE] As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
- The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
- You believe there is no need for you to request breaking change approval, for any reason. Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
- For help with Step 2 / "ARM review", see https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
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 generated using OpenAPI Hub).
- [ ] 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.
- [ ] Other, please clarify:
- edit this with your clarification
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:
- [ ] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
- [ ] 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. - 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 PR workflow diagram Step 2 (ARM review), 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! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).![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): 19 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| communityGallery.json | 2023-07-03(39c1eb0) | 2022-08-03(main) |
| gallery.json | 2023-07-03(39c1eb0) | 2022-08-03(main) |
| gallery.json | 2023-07-03(39c1eb0) | 2020-09-30(main) |
| galleryRPCommon.json | 2023-07-03(39c1eb0) | 2022-08-03(main) |
| sharedGallery.json | 2023-07-03(39c1eb0) | 2022-08-03(main) |
| sharedGallery.json | 2023-07-03(39c1eb0) | 2020-09-30(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.7) | new version | base version |
|---|---|---|
| package-2023-07-03 | package-2023-07-03(39c1eb0) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The path must be under a subscription and resource group for tracked resource types. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L37 |
|
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L37 |
|
The path must be under a subscription and resource group for tracked resource types. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L79 |
|
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L79 |
|
The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L79 |
|
The path must be under a subscription and resource group for tracked resource types. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L124 |
|
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L124 |
|
The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L124 |
|
The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L124 |
|
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L172 |
|
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L217 |
|
The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L217 |
|
The schema 'PirCommunityGalleryResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L267 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L291 |
|
The schema 'CommunityGalleryIdentifier' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L309 |
|
The schema 'CommunityGallery' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L353 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L355 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L373 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L388 |
|
The schema 'CommunityGalleryImage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L403 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L405 |
|
The schema 'CommunityGalleryImageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L417 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L496 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L513 |
|
The schema 'CommunityGalleryImageVersion' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L528 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L530 |
|
The schema 'CommunityGalleryImageVersionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L542 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L565 |
|
The schema 'CommunityGalleryImageIdentifier' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2023-07-03/communityGallery.json#L571 |
|
The resource name parameter 'galleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2023-07-03/gallery.json#L37 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| :warning: MULTIPLE_API_VERSION | The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2023-07-03 |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️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-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 03bd1e12bba133b171cb8085d4b8dd26670ebb23. 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 pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️Azure.ResourceManager.Compute [View full logs] [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from 03bd1e12bba133b171cb8085d4b8dd26670ebb23. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools' cmderr [automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools' 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] New minor version of npm available! 10.2.3 -> 10.4.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice warn No file changes detected after generation warn No package detected after generation
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from 03bd1e12bba133b171cb8085d4b8dd26670ebb23. SDK Automation 14.0.0command ./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 is available: 23.0.1 -> 23.3.2 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.2 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] Time Time Current cmderr [init.sh] Dload Upload Total Spent Left Speed cmderr [init.sh] 0 0 0 0 0 0 0 0 1110k 0 --:--:-- --:--:-- --:--:-- 1110k cmderr [init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz... cmderr [init.sh] Computing checksum with sha256sum cmderr [init.sh] Checksums matched! command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-compute-generated [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 03bd1e12bba133b171cb8085d4b8dd26670ebb23. 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-compute [View full logs] [Preview SDK Changes]info [Changelog] **Features** info [Changelog] info [Changelog] - Interface GalleryArtifactVersionFullSource has a new optional parameter virtualMachineId
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 03bd1e12bba133b171cb8085d4b8dd26670ebb23. 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
️✔️sdk/resourcemanager/compute/armcompute [View full logs] [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - New field `VirtualMachineID` in struct `GalleryArtifactVersionFullSource` info [Changelog] info [Changelog] Total 0 breaking change(s), 1 additive change(s).
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs] Generate from 03bd1e12bba133b171cb8085d4b8dd26670ebb23. 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] npm notice cmderr [initScript.sh] npm notice New minor version of npm available! 10.2.3 -> 10.4.0 cmderr [initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.0> cmderr [initScript.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [initScript.sh] npm notice 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
️✔️compute [View full logs] [Preview Schema Changes]
️⚠️ azure-powershell warning [Detail]
⚠️Warning [Logs] Generate from 03bd1e12bba133b171cb8085d4b8dd26670ebb23. 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.compute.DefaultTag [View full logs] [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/compute/armcompute | https://apiview.dev/Assemblies/Review/08ab188fdab64564bc46944e13addcf9?revisionId=6b373d7470f544c180d58aa35088c131 |
| Java | azure-resourcemanager-compute-generated | https://apiview.dev/Assemblies/Review/eb099b2efb0f4373a854e09003a6b31d?revisionId=2af9115493bb4be89de034b46dea0f23 |
| .Net | Azure.ResourceManager.Compute | https://apiview.dev/Assemblies/Review/7fec998c6beb4201bb99c335d06c70fa?revisionId=15239401c78040a988850d39df0ad921 |
| JavaScript | @azure/arm-compute | https://apiview.dev/Assemblies/Review/a802869b6345406cbb6d1e487132d7dd?revisionId=bc6f6f61a0f441e28647c86a6199ffa2 |
| Swagger | Microsoft.Compute | https://apiview.dev/Assemblies/Review/b32a43d6ad48477b9343d7a921e72411?revisionId=06be960c40274dea919372ec086f802d |
Hi @Sandido! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}