-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Adding workload profile & resource config to Site #25868
Adding workload profile & resource config to Site #25868
Conversation
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). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
CommonDefinitions.json | 2023-01-01(48bcb68) | 2022-09-01(main) |
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.5) | new version | base version |
---|---|---|
package-2023-01 | package-2023-01(48bcb68) | package-2023-01(release-web-2023-01-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/2023-01-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/2023-01-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/2023-01-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/2023-01-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/2023-01-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/2023-01-01/CommonDefinitions.json#L17 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L229 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L408 |
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/2023-01-01/CommonDefinitions.json#L671 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L700 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L968 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L1011 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L1115 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L1390 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L1416 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L1787 |
NestedResourcesMustHaveListOperation |
The nested resource 'HybridConnection' does not have list operation, please add it. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L1806 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L1965 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L1984 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L2070 |
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/2023-01-01/CommonDefinitions.json#L2239 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L2672 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L2720 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L2720 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L2741 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L2745 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L2793 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L2918 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L2918 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#L2918 |
️️✔️
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.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
@@ -2923,6 +2923,14 @@ | |||
"$ref": "#/definitions/DaprConfig", | |||
"description": "Dapr configuration of the app." | |||
}, | |||
"workloadProfileName": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there example updates?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is in release branch and was looking into few of the previous PRs which do not have the examples updates for properties used on a specific scenario. These properties are applicable for one of the scenarios in this Site schema (Site schema have multiple scenarios of Web, functions, logic app, etc where this is not applicable), so may not be also accurate to update.
e.g.
Dapr configuration for a site by SushmithaVReddy · Pull Request #24606 · Azure/azure-rest-api-specs (github.com)
WebRp || Added environmentId in Site by vishal1997 · Pull Request #25173 · Azure/azure-rest-api-specs (github.com)
Add Container Apps Environment Id in checknameavailability API by vishal1997 · Pull Request #24102 · Azure/azure-rest-api-specs (github.com)
#22341
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since these properties are for external customers and these examples are feed into public rest api doc that customer follows, it is always good to add examples for all the properties, so that Cx can get idea how the property values look like. From your explanation, it is not clear what is the concern here adding/updating the examples for the new properties added in this PR.
I would suggest consider adding them in your examples.
@mukundnigam |
Please address or respond to feedback from the ARM API reviewer. |
53963e2
to
48bcb68
Compare
/pr RequestMerge |
* Add new api-version 2023-01-01 (#22962) * Add new api-version 2023-01-01 * Change default package api-version * Updated workflowstate to be a reference (#23084) * Fix OneDeploy request and response bodies (#23224) * Fix OneDeploy request and response bodies * Fixing typo * Add Container Apps Environment Id in checknameavailability API (#24102) Co-authored-by: Vishal Gupta <[email protected]> * Add minTlsCipherSuite property (#24198) * Add minTlsCipherSuite property * Move to SiteConfig --------- Co-authored-by: Chris Rosenblatt <[email protected]> * Dapr configuration for a site (#24606) * Dapr configuration for a site * removed dapr older definition * adding back old dapr definition * Modified 'Dapr' to 'DaprConfig' to resolve conflicts with older dapr definition * to initiate checks as re-run * fixed prettier check fail --------- Co-authored-by: Sushmitha Vangala <[email protected]> * Fix for JS SDK check failure for Dapr Config (#25493) * Dapr configuration for a site * removed dapr older definition * adding back old dapr definition * Modified 'Dapr' to 'DaprConfig' to resolve conflicts with older dapr definition * to initiate checks as re-run * fixed prettier check fail * JS Sdk check fail fix --------- Co-authored-by: Sushmitha Vangala <[email protected]> * Release web 2023 01 01 (#25157) * Adding locations/usages endpoint and example * Revert "Adding locations/usages endpoint and example" This reverts commit 4a11107. * Adding back usages changes with up to date branch * Updates based on verification tools * Fixing spacing, adding missing comma * ran prettier-fix for formatting * Update for new QMS requirements with ZR * Using prettier to fix linter error * Adding ZR endpoint * Fixing duplicate operationId * QMS Usages * Validation changes * Updating schema * Updating for collection * fixing pr comments * Resolving comments * Updating description * Resolving comments --------- Co-authored-by: Rohini Sharma <[email protected]> * Release web 2023 01 01 (#25629) * Adding locations/usages endpoint and example * Revert "Adding locations/usages endpoint and example" This reverts commit 4a11107. * Adding back usages changes with up to date branch * Updates based on verification tools * Fixing spacing, adding missing comma * ran prettier-fix for formatting * Update for new QMS requirements with ZR * Using prettier to fix linter error * Adding ZR endpoint * Fixing duplicate operationId * QMS Usages * Validation changes * Updating schema * Updating for collection * fixing pr comments * Resolving comments * Updating description * Resolving comments * Removing quota type parameter --------- Co-authored-by: Rohini Sharma <[email protected]> * Adding workload profile & resource config to Site (#25868) * Adding workload profile & resource config to Site * prettier fix * cosmetic fix * updating examples * prettier fix * Fix Python SDK failure for Dapr log level config (#26198) * Rename log level enum for dapr * Fix Python SDK failure for Dapr log level config * Rename log level num for dapr (#26374) * Rename log level num for dapr * Rename log level num for dapr * initial change to add ase regions (#26333) * initial change to add ase regions * addressing comments * nit adding example as suggested * formatting code * add custom word * prettier everything * prettier everything * Revert "Fix OneDeploy request and response bodies (#23224)" (#26580) This reverts commit 7dfc303. --------- Co-authored-by: Alex Karcher <[email protected]> Co-authored-by: dannysongg <[email protected]> Co-authored-by: Vishal Gupta <[email protected]> Co-authored-by: Vishal Gupta <[email protected]> Co-authored-by: Chris Rosenblatt <[email protected]> Co-authored-by: Chris Rosenblatt <[email protected]> Co-authored-by: SushmithaVReddy <[email protected]> Co-authored-by: Sushmitha Vangala <[email protected]> Co-authored-by: rohinisharma <[email protected]> Co-authored-by: Rohini Sharma <[email protected]> Co-authored-by: mukundnigam <[email protected]> Co-authored-by: Kirstyn Amperiadis <[email protected]> Co-authored-by: Haochi <[email protected]>
* Add new api-version 2023-01-01 (#22962) * Add new api-version 2023-01-01 * Change default package api-version * Updated workflowstate to be a reference (#23084) * Fix OneDeploy request and response bodies (#23224) * Fix OneDeploy request and response bodies * Fixing typo * Add Container Apps Environment Id in checknameavailability API (#24102) Co-authored-by: Vishal Gupta <[email protected]> * Add minTlsCipherSuite property (#24198) * Add minTlsCipherSuite property * Move to SiteConfig --------- Co-authored-by: Chris Rosenblatt <[email protected]> * Dapr configuration for a site (#24606) * Dapr configuration for a site * removed dapr older definition * adding back old dapr definition * Modified 'Dapr' to 'DaprConfig' to resolve conflicts with older dapr definition * to initiate checks as re-run * fixed prettier check fail --------- Co-authored-by: Sushmitha Vangala <[email protected]> * Fix for JS SDK check failure for Dapr Config (#25493) * Dapr configuration for a site * removed dapr older definition * adding back old dapr definition * Modified 'Dapr' to 'DaprConfig' to resolve conflicts with older dapr definition * to initiate checks as re-run * fixed prettier check fail * JS Sdk check fail fix --------- Co-authored-by: Sushmitha Vangala <[email protected]> * Release web 2023 01 01 (#25157) * Adding locations/usages endpoint and example * Revert "Adding locations/usages endpoint and example" This reverts commit 4a11107. * Adding back usages changes with up to date branch * Updates based on verification tools * Fixing spacing, adding missing comma * ran prettier-fix for formatting * Update for new QMS requirements with ZR * Using prettier to fix linter error * Adding ZR endpoint * Fixing duplicate operationId * QMS Usages * Validation changes * Updating schema * Updating for collection * fixing pr comments * Resolving comments * Updating description * Resolving comments --------- Co-authored-by: Rohini Sharma <[email protected]> * Release web 2023 01 01 (#25629) * Adding locations/usages endpoint and example * Revert "Adding locations/usages endpoint and example" This reverts commit 4a11107. * Adding back usages changes with up to date branch * Updates based on verification tools * Fixing spacing, adding missing comma * ran prettier-fix for formatting * Update for new QMS requirements with ZR * Using prettier to fix linter error * Adding ZR endpoint * Fixing duplicate operationId * QMS Usages * Validation changes * Updating schema * Updating for collection * fixing pr comments * Resolving comments * Updating description * Resolving comments * Removing quota type parameter --------- Co-authored-by: Rohini Sharma <[email protected]> * Adding workload profile & resource config to Site (#25868) * Adding workload profile & resource config to Site * prettier fix * cosmetic fix * updating examples * prettier fix * Fix Python SDK failure for Dapr log level config (#26198) * Rename log level enum for dapr * Fix Python SDK failure for Dapr log level config * Rename log level num for dapr (#26374) * Rename log level num for dapr * Rename log level num for dapr * initial change to add ase regions (#26333) * initial change to add ase regions * addressing comments * nit adding example as suggested * formatting code * add custom word * prettier everything * prettier everything * Revert "Fix OneDeploy request and response bodies (#23224)" (#26580) This reverts commit 7dfc303. --------- Co-authored-by: Alex Karcher <[email protected]> Co-authored-by: dannysongg <[email protected]> Co-authored-by: Vishal Gupta <[email protected]> Co-authored-by: Vishal Gupta <[email protected]> Co-authored-by: Chris Rosenblatt <[email protected]> Co-authored-by: Chris Rosenblatt <[email protected]> Co-authored-by: SushmithaVReddy <[email protected]> Co-authored-by: Sushmitha Vangala <[email protected]> Co-authored-by: rohinisharma <[email protected]> Co-authored-by: Rohini Sharma <[email protected]> Co-authored-by: mukundnigam <[email protected]> Co-authored-by: Kirstyn Amperiadis <[email protected]> Co-authored-by: Haochi <[email protected]>
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
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] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] 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!
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:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.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
and https://aka.ms/ci-fix.