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 definition for ElasticWebAppScaleLimit #22839

Conversation

jocawtho
Copy link
Member

@jocawtho jocawtho commented Feb 28, 2023

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @jocawtho Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 28, 2023

    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 2022-09-01(2c02e03) 2022-03-01(main)
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2022-09 package-2022-09(2c02e03) package-2022-09(release-web-Microsoft.Web-2022-09-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 'AppServiceCertificateOrders_List' does not match the response definition in the individual GET operation 'AppServiceCertificateOrders_Get' .
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17
    GetCollectionResponseSchema The response in the GET collection operation 'AppServiceCertificateOrders_ListCertificates' does not match the response definition in the individual GET operation 'AppServiceCertificateOrders_GetCertificate' .
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17
    GetCollectionResponseSchema The response in the GET collection operation 'Domains_List' does not match the response definition in the individual GET operation 'Domains_Get' .
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17
    GetCollectionResponseSchema The response in the GET collection operation 'Domains_ListOwnershipIdentifiers' does not match the response definition in the individual GET operation 'Domains_GetOwnershipIdentifier' .
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17
    GetCollectionResponseSchema The response in the GET collection operation 'TopLevelDomains_List' does not match the response definition in the individual GET operation 'TopLevelDomains_Get' .
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17
    GetCollectionResponseSchema The response in the GET collection operation 'AppServiceEnvironments_List' does not match the response definition in the individual GET operation 'AppServiceEnvironments_Get' .
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17
    GetCollectionResponseSchema The response in the GET collection operation 'AppServiceEnvironments_ListMultiRolePools' does not match the response definition in the individual GET operation 'AppServiceEnvironments_GetMultiRolePool' .
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17
    GetCollectionResponseSchema The response in the GET collection operation 'AppServiceEnvironments_ListWorkerPools' does not match the response definition in the individual GET operation 'AppServiceEnvironments_GetWorkerPool' .
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17
    GetCollectionResponseSchema The response in the GET collection operation 'Certificates_List' does not match the response definition in the individual GET operation 'Certificates_Get' .
    Location: Microsoft.Web/stable/2022-09-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/2022-09-01/CommonDefinitions.json#L671
    ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L968
    NestedResourcesMustHaveListOperation The nested resource 'HybridConnection' does not have list operation, please add it.
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L1806
    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/2022-09-01/CommonDefinitions.json#L2239
    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/2022-09-01/CommonDefinitions.json#L3060
    NestedResourcesMustHaveListOperation The nested resource 'VnetGateway' does not have list operation, please add it.
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L3992
    NestedResourcesMustHaveListOperation The nested resource 'VnetInfoResource' does not have list operation, please add it.
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L4069
    NestedResourcesMustHaveListOperation The nested resource 'VnetRoute' does not have list operation, please add it.
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L4086
    ⚠️ 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/2022-09-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/2022-09-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/2022-09-01/CommonDefinitions.json#L190
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L237
    ⚠️ 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/2022-09-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/2022-09-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/2022-09-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/2022-09-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/2022-09-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/2022-09-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/2022-09-01/CommonDefinitions.json#L382
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L441
    ⚠️ 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/2022-09-01/CommonDefinitions.json#L470
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 28, 2023

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

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

    ️️✔️ 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 inProgress [Detail]
    ️❌ azure-powershell failed [Detail]

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

    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the Web Apps label Feb 28, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 28, 2023

    Generated ApiView

    Language Package Name ApiView Link
    swagger Microsoft.CertificateRegistration https://apiview.dev/Assemblies/Review/2ab5c81552ff4b68a293304b07bd7648
    Go sdk/resourcemanager/appservice/armappservice https://apiview.dev/Assemblies/Review/436577ee443543e2969d4a5d9cdcb8ee
    Java azure-resourcemanager-appservice-generated Create ApiView failed. Please ask PR assignee for help
    JavaScript @azure/arm-appservice https://apiview.dev/Assemblies/Review/688daf804332483894761dc2ef77097a

    @openapi-workflow-bot
    Copy link

    Hi @jocawtho, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    naveedaz and others added 2 commits February 28, 2023 19:05
    Use camel casing for property name
    Use camel casing for elasticWebAppScaleLimit
    @weidongxu-microsoft
    Copy link
    Member

    Make sure Navy aware/approve of it.

    @weidongxu-microsoft weidongxu-microsoft merged commit c143d39 into Azure:release-web-Microsoft.Web-2022-09-01 Mar 1, 2023
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants