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

Add IP Mode to Websites #29089

Conversation

crosenblatt
Copy link
Contributor

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:
    • Add new field to App Service websites definitions

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

@crosenblatt crosenblatt requested a review from naveedaz as a code owner May 13, 2024 19:25
Copy link

openapi-pipeline-app bot commented May 13, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app bot commented May 13, 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.9) new version base version
CommonDefinitions.json 2024-04-01(16c9044) 2023-12-01(main)
️⚠️LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-2024-04 package-2024-04(16c9044) package-2024-04(release-web-2024-04-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/2024-04-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/2024-04-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/2024-04-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/2024-04-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/2024-04-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/2024-04-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/2024-04-01/CommonDefinitions.json#L684
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L713
ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L981
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L1024
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L1800
NestedResourcesMustHaveListOperation The nested resource 'HybridConnection' does not have list operation, please add it.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L1819
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L1978
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/2024-04-01/CommonDefinitions.json#L2252
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/2024-04-01/CommonDefinitions.json#L3110
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L3618
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L4160
NestedResourcesMustHaveListOperation The nested resource 'VnetGateway' does not have list operation, please add it.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L4327
NestedResourcesMustHaveListOperation The nested resource 'VnetInfoResource' does not have list operation, please add it.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L4404
NestedResourcesMustHaveListOperation The nested resource 'VnetRoute' does not have list operation, please add it.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L4421
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L125
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L147
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L190
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L286
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L291
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L306
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L325
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L334
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L343
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Web/stable/2024-04-01/CommonDefinitions.json#L382
️️✔️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 May 13, 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?

@crosenblatt crosenblatt changed the base branch from main to release-web-2024-04-01 May 22, 2024 16:45
@razvanbadea-msft
Copy link
Contributor

Please fix the Swagger LintDiff check

@razvanbadea-msft razvanbadea-msft added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 24, 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 24, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Jul 8, 2024
@crosenblatt crosenblatt removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jul 17, 2024
@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 17, 2024
@raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jul 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 Jul 17, 2024
@naveedaz naveedaz merged commit 395e921 into Azure:release-web-2024-04-01 Aug 9, 2024
23 of 28 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 <crosenblatt@microsoft.com>

* 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 <naveeda@microsoft.com>

* 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 <rohinisharma@microsoft.com>
Co-authored-by: Naveed Aziz <naveeda@microsoft.com>

* [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 <crosenblatt@microsoft.com>

* 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 <naveeda@microsoft.com>

* 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 <crosenblatt@microsoft.com>
Co-authored-by: Naveed Aziz <naveeda@microsoft.com>

* 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 <naveeda@microsoft.com>

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

---------

Co-authored-by: Naveed Aziz <naveeda@microsoft.com>

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

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

---------

Co-authored-by: Chris Rosenblatt <rosench13@gmail.com>
Co-authored-by: Chris Rosenblatt <crosenblatt@microsoft.com>
Co-authored-by: Francisco Gamino <Francisco-Gamino@users.noreply.github.com>
Co-authored-by: rohinisharma <rohini2@illinois.edu>
Co-authored-by: Rohini Sharma <rohinisharma@microsoft.com>
Co-authored-by: nineela <82120829+nineela@users.noreply.github.com>
Co-authored-by: andrewschuck <115187222+andrewschuck@users.noreply.github.com>
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 <crosenblatt@microsoft.com>

* 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 <naveeda@microsoft.com>

* 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 <rohinisharma@microsoft.com>
Co-authored-by: Naveed Aziz <naveeda@microsoft.com>

* [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 <crosenblatt@microsoft.com>

* 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 <naveeda@microsoft.com>

* 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 <crosenblatt@microsoft.com>
Co-authored-by: Naveed Aziz <naveeda@microsoft.com>

* 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 <naveeda@microsoft.com>

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

---------

Co-authored-by: Naveed Aziz <naveeda@microsoft.com>

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

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

---------

Co-authored-by: Chris Rosenblatt <rosench13@gmail.com>
Co-authored-by: Chris Rosenblatt <crosenblatt@microsoft.com>
Co-authored-by: Francisco Gamino <Francisco-Gamino@users.noreply.github.com>
Co-authored-by: rohinisharma <rohini2@illinois.edu>
Co-authored-by: Rohini Sharma <rohinisharma@microsoft.com>
Co-authored-by: nineela <82120829+nineela@users.noreply.github.com>
Co-authored-by: andrewschuck <115187222+andrewschuck@users.noreply.github.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 Web Apps
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants