ARM (Control Plane) API Specification Update Pull Request

Tip: overwhelmed by all this guidance? See the Getting help section 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.

diagram

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)

If this PR is in purview of ARM review then automation will add the ARMReview label.
If you want to force ARM review, add the label yourself.
Proceed according to the diagram at the top of this comment.

Click here to see the diagram footnotes

Diagram footnotes

[1] ARM review queue (for merge queues, see [2])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page. If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested is removed from your PR. This should cause the label WaitForARMFeedback to be added. [2] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

[x] New API version. (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 swagger 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 Swagger-Suppression-Process to get approval.

Getting help

First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. 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.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run. This should result in a new comment denoting a PR validation pipeline has 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.

Jan 18 '24 20:01 naveedaz

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ Your PR is in purview of ARM review (label: ARMReview). Please ensure your PR is on the ARM PR review queue - see instructions in steps 1 and 2 in the PR description diagram.
❌ The required check named Swagger PrettierCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

Jan 18 '24 20:01 openapi-pipeline-app[bot]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
CommonDefinitions.json	2023-12-01(f7de33f)	2023-01-01(main)

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.6)	new version	base version
package-2023-12	package-2023-12(f7de33f)	package-2023-12(release-web-2023-12-01)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
`❌` GetCollectionResponseSchema	The response in the GET collection operation 'Recommendations_ListRecommendedRulesForHostingEnvironment' does not match the response definition in the individual GET operation 'Recommendations_GetRuleDetailsByHostingEnvironment' . Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	The response in the GET collection operation 'Recommendations_ListRecommendedRulesForWebApp' does not match the response definition in the individual GET operation 'Recommendations_GetRuleDetailsByWebApp' . Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	The response in the GET collection operation 'WebApps_ListRelayServiceConnections' does not match the response definition in the individual GET operation 'WebApps_GetRelayServiceConnection' . Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	The response in the GET collection operation 'WebApps_ListRelayServiceConnectionsSlot' does not match the response definition in the individual GET operation 'WebApps_GetRelayServiceConnectionSlot' . Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	The response in the GET collection operation 'WebApps_ListPremierAddOns' does not match the response definition in the individual GET operation 'WebApps_GetPremierAddOn' . Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	The response in the GET collection operation 'WebApps_ListPremierAddOnsSlot' does not match the response definition in the individual GET operation 'WebApps_GetPremierAddOnSlot' . Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L17
`❌` GuidUsage	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.Web/stable/2023-12-01/CommonDefinitions.json#L671
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L700
`❌` ProvisioningStateValidation	ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L969
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L1012
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L1788
`❌` NestedResourcesMustHaveListOperation	The nested resource 'HybridConnection' does not have list operation, please add it. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L1807
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L1966
`❌` GuidUsage	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.Web/stable/2023-12-01/CommonDefinitions.json#L2240
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2721
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2721
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2742
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2746
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2923
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2923
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2923
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3030
`❌` GuidUsage	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.Web/stable/2023-12-01/CommonDefinitions.json#L3077
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3426
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3448
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3580
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3935
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3979
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3979
`❌` NestedResourcesMustHaveListOperation	The nested resource 'VnetGateway' does not have list operation, please add it. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L4102

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]

️️✔️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]

_{Posted by Swagger Pipeline | How to fix these errors?}

Jan 18 '24 20:01 openapi-pipeline-app[bot]