Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GeoRegions - Add FlexConsumption to the list of supported skus #27951

Merged

Conversation

Francisco-Gamino
Copy link
Contributor

ARM (Control Plane) API Specification Update Pull Request

Add FlexConsumption to the list of supported skus.

Tip

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

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)

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

Copy link

openapi-pipeline-app bot commented Feb 28, 2024

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

Copy link

openapi-pipeline-app bot commented Feb 28, 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 swaggers (via Oad v0.10.5)] new version base version
ResourceProvider.json 2023-12-01(5446287) 2023-01-01(main)
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.2.0) new version base version
package-2023-12 package-2023-12(5446287) 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
EvenSegmentedPathForPutOperation API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments).
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L18
TenantLevelAPIsNotAllowed /providers/Microsoft.Web/publishingUsers/web is a tenant level api. Tenant level APIs are strongly discouraged and subscription or resource group level APIs are preferred instead. If you cannot model your APIs at these levels, you will need to present your design and get an exception from PAS team.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L18
XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L19
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L43
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L138
XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L305
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L320
XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L520
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L535
PathForResourceAction Path for 'post' method on a resource type MUST follow valid resource naming.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L723
PathForResourceAction Path for 'post' method on a resource type MUST follow valid resource naming.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L802
TopLevelResourcesListBySubscription The top-level resource 'SourceControl' does not have list by subscription operation, please add it.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L1416
⚠️ ReservedResourceNamesModelAsEnum The service-defined (reserved name) resource 'web' should be represented as a path parameter enum with modelAsString set to true.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L18
⚠️ XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L19
⚠️ XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L43
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L78
⚠️ XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L78
⚠️ RequiredReadOnlySystemData The response of operation:'GetSourceControl' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L107
⚠️ XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L107
⚠️ RequiredReadOnlySystemData The response of operation:'UpdateSourceControl' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L138
⚠️ XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L138
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L180
⚠️ XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L180
⚠️ XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L224
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L263
⚠️ PageableOperation Based on the response model schema, operation 'GetSubscriptionDeploymentLocations' might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L305
⚠️ XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L305
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L334
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L371
⚠️ XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2023-12-01/ResourceProvider.json#L371
️️✔️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?

Copy link

openapi-pipeline-app bot commented Feb 28, 2024

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-net-track2 failed [Detail]

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-resource-manager-schemas inProgress [Detail]
️⚠️ 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?

Copy link

openapi-pipeline-app bot commented Feb 28, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/appservice/armappservice Create ApiView timeout. Package is too large and we cannot create ApiView for it.
Java azure-resourcemanager-appservice-generated https://apiview.dev/Assemblies/Review/a2b80e4fbd144844bca0c504ef8c3337?revisionId=9088d4383b0f4c5cb18cfca21141a530
JavaScript @azure/arm-appservice https://apiview.dev/Assemblies/Review/98dbdc8147d7472b9bdff567a8b291bc?revisionId=a8ae396f512d494eb7abbe51edee0e53

@Francisco-Gamino
Copy link
Contributor Author

Francisco-Gamino commented Feb 28, 2024

@Francisco-Gamino Francisco-Gamino merged commit 155b175 into Azure:release-web-2023-12-01 Feb 28, 2024
24 of 27 checks passed
@Francisco-Gamino Francisco-Gamino deleted the update-sku branch February 28, 2024 18:13
catalinaperalta pushed a commit that referenced this pull request Apr 20, 2024
* Introduce Microsoft.Web API version 2023-12-01 (#27100)

* Add VnetBackupRestoreEnabled property to the latest API Version (#27175)

* changed ApproveRejectSitePrivateEndpointConnection request body to match service parameter (#27317)

Co-authored-by: Xingyang Li <xingyangli@microsoft.com>

* e2e encryption (#27226)

Co-authored-by: Chris Rosenblatt <crosenblatt@microsoft.com>

* Adding Vnet-related APIs to Swagger (#27251)

* Add function app config to latest Web API (#27358)

* Add functionAppConfig definition

* Add create or update function app Flex Consumption example

* Add create or update function app Flex Consumption with details example

* Update CommonDefinitions.json to reference the new examples

* Make PUT/PATCH api async for function on aca (#27612)

* Make PUT/PATCH api async for function on aca

* Remove response body

* update examples

* Add headers

---------

Co-authored-by: Vishal Gupta <vishgupta@microsoft.com>

* Add FlexConsumption to the list of supported skus (#27951)

* Add TLS1.3 to valid TLS Versions (#27885)

Authored-by: Chris Rosenblatt <crosenblatt@microsoft.com>. I'm completing this since it was asked for and Chris is OOF atm

* Added Linux SiteContainer APIs (#27942)

* Added Linux SiteContainer APIs

* Resolved validation failures.

* Added SiteContainer and SiteContainerCollection

* Fixed LintDiff errors

* Fixed spellings

* Updated params order.

* Resolving comments.

* Resolving comments.

* Added volumeMounts and envVariables.

* Resolving comments

* Resolving comments

* Removed type and metadata.

* Haochidu/release web 2023 12 01/aseregion hotfix (#28018)

* Update ResourceProvider.json

hot fix

API will return with the correct body but also with a nextLink with a URL instead of just null. I did a little more research and it seems like since my API does not return next links I think the fix should just be set the nextlinkname to null in the swagger specification.

* Update ResourceProvider.json

* Revert "Adding Vnet-related APIs to Swagger (#27251)" (#28249)

This reverts commit 0765e9d.

* Add DnsConfiguration site property to Microsoft.Web API Specs (#27378)

* Add DnsConfiguration property to WebApps.json

* Add SiteDnsConfig to CommonDefinitions.json

* Updated dnslegacy property description

* Update CommonDefinitions.json

* Undo previous update to CommonDefinitions.json

* Update CommonDefinitions.json: added readonly: true for dnsLegacySortOrder

* Add AzureStorageProtocol field to AzureStorageInfoValue definition. (#28289)

Co-authored-by: Amber Renton <amberrenton@microsoft.com>

* Update create function app examples for Flex Consumption (#28566)

* Revert "Make PUT/PATCH api async for function on aca (#27612)" (#28568)

This reverts commit cd214ae.

* Revert "Haochidu/release web 2023 12 01/aseregion hotfix (#28018)" (#28738)

This reverts commit ec1d84f.

* create sdk-suppression.yaml (#28751)

* create sdk-suppression.yaml

* add azure-sdk-for-go suppression

---------

Co-authored-by: Alancere <804873052@qq.com>

---------

Co-authored-by: Ashok Kumar Karasala <106590066+vkarasala@users.noreply.github.com>
Co-authored-by: xingyangli1278 <xingyangli1278@gmail.com>
Co-authored-by: Xingyang Li <xingyangli@microsoft.com>
Co-authored-by: Chris Rosenblatt <rosench13@gmail.com>
Co-authored-by: Chris Rosenblatt <crosenblatt@microsoft.com>
Co-authored-by: hdmimsft <137456285+hdmimsft@users.noreply.github.com>
Co-authored-by: Francisco Gamino <Francisco-Gamino@users.noreply.github.com>
Co-authored-by: Vishal Gupta <vishalgupta7991@gmail.com>
Co-authored-by: Vishal Gupta <vishgupta@microsoft.com>
Co-authored-by: DJagwani <122347490+DJagwani@users.noreply.github.com>
Co-authored-by: Haochi <136372741+ha0ch1@users.noreply.github.com>
Co-authored-by: tbhartia <149726222+tbhartia@users.noreply.github.com>
Co-authored-by: Amber Renton <136374263+amberrenton@users.noreply.github.com>
Co-authored-by: Amber Renton <amberrenton@microsoft.com>
Co-authored-by: jocawtho <jocawtho@microsoft.com>
Co-authored-by: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com>
Co-authored-by: Alancere <804873052@qq.com>
rkmanda pushed a commit that referenced this pull request Apr 20, 2024
* Introduce Microsoft.Web API version 2023-12-01 (#27100)

* Add VnetBackupRestoreEnabled property to the latest API Version (#27175)

* changed ApproveRejectSitePrivateEndpointConnection request body to match service parameter (#27317)

Co-authored-by: Xingyang Li <xingyangli@microsoft.com>

* e2e encryption (#27226)

Co-authored-by: Chris Rosenblatt <crosenblatt@microsoft.com>

* Adding Vnet-related APIs to Swagger (#27251)

* Add function app config to latest Web API (#27358)

* Add functionAppConfig definition

* Add create or update function app Flex Consumption example

* Add create or update function app Flex Consumption with details example

* Update CommonDefinitions.json to reference the new examples

* Make PUT/PATCH api async for function on aca (#27612)

* Make PUT/PATCH api async for function on aca

* Remove response body

* update examples

* Add headers

---------

Co-authored-by: Vishal Gupta <vishgupta@microsoft.com>

* Add FlexConsumption to the list of supported skus (#27951)

* Add TLS1.3 to valid TLS Versions (#27885)

Authored-by: Chris Rosenblatt <crosenblatt@microsoft.com>. I'm completing this since it was asked for and Chris is OOF atm

* Added Linux SiteContainer APIs (#27942)

* Added Linux SiteContainer APIs

* Resolved validation failures.

* Added SiteContainer and SiteContainerCollection

* Fixed LintDiff errors

* Fixed spellings

* Updated params order.

* Resolving comments.

* Resolving comments.

* Added volumeMounts and envVariables.

* Resolving comments

* Resolving comments

* Removed type and metadata.

* Haochidu/release web 2023 12 01/aseregion hotfix (#28018)

* Update ResourceProvider.json

hot fix

API will return with the correct body but also with a nextLink with a URL instead of just null. I did a little more research and it seems like since my API does not return next links I think the fix should just be set the nextlinkname to null in the swagger specification.

* Update ResourceProvider.json

* Revert "Adding Vnet-related APIs to Swagger (#27251)" (#28249)

This reverts commit 0765e9d.

* Add DnsConfiguration site property to Microsoft.Web API Specs (#27378)

* Add DnsConfiguration property to WebApps.json

* Add SiteDnsConfig to CommonDefinitions.json

* Updated dnslegacy property description

* Update CommonDefinitions.json

* Undo previous update to CommonDefinitions.json

* Update CommonDefinitions.json: added readonly: true for dnsLegacySortOrder

* Add AzureStorageProtocol field to AzureStorageInfoValue definition. (#28289)

Co-authored-by: Amber Renton <amberrenton@microsoft.com>

* Update create function app examples for Flex Consumption (#28566)

* Revert "Make PUT/PATCH api async for function on aca (#27612)" (#28568)

This reverts commit cd214ae.

* Revert "Haochidu/release web 2023 12 01/aseregion hotfix (#28018)" (#28738)

This reverts commit ec1d84f.

* create sdk-suppression.yaml (#28751)

* create sdk-suppression.yaml

* add azure-sdk-for-go suppression

---------

Co-authored-by: Alancere <804873052@qq.com>

---------

Co-authored-by: Ashok Kumar Karasala <106590066+vkarasala@users.noreply.github.com>
Co-authored-by: xingyangli1278 <xingyangli1278@gmail.com>
Co-authored-by: Xingyang Li <xingyangli@microsoft.com>
Co-authored-by: Chris Rosenblatt <rosench13@gmail.com>
Co-authored-by: Chris Rosenblatt <crosenblatt@microsoft.com>
Co-authored-by: hdmimsft <137456285+hdmimsft@users.noreply.github.com>
Co-authored-by: Francisco Gamino <Francisco-Gamino@users.noreply.github.com>
Co-authored-by: Vishal Gupta <vishalgupta7991@gmail.com>
Co-authored-by: Vishal Gupta <vishgupta@microsoft.com>
Co-authored-by: DJagwani <122347490+DJagwani@users.noreply.github.com>
Co-authored-by: Haochi <136372741+ha0ch1@users.noreply.github.com>
Co-authored-by: tbhartia <149726222+tbhartia@users.noreply.github.com>
Co-authored-by: Amber Renton <136374263+amberrenton@users.noreply.github.com>
Co-authored-by: Amber Renton <amberrenton@microsoft.com>
Co-authored-by: jocawtho <jocawtho@microsoft.com>
Co-authored-by: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com>
Co-authored-by: Alancere <804873052@qq.com>
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 resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants