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

[Microsoft.app] Release app microsoft.app 2024 10 02 preview #31066

Open
wants to merge 52 commits into
base: main
Choose a base branch
from

Conversation

jijohn14
Copy link
Member

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.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • 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.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • 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.

Juliehzl and others added 30 commits June 21, 2024 11:13
Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from preview/2024-02-02-preview to preview/2024-08-02-preview.
* support scg in 0802preview

* fix lint issue

---------

Co-authored-by: Xuyang Cao <[email protected]>
* add scale property for jc

* swagger prettiercheck

* prettier check

* the prettier check has a bug

* edit description

* refine description

---------

Co-authored-by: Xuyang Cao <[email protected]>
* add debug endpoint on replica container

* fix code style errors

* add example debug endpoint
* update

* fix example

* fix

* fix

* fix

* update examples

* use v5
* Enable DeploymentErrors for ContainerApps

* Add example

* Fix format

---------

Co-authored-by: layliu <[email protected]>
* Add dockerfile path argument

* Fix example

* Fix example

* Fix linting errors

* Modify example

* Update sdk-suppressions.yaml

---------

Co-authored-by: Yuchao Yan <[email protected]>
…Jobs (#30154)

* Add cooldownPeriod property to Jobs.json and Job_CreateorUpdate_EventTrigger.json-TEW

* PR Feedback: Run prettier on json file for PR check-TEW

* PR Feedback: Update ARM for Container Apps with both cooldown and polling properties; Update jobs.json with missing cooldown Period reference-TEW

* PR Feedback: Update ContainerApp examples with KEDA properties cooldownPeriod/pollingInterval-TEW"

* PR Feedback: Re-ran prettier on files noted in PR Check-TEW

* Removing cooldownPeriod from Jobs.json and Jobs examples-TEW
…pp environment (#29987)

* Add includeDapr in traces and include keda in metrics

* pretty
* Fix sessionpool name parameter location

* Prettier
* add fields

* add

* Update Jobs.json

fix runningState and add azure-asyncoperation

* Update Jobs_Resume.json

* Update Jobs_Suspend.json

* add azure-asyncoperation

* fix lintdiff

* fix

* fix

* fix

* add

* reopen PR & add runningState states

---------

Co-authored-by: [email protected] <[email protected]>
…es (#30418)

* enableFips Property for workload profile

* Fix description

* Add default value for property

* run prettier

* More prettier fixes
* Copy files from preview/2024-02-02-preview

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

* Update version to preview/2024-08-02-preview

Updated the API version from preview/2024-02-02-preview to preview/2024-08-02-preview.

* Added tag for 2024-08-02-preview in readme file

* Support spring cloud gateway (#29591)

* support scg in 0802preview

* fix lint issue

---------

Co-authored-by: Xuyang Cao <[email protected]>

* Add scale property to java component (#29801)

* add scale property for jc

* swagger prettiercheck

* prettier check

* the prettier check has a bug

* edit description

* refine description

---------

Co-authored-by: Xuyang Cao <[email protected]>

* [Microsoft.App] add debug endpoint on replica container (#29778)

* add debug endpoint on replica container

* fix code style errors

* add example debug endpoint

* Update header and query parameter for source control (#29536)

* update

* fix example

* fix

* fix

* fix

* update examples

* use v5

* Enable DeploymentErrors for ContainerApps (#29822)

* Enable DeploymentErrors for ContainerApps

* Add example

* Fix format

---------

Co-authored-by: layliu <[email protected]>

* Add dockerfile path argument (#30156)

* Add dockerfile path argument

* Fix example

* Fix example

* Fix linting errors

* Modify example

* Update sdk-suppressions.yaml

---------

Co-authored-by: Yuchao Yan <[email protected]>

* Add KEDA cooldownPeriod/pollingInterval property for Container App & Jobs (#30154)

* Add cooldownPeriod property to Jobs.json and Job_CreateorUpdate_EventTrigger.json-TEW

* PR Feedback: Run prettier on json file for PR check-TEW

* PR Feedback: Update ARM for Container Apps with both cooldown and polling properties; Update jobs.json with missing cooldown Period reference-TEW

* PR Feedback: Update ContainerApp examples with KEDA properties cooldownPeriod/pollingInterval-TEW"

* PR Feedback: Re-ran prettier on files noted in PR Check-TEW

* Removing cooldownPeriod from Jobs.json and Jobs examples-TEW

* Make the header optional for source control (#30232)

* Add includeDapr in traces and include keda in metrics for container app environment (#29987)

* Add includeDapr in traces and include keda in metrics

* pretty

* Fix sessionpool name parameter location (#30231)

* Fix sessionpool name parameter location

* Prettier

* Add job suspend resume (#30304)

* add fields

* add

* Update Jobs.json

fix runningState and add azure-asyncoperation

* Update Jobs_Resume.json

* Update Jobs_Suspend.json

* add azure-asyncoperation

* fix lintdiff

* fix

* fix

* fix

* add

* reopen PR & add runningState states

---------

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

* add runningState change (#30464)

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

* [Microsoft.App] Add enableFips property for dedicated workload profiles (#30418)

* enableFips Property for workload profile

* Fix description

* Add default value for property

* run prettier

* More prettier fixes

* Add system data back for billingMeter (#30627)

* Fix CI check for 2024-08-02-preview (#30641)

* add suppression for patch java component (#30644)

Co-authored-by: Xuyang Cao <[email protected]>

* Fix session pool error response (#30647)

Co-authored-by: Zunli Hu <[email protected]>

* update

---------

Co-authored-by: Xuyang Cao <[email protected]>
Co-authored-by: Xuyang Cao <[email protected]>
Co-authored-by: Yi Liu <[email protected]>
Co-authored-by: LaylaLiu-gmail <[email protected]>
Co-authored-by: layliu <[email protected]>
Co-authored-by: snehapar9 <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>
Co-authored-by: Tara W <[email protected]>
Co-authored-by: Michael Dai <[email protected]>
Co-authored-by: yitaopan <[email protected]>
Co-authored-by: bgashirabake <[email protected]>
Co-authored-by: [email protected] <[email protected]>
Co-authored-by: Jitin John <[email protected]>
#30691)

* Add cooldownPeriod property to Jobs.json and Job_CreateorUpdate_EventTrigger.json-TEW

* PR Feedback: Run prettier on json file for PR check-TEW

* PR Feedback: Update ARM for Container Apps with both cooldown and polling properties; Update jobs.json with missing cooldown Period reference-TEW

* PR Feedback: Update ContainerApp examples with KEDA properties cooldownPeriod/pollingInterval-TEW"

* PR Feedback: Re-ran prettier on files noted in PR Check-TEW

* Removing cooldownPeriod from Jobs.json and Jobs examples-TEW

* Remove default for polling and cooldown to fix error-TEW
Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from preview/2024-08-02-preview to preview/2024-10-02-preview.
* Add Identity to session pool registry

* update examples

* fix
* easyauth blob token store support msi to auth

* update examples

* update

* update

* lint

* lint

* add examples
* Enable Async Operation for ConnectedEnvironment SubResources

* Fixes

* Fixes for comments

* Fix DaprComponentDefinition

* Fixes for comments

---------

Co-authored-by: layliu <[email protected]>
* Add GPU property to container resources

* Update example

* Fix linting

* Update specification/app/resource-manager/Microsoft.App/preview/2024-10-02-preview/CommonDefinitions.json

Co-authored-by: Jitin John <[email protected]>

* Update example

* Fix linting

---------

Co-authored-by: Jitin John <[email protected]>
@Juliehzl
Copy link
Contributor

The first commit needs to be an exact copy of the previous API version. All new changes should only be added in the subsequent commits. This allows the reviewer to get a clear understanding of the actual changes being introduced. With the way the PR is raised now, it is not possible for the reviewer to tell what the changes are. Please either abandon the PR and raise another one with the recommendation or create a new set of commits on this PR following the recommendation. If you are doing the later option please indicate which commit is the exact copy of the previous version.

@razvanbadea-msft Here is the first commit id bf061fc8170fc38a9a5a967dd1a0792ae8cf9678 which is a copy of previous api version. If you look at code change in our RP Microsoft.App only, you can see all new changes are added in subsequent commits https://github.com/Azure/azure-rest-api-specs/commits/release-app-Microsoft.App-2024-10-02-preview/specification/app/resource-manager starting from bf061fc. In the root folder, you can see many commits which is not related to Microsoft.App because @jijohn14 did a rebase to main branch which introduce the unexpected commits.

Our PR is open for long time and we are urgent to merge for Ignite. Can you help review with commits https://github.com/Azure/azure-rest-api-specs/commits/release-app-Microsoft.App-2024-10-02-preview/specification/app/resource-manager starting from bf061fc in Microsoft.App folder only? Thanks a lot. Sorry for inconvenience.

@Juliehzl Juliehzl added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Nov 12, 2024
@razvanbadea-msft razvanbadea-msft added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 12, 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 Nov 12, 2024
@Juliehzl Juliehzl added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Nov 13, 2024
@Juliehzl
Copy link
Contributor

@razvanbadea-msft Thanks for reviewing. Actually all changes are reviewed by ARM team previous with separate PRs to the feature branch release-app-Microsoft.App-2024-10-02-preview.

@razvanbadea-msft razvanbadea-msft added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 13, 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 Nov 13, 2024
@Juliehzl Juliehzl added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Nov 14, 2024
@razvanbadea-msft
Copy link
Contributor

  Session Pool is using componentType as the discriminator. While the discriminator is a required property, this rule prevent it being present in the patch request body.

In the session pool the patch is using SessionPoolUpdatableProperties, is this suppression really needed? I do not see a discriminator used in this case


Refers to: specification/app/resource-manager/readme.md:86 in 8575f62. [](commit_id = 8575f62, deletion_comment = False)

@razvanbadea-msft razvanbadea-msft added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 14, 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 Nov 14, 2024
@HAKIMBIBI67A
Copy link

ALI MUHAMMAD IHSAN

@azure-sdk
Copy link
Collaborator

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.App

@najian
Copy link
Member

najian commented Nov 14, 2024

@razvanbadea-msft from PR add ManagedIdentitySettings to session pool 2024-10-02-preview by najian · Pull Request #30771 · Azure/azure-rest-api-specs (github.com)
ARM reviewer rkmanda commented on Oct 5 suggest "For the patch... rule that is breaking please add a suppression.."

  Session Pool is using componentType as the discriminator. While the discriminator is a required property, this rule prevent it being present in the patch request body.

In the session pool the patch is using SessionPoolUpdatableProperties, is this suppression really needed? I do not see a discriminator used in this case

Refers to: specification/app/resource-manager/readme.md:86 in 8575f62. [](commit_id = 8575f62, deletion_comment = False)

@najian najian added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 14, 2024
@Juliehzl Juliehzl removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 14, 2024
@razvanbadea-msft razvanbadea-msft added Approved-Suppression ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Nov 14, 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 Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-Suppression ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. BreakingChange-Python-Sdk-Suppression BreakingChange-Python-Sdk-Suppression-Approved BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version PipelineBotTrigger PublishToCustomers Acknowledgement the changes will be published to Azure customers. ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager SuppressionReviewRequired
Projects
None yet
Development

Successfully merging this pull request may close these issues.