Skip to content

Conversation

@vturecek
Copy link
Member

@vturecek vturecek commented Mar 15, 2024

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.

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

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Mar 15, 2024

Next Steps to Merge

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Mar 15, 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.5) new version base version
CommonDefinitions.json 2024-02-02-preview(a716688) 2023-05-01(main)
CommonDefinitions.json 2024-02-02-preview(a716688) 2023-11-02-preview(main)
Jobs.json 2024-02-02-preview(a716688) 2023-05-01(main)
Jobs.json 2024-02-02-preview(a716688) 2023-11-02-preview(main)
️⚠️LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.0) new version base version
package-preview-2024-02 package-preview-2024-02(a716688) package-preview-2024-02(release-app-Microsoft.App-2024-02-02-preview)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule Message
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L293
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L432
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L459
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L529
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L529
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L529
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L550
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L554
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L558
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L638
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L638
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L638
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L655
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L1079
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L1126
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L1571
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L186
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L206
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L245
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:type.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L281
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:triggerType.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L281
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:triggerType.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L281
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:replicaTimeout.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L281
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:cronExpression.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L281
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:maxExecutions.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L281
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L307
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L367
PostResponseCodes 200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L383
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L421
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.App/preview/2024-02-02-preview/Jobs.json#L475
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️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?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Mar 15, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from 00d02f9f247bd07020dbd5c89187ae79cd69fa48. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]
    cmderr	[automation_generate.sh]  New minor version of npm available! 10.2.4 -> 10.5.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-appcontainers [View full logs]  [Preview SDK Changes]
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from 00d02f9f247bd07020dbd5c89187ae79cd69fa48. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh]  Current
    cmderr	[init.sh]                                  Dload  Upload   Total   Spent    Left  Speed
    cmderr	[init.sh] 
      0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     036k
    cmderr	[init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz...
    cmderr	[init.sh] Computing checksum with sha256sum
    cmderr	[init.sh] Checksums matched!
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-appcontainers [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 00d02f9f247bd07020dbd5c89187ae79cd69fa48. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/appcontainers/armappcontainers [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 00d02f9f247bd07020dbd5c89187ae79cd69fa48. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure/arm-appcontainers [View full logs]  [Preview SDK Changes]
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs] Generate from 00d02f9f247bd07020dbd5c89187ae79cd69fa48. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh] npm notice
    cmderr	[initScript.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[initScript.sh] npm notice
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
️️✔️ azure-powershell succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 00d02f9f247bd07020dbd5c89187ae79cd69fa48. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
  • ️✔️Az.app.DefaultTag [View full logs]  [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Mar 15, 2024

"triggerParameter"
]
},
"identity": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not blocking your change - Could this be moved to base definition and referenced for all scale rules

@Juliehzl
Copy link
Contributor

/pr RequestMerge

@ms-henglu ms-henglu merged commit 84a410a into Azure:release-app-Microsoft.App-2024-02-02-preview Mar 26, 2024
Juliehzl pushed a commit to Juliehzl/azure-rest-api-specs that referenced this pull request Jun 4, 2024
* Adding identity for scale rules

* fix scale example
mentat9 pushed a commit that referenced this pull request Jun 17, 2024
* Adds base for updating Microsoft.App from version preview/2023-11-02-preview to version 2024-02-02-preview

* Updates readme

* Updates API version in new specs and examples

* Functions Extension endpoint for Web RP (#27873)

* Functions extension api-spec commit

* merge with latest

* Functions Extension in 2024-02-02-preview

* correcetd version in readme

* avacado fail fix - version

* pattern addition

* fix for PathForResourceAction

* lint diff and model validation checks

* AutoRest exception fix

* endpoint response as string and not schema

* response schema with string

* example schema

* example within spec

* extension example with data

* extensions example with body

* body as string

* [Microsoft.App] add runtime attribute to app configuration (#27892)

* add configuration.runtime for apps

* Add Nacos For Java Component. (#28045)

* Add Nacos For Java Component.

* fix spell check.

* [Container Apps] Update Runtime to add DotNet support (#28001)

* [Container Apps] Update Runtime to add DotNet support

* Remove default value

* Rename dotNet to dotnet

* [Container Apps] Remove AspireResourceServerApi type for DotNetComponent (#28005)

* [Container Apps] Remove AspireResourceServerApi type for DotNetComponent

* Only keep changes to 2024-02-02-preview

* [ContainerApp] Support peer traffic encryption. (#28129)

* Make the JavaComponent definitions polymorphism and expose fqdn for sba and eureka (#28102)

* Make the JavaComponent definitions polymorphism

* fix api version

* revert error response change

* refine examples

* fix default value

* fix

* fix

* try to remove required

* try remove require in patch body

* fix

* try fix lint

* fix

* add suppression for discriminator

* fix

---------

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

* ContainerAppsBuild and ContainerAppsPatch API (#27982)

* Added CloudBuild and CloudPatch

* Fixed pipeline errors

* Added ContainerApp example

* Fixed typo in example

* Fixed linting error

* Fixed spacing

* Addressed comments

* Addressed comments and modified sample

* Fixed linting error

* Addressed comments

* Linting

* Fixed typo

* Fixed Typo

* Resolving model validation error

* [Microsoft.App] add java agent related properties (#28192)

* add java agent related properties

* fix build error

* fix format

* re-run pipeline

* update enum list and fix typo

* revert cspell config

* update level field type from enum to string

* add identifiers for array prop

* Fix error response for aca (#28425)

* fix

* fix

* Adding identity for scale rules (#28283)

* Adding identity for scale rules

* fix scale example

* Fix schema issue for Microsoft.App in 2024-02-02-preview (#28454)

* fix

* fix

* fix

* fix

* fix

* fix

* Update Container Apps Swagger Schema to include kind property  (#28405)

* Added support for KIND property to container apps schema

* added reference to example request schema

* prettier check

* changes to example conforming to swagger

* used enum for app kind

* minor fixes

* merged main

* Revert "merged main"

This reverts commit 2437d60.

* fixed checks

* Add detailed job execution to api (#27977)

* Add detailed job execution to api

* Add fields

* address comment

* add x-ms-identifiers

* prettier

* address comments

* Address comments

* Address comments

* update example

* Fix property name

* Fix example

* [Microsoft.App] optimize java agent related properties (#28573)

* optimize java agent related props

* fix

* adding logging property to include logger settings

---------

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

* Add accountName for queueScaler (#28672)

* add accountName for queueScaler

* updated example

* updated

* updated

* updated

* Adding identity settings (#28117)

* Adding identity settings

* fix casing in examples

* Switch to array since ARM doesn't allow dictionaries.

* identity property should be required.

* prettier

* Updating description

* Adding Jobs spec

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

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

* Move IdentitySettings to CommonDefinitions

---------

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

* Add SessionPools and Sessions (#28047)

* Add SessionPools.json and Sessions.json

* Add private endpoint connections for managed environment (#28775)

* add pe

* fix

* fix

* fix

* fix

* fix

* fix

* use v5

* fix

* fix

* Add support for SMB storage in connectedEnvironment (#29158)

* Add support for SMB storage in connectedEnvironment

* move smb properties to common

* fix reference

---------

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

* API spec for LogicApps extension on Microsoft.App (#29083)

* API spec for LogicApps extension on Microsoft.App

* format

* fix typos

* fix issues

* fix example references

* fix more issues

* fix issues

* fix more model validation

* fix

* fix model

* fix format

* fix lintdiff

* fix example

* fix headers

* add delete

* add missing file

---------

Co-authored-by: Anand G Menon <[email protected]>

* Add publicNetworkAccess in managed environment (#29092)

* fix

* fix

* fix example

* fix lint

* revert previous change for patch

* fix go sdk duplicate schema

* fix go sdk duplicate schema

* fix billing meter

* fix billing meter

---------

Co-authored-by: Jitin John <[email protected]>
Co-authored-by: SushmithaVReddy <[email protected]>
Co-authored-by: sonwan2020 <[email protected]>
Co-authored-by: Xiangyang Yu <[email protected]>
Co-authored-by: daniv-msft <[email protected]>
Co-authored-by: Xuyang Cao <[email protected]>
Co-authored-by: Xuyang Cao <[email protected]>
Co-authored-by: Harry Li <[email protected]>
Co-authored-by: Jimmy Fang <[email protected]>
Co-authored-by: Vaclav Turecek <[email protected]>
Co-authored-by: Shubham Sachdeva <[email protected]>
Co-authored-by: lihaMSFT <[email protected]>
Co-authored-by: Bowen Wan <[email protected]>
Co-authored-by: njucz <[email protected]>
Co-authored-by: yitaopan <[email protected]>
Co-authored-by: anandgmenon <[email protected]>
Co-authored-by: [email protected] <[email protected]>
@njuCZ njuCZ mentioned this pull request Dec 16, 2024
8 tasks
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.

7 participants