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!

[ ] 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:

[ ] 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 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 15 '24 07:01 tbhartia

PR validation pipeline restarted successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

Jan 15 '24 07:01 openapi-pipeline-app[bot]

Swagger Validation Report

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

There are no breaking changes.

️❌Breaking Change(Cross-Version): 17 Errors, 12 Warnings failed [Detail]

compared swaggers (via Oad v0.10.5)]	new version	base version
CommonDefinitions.json	2023-12-01(0ff7eed)	2023-01-01(main)
WebApps.json	2023-12-01(0ff7eed)	2023-01-01(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule	Message
`❌` 1011 - AddingResponseCode	The new version adds a response code '202'. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L271:11
`❌` 1011 - AddingResponseCode	The new version adds a response code '202'. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L1148:11
`❌` 1011 - AddingResponseCode	The new version adds a response code '202'. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L1937:11
`❌` 1011 - AddingResponseCode	The new version adds a response code '202'. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L2496:11
`❌` 1011 - AddingResponseCode	The new version adds a response code '202'. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L2560:11
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L973:9 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L29134:13
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'properties' renamed or removed? New: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L972:7 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L29129:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'id' renamed or removed? New: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L972:7 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L29129:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'name' renamed or removed? New: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L972:7 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L29129:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'kind' renamed or removed? New: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L972:7 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L29129:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'type' renamed or removed? New: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L972:7 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L29129:7
`❌` 1044 - XmsLongRunningOperationChanged	The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L227:7 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L221:7
`❌` 1044 - XmsLongRunningOperationChanged	The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L298:7 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L282:7
`❌` 1044 - XmsLongRunningOperationChanged	The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L1107:7 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L1090:7
`❌` 1044 - XmsLongRunningOperationChanged	The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L1896:7 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L1869:7
`❌` 1044 - XmsLongRunningOperationChanged	The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L2455:7 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L2418:7
`❌` 1044 - XmsLongRunningOperationChanged	The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L2519:7 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L2472:7
:warning: 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L6390:13 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L6333:13
:warning: 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L964:9 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L29130:9
:warning: 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L6425:13 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L6368:13
:warning: 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L6439:13 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L6382:13
:warning: 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L6515:13 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L6458:13
:warning: 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L6529:13 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L6472:13
:warning: 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L15713:13 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L15454:13
:warning: 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L15748:13 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L15489:13
:warning: 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L15769:13 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L15510:13
:warning: 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L15852:13 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L15593:13
:warning: 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.Web/stable/2023-12-01/WebApps.json#L15873:13 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L15614:13
:warning: 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L969:5 Old: Microsoft.Web/stable/2023-01-01/WebApps.json#L29121:5

️🔄LintDiff inProgress [Detail]

️️✔️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 15 '24 07:01 openapi-pipeline-app[bot]