Skip to content

Conversation

@naveedaz
Copy link
Contributor

@naveedaz naveedaz commented May 2, 2024

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.

spec_pr_review_workflow_diagram

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.
  • 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

Details Setting up new API version '2024-04-01' using guidance at: https://eng.ms/docs/products/azure-developer-experience/design/api-specs/api-specs?tabs=openapi

specification/web/resource-manager has 3 different RPs. This PR adds the new API version to all 3.

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 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.
  • 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 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.

naveedaz added 9 commits May 2, 2024 11:23
Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from stable/2023-12-01 to stable/2024-04-01.
Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from stable/2023-12-01 to stable/2024-04-01.
Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from stable/2023-12-01 to stable/2024-04-01.
@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 2, 2024

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
Copy link

openapi-pipeline-app bot commented May 2, 2024

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 specs (v0.10.8) new version base version
AppServiceCertificateOrders.json 2024-04-01(660b3fe) 2023-12-01(main)
CertificateOrdersDiagnostics.json 2024-04-01(660b3fe) 2023-12-01(main)
CertificateRegistrationProvider.json 2024-04-01(660b3fe) 2023-12-01(main)
DomainRegistrationProvider.json 2024-04-01(660b3fe) 2023-12-01(main)
Domains.json 2024-04-01(660b3fe) 2023-12-01(main)
TopLevelDomains.json 2024-04-01(660b3fe) 2023-12-01(main)
AppServiceEnvironments.json 2024-04-01(660b3fe) 2023-12-01(main)
AppServicePlans.json 2024-04-01(660b3fe) 2023-12-01(main)
Certificates.json 2024-04-01(660b3fe) 2023-12-01(main)
CommonDefinitions.json 2024-04-01(660b3fe) 2023-12-01(main)
ContainerApps.json 2024-04-01(660b3fe) 2023-12-01(main)
ContainerAppsRevisions.json 2024-04-01(660b3fe) 2023-12-01(main)
DeletedWebApps.json 2024-04-01(660b3fe) 2023-12-01(main)
Diagnostics.json 2024-04-01(660b3fe) 2023-12-01(main)
Global.json 2024-04-01(660b3fe) 2023-12-01(main)
KubeEnvironments.json 2024-04-01(660b3fe) 2023-12-01(main)
Provider.json 2024-04-01(660b3fe) 2023-12-01(main)
Recommendations.json 2024-04-01(660b3fe) 2023-12-01(main)
ResourceHealthMetadata.json 2024-04-01(660b3fe) 2023-12-01(main)
ResourceProvider.json 2024-04-01(660b3fe) 2023-12-01(main)
StaticSites.json 2024-04-01(660b3fe) 2023-12-01(main)
WebApps.json 2024-04-01(660b3fe) 2023-12-01(main)
️🔄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?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 2, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview 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-sdk-for-python inProgress [Detail]
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

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-resource-manager-schemas failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-powershell warning [Detail]

Only 0 items are rendered, please refer to log for more details.

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 2, 2024

@naveedaz naveedaz self-assigned this May 9, 2024
@naveedaz naveedaz removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 14, 2024
@naveedaz naveedaz enabled auto-merge (squash) May 14, 2024 18:51
@naveedaz
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@AzureRestAPISpecReview AzureRestAPISpecReview added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 14, 2024
@naveedaz
Copy link
Contributor Author

@msyyc, @tadelesh , @jsntcy, @qiaozha ,
This PR is simply to get a new release branch started with a new API version started. The PR was generated by using the copy-apiversion.ps1 script per the guidelines here:
https://eng.ms/docs/products/azure-developer-experience/design/api-specs/api-specs?tabs=openapi.

Can we please get this reviewed/approved, so developers in our team can start adding PRs with actual changes to the release branch?

@mentat9 mentat9 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 17, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 17, 2024
@mentat9
Copy link
Member

mentat9 commented May 17, 2024

Note to any future reviewers. This PR was created by a script in 3 sections. Files were added with base commits at iteration 1, (Microsoft.Web), iteration 4 (Microsoft.DomaintRegistration), and iteration 7 (Microsoft.CertificateRegistration). Subsequent iterations through iteration 14 are only whitespace changes. ARM signoff occurred at iteration 14.

@naveedaz
Copy link
Contributor Author

azp /run

@naveedaz naveedaz disabled auto-merge May 20, 2024 21:12
@naveedaz naveedaz requested a review from jocawtho May 20, 2024 21:15
@naveedaz naveedaz enabled auto-merge (squash) May 20, 2024 21:16
@naveedaz
Copy link
Contributor Author

/pr RequestMerge

@naveedaz naveedaz merged commit 941e19b into Azure:release-web-2024-04-01 May 21, 2024
17 of 22 checks passed
@naveedaz naveedaz mentioned this pull request Sep 9, 2024
8 tasks
naveedaz added a commit that referenced this pull request Sep 26, 2024
* Release web 2024 04 01 (#28952)

* Copy files from stable/2023-12-01

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to stable/2024-04-01

Updated the API version from stable/2023-12-01 to stable/2024-04-01.

* Added tag for 2024-04-01 in readme file

* Copy files from stable/2023-12-01

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to stable/2024-04-01

Updated the API version from stable/2023-12-01 to stable/2024-04-01.

* Added tag for 2024-04-01 in readme file

* Copy files from stable/2023-12-01

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to stable/2024-04-01

Updated the API version from stable/2023-12-01 to stable/2024-04-01.

* Added tag for 2024-04-01 in readme file

* Fix RP merge issue

* Fix prettier failute

* Fix spellcheck for sitecontainers

* Fix prettier check failures

* Fix ALL prettier check failures

* Add LeastRequestsWithTieBreaker (#29128)

* Add LeastRequestsWithTieBreaker

* Change to target 2024-04-01

---------

Co-authored-by: Chris Rosenblatt <[email protected]>

* Update 2023-12-01 Microsoft.Web functionAppConfig definition (#29226) (#29350)

* Update 2023-12-01 Microsoft.Web functionAppConfig definition (#29226)

* Rename enum to functionsDeploymentStorageType

* Update enum name to camel case

* Update enum names to camel case

* Port changes to 2024-04-01 API version

* Rename storageType to FunctionsDeploymentStorageType
* Update enum name's to use amelcase casing

---------

Co-authored-by: Naveed Aziz <[email protected]>

* Add SKU property to site. Add description for supported values of kin… (#29354)

* Add SKU property to site. Add description for supported values of kind property on app

* Fix typo

* Fix prettier

* User/rohinisharma/update instance info (#29333)

* Adding parameter to Website Instance Info obj

* Prettier

---------

Co-authored-by: Rohini Sharma <[email protected]>
Co-authored-by: Naveed Aziz <[email protected]>

* [AppServices] Add AutoGeneratedDomainNameLabelScope to Websites (#29649)

* [DNL] Add AutoGeneratedDomainNameLabelScope to Websites

* fix casing

* fix prettier

* Add e2e tls to latest releases (#29904)

Co-authored-by: Chris Rosenblatt <[email protected]>

* Add updatemachinekey api (#29730)

* Add updatemachinekey api

* fix json formatting

* Change api version

* Add machinekey to allowed words

* action verb at end of address

* Change post address to conform to arm

---------

Co-authored-by: Naveed Aziz <[email protected]>

* Developer/nineela/autogenerateddomainnamelabelscope edit 2 (#30047)

* [DNL] Add AutoGeneratedDomainNameLabelScope to Websites

* Minor comment update

* Add IP Mode to Websites (#29089)

* Add IP Mode to Websites

* Target 2024-04-01

* Fix linter

---------

Co-authored-by: Chris Rosenblatt <[email protected]>
Co-authored-by: Naveed Aziz <[email protected]>

* Microsft.Web 2023-12-01: Add int32 format to all number types in the scaleAndConcurrency section of the functionAppConfig (#30050)

* Microsft.Web 2023-12-01: Add int32 format to all number types in the scaleAndConcurrency section of the functionAppConfig (#29907)

* Set format to int32 for all number types in the functionAppConfig

* Update types to integer.

---------

Co-authored-by: Naveed Aziz <[email protected]>

* Update types to integer and set format to int32 for all number types in the functionAppConfig

---------

Co-authored-by: Naveed Aziz <[email protected]>

* Add CipherSuites object to support discoverability API (#30067)

Co-authored-by: Chris Rosenblatt <[email protected]>
Co-authored-by: Naveed Aziz <[email protected]>

---------

Co-authored-by: Chris Rosenblatt <[email protected]>
Co-authored-by: Chris Rosenblatt <[email protected]>
Co-authored-by: Francisco Gamino <[email protected]>
Co-authored-by: rohinisharma <[email protected]>
Co-authored-by: Rohini Sharma <[email protected]>
Co-authored-by: nineela <[email protected]>
Co-authored-by: andrewschuck <[email protected]>
cheukchuen pushed a commit that referenced this pull request Jan 24, 2025
* Release web 2024 04 01 (#28952)

* Copy files from stable/2023-12-01

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to stable/2024-04-01

Updated the API version from stable/2023-12-01 to stable/2024-04-01.

* Added tag for 2024-04-01 in readme file

* Copy files from stable/2023-12-01

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to stable/2024-04-01

Updated the API version from stable/2023-12-01 to stable/2024-04-01.

* Added tag for 2024-04-01 in readme file

* Copy files from stable/2023-12-01

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to stable/2024-04-01

Updated the API version from stable/2023-12-01 to stable/2024-04-01.

* Added tag for 2024-04-01 in readme file

* Fix RP merge issue

* Fix prettier failute

* Fix spellcheck for sitecontainers

* Fix prettier check failures

* Fix ALL prettier check failures

* Add LeastRequestsWithTieBreaker (#29128)

* Add LeastRequestsWithTieBreaker

* Change to target 2024-04-01

---------

Co-authored-by: Chris Rosenblatt <[email protected]>

* Update 2023-12-01 Microsoft.Web functionAppConfig definition (#29226) (#29350)

* Update 2023-12-01 Microsoft.Web functionAppConfig definition (#29226)

* Rename enum to functionsDeploymentStorageType

* Update enum name to camel case

* Update enum names to camel case

* Port changes to 2024-04-01 API version

* Rename storageType to FunctionsDeploymentStorageType
* Update enum name's to use amelcase casing

---------

Co-authored-by: Naveed Aziz <[email protected]>

* Add SKU property to site. Add description for supported values of kin… (#29354)

* Add SKU property to site. Add description for supported values of kind property on app

* Fix typo

* Fix prettier

* User/rohinisharma/update instance info (#29333)

* Adding parameter to Website Instance Info obj

* Prettier

---------

Co-authored-by: Rohini Sharma <[email protected]>
Co-authored-by: Naveed Aziz <[email protected]>

* [AppServices] Add AutoGeneratedDomainNameLabelScope to Websites (#29649)

* [DNL] Add AutoGeneratedDomainNameLabelScope to Websites

* fix casing

* fix prettier

* Add e2e tls to latest releases (#29904)

Co-authored-by: Chris Rosenblatt <[email protected]>

* Add updatemachinekey api (#29730)

* Add updatemachinekey api

* fix json formatting

* Change api version

* Add machinekey to allowed words

* action verb at end of address

* Change post address to conform to arm

---------

Co-authored-by: Naveed Aziz <[email protected]>

* Developer/nineela/autogenerateddomainnamelabelscope edit 2 (#30047)

* [DNL] Add AutoGeneratedDomainNameLabelScope to Websites

* Minor comment update

* Add IP Mode to Websites (#29089)

* Add IP Mode to Websites

* Target 2024-04-01

* Fix linter

---------

Co-authored-by: Chris Rosenblatt <[email protected]>
Co-authored-by: Naveed Aziz <[email protected]>

* Microsft.Web 2023-12-01: Add int32 format to all number types in the scaleAndConcurrency section of the functionAppConfig (#30050)

* Microsft.Web 2023-12-01: Add int32 format to all number types in the scaleAndConcurrency section of the functionAppConfig (#29907)

* Set format to int32 for all number types in the functionAppConfig

* Update types to integer.

---------

Co-authored-by: Naveed Aziz <[email protected]>

* Update types to integer and set format to int32 for all number types in the functionAppConfig

---------

Co-authored-by: Naveed Aziz <[email protected]>

* Add CipherSuites object to support discoverability API (#30067)

Co-authored-by: Chris Rosenblatt <[email protected]>
Co-authored-by: Naveed Aziz <[email protected]>

---------

Co-authored-by: Chris Rosenblatt <[email protected]>
Co-authored-by: Chris Rosenblatt <[email protected]>
Co-authored-by: Francisco Gamino <[email protected]>
Co-authored-by: rohinisharma <[email protected]>
Co-authored-by: Rohini Sharma <[email protected]>
Co-authored-by: nineela <[email protected]>
Co-authored-by: andrewschuck <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review new-api-version resource-manager

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants