Azure
Add ControlPlaneOnly enum to ManagedClusterUpgradeSpec
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).
- [x] 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:
- [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. - 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.
PR validation pipeline restarted successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi @frantran, this service has enabled Service API Toolset. All spec updates MUST be initiated from service ADO project repo, so that to guarantee it to be the source of truth., please review this pull request if it's intentional or reject it if it's not expected. Normally, all the specification or example changes should start with PR created in ADO.
![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: 28 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| fleets.json | 2023-03-15-preview(9c0c32b) | 2023-03-15-preview(main) |
| fleets.json | 2023-06-15-preview(9c0c32b) | 2023-06-15-preview(main) |
| fleets.json | 2023-08-15-preview(9c0c32b) | 2023-08-15-preview(main) |
| fleets.json | 2023-10-15(9c0c32b) | 2023-10-15(main) |
️❌Breaking Change(Cross-Version): 8 Errors, 8 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| fleets.json | 2024-02-02-preview(9c0c32b) | 2023-10-15(main) |
| fleets.json | 2024-02-02-preview(9c0c32b) | 2023-08-15-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-preview-2024-02 | package-preview-2024-02(9c0c32b) | package-preview-2024-02(dev-aks-fleet-2024-02-02-preview) |
| package-2023-10 | package-2023-10(9c0c32b) | package-2023-10(dev-aks-fleet-2024-02-02-preview) |
| package-2023-08-preview | package-2023-08-preview(9c0c32b) | package-2023-08-preview(dev-aks-fleet-2024-02-02-preview) |
| package-2023-06-preview | package-2023-06-preview(9c0c32b) | package-2023-06-preview(dev-aks-fleet-2024-02-02-preview) |
| package-2023-03-preview | package-2023-03-preview(9c0c32b) | package-2023-03-preview(dev-aks-fleet-2024-02-02-preview) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2023-03-15-preview/fleets.json#L374 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2023-03-15-preview/fleets.json#L780 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2023-03-15-preview/fleets.json#L1073 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2023-06-15-preview/fleets.json#L392 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2023-06-15-preview/fleets.json#L816 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2023-06-15-preview/fleets.json#L1109 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2023-08-15-preview/fleets.json#L395 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2023-08-15-preview/fleets.json#L819 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2023-08-15-preview/fleets.json#L1112 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2023-08-15-preview/fleets.json#L1575 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2024-02-02-preview/fleets.json#L395 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2024-02-02-preview/fleets.json#L819 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2024-02-02-preview/fleets.json#L1112 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/preview/2024-02-02-preview/fleets.json#L1651 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/stable/2023-10-15/fleets.json#L395 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/stable/2023-10-15/fleets.json#L819 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/stable/2023-10-15/fleets.json#L1112 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: fleet/stable/2023-10-15/fleets.json#L1575 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: fleet/preview/2023-03-15-preview/fleets.json#L65 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: fleet/preview/2023-03-15-preview/fleets.json#L72 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: fleet/preview/2023-03-15-preview/fleets.json#L78 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: fleet/preview/2023-03-15-preview/fleets.json#L101 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: fleet/preview/2023-03-15-preview/fleets.json#L104 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: fleet/preview/2023-03-15-preview/fleets.json#L117 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: fleet/preview/2023-03-15-preview/fleets.json#L140 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: fleet/preview/2023-03-15-preview/fleets.json#L143 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: fleet/preview/2023-03-15-preview/fleets.json#L146 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: fleet/preview/2023-03-15-preview/fleets.json#L159 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: fleet/preview/2023-03-15-preview/fleets.json#L182 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: fleet/preview/2023-03-15-preview/fleets.json#L185 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-sdk-for-python-track2 warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-sdk-for-java warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️❌ azure-sdk-for-net-track2 failed [Detail]
Only 0 items are rendered, please refer to log for more details.
️❌ azure-resource-manager-schemas failed [Detail]
Only 0 items are rendered, please refer to log for more details.
️️✔️ azure-powershell succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/containerservicefleet/armcontainerservicefleet | https://apiview.dev/Assemblies/Review/725977798127472fa8def873f4c6c9aa?revisionId=1fd1f98ed8df4844b34eea18651e0362 |
| JavaScript | @azure/arm-containerservicefleet | https://apiview.dev/Assemblies/Review/65c668ceaa2346708bf1e479b7f6b79b?revisionId=7b72f3eda5fc479d92c9f911c8970d8b |
| Java | azure-resourcemanager-containerservicefleet | https://apiview.dev/Assemblies/Review/8422e73bfd5d45efb77d0cf066bec1a0?revisionId=6dffa7be494340e6b664c1d8448ba716 |
| Swagger | Microsoft.ContainerService | https://apiview.dev/Assemblies/Review/71d5cd3d2d1c46b59eabc692899ea0b4?revisionId=a1b17c0438a847ecb642971594aabcd6 |
| TypeSpec | Fleet.Management | https://apiview.dev/Assemblies/Review/07108f7e68af4cd597d04c921b7282b8?revisionId=da447139df304797aa8a7b8aa43cf499 |
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}