azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Microsoft.App - adding app space and app space resource to spec for new App Space resource(s)
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!
- [ ] New API version. (Such PR should have been generated with 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 swagger 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 Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
- If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:- The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
- You believe there is no need for you to request breaking change approval, for any reason. Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
- If this PR is in purview of ARM review then automation will add the
ARMReviewlabel. - If you want to force ARM review, add the label yourself.
- Proceed according to the diagram at the top of this comment.
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
- For general PR approval workflow, see the diagram at the top of this comment.
- For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- 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.
Next Steps to Merge
Next steps that must be taken to merge this PR:- ❌ Your PR has at least one change violating Azure versioning policy (label:
VersioningReviewRequired). You must introduce a new API version with these changes instead of modifying an existing one. See the PR description for help. - ❌ The required check named
Swagger ModelValidationhas failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 5 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| AppSpaceResources.json | 2023-08-01-preview(7a1cb98) | 2023-08-01-preview(main) |
| AppSpaces.json | 2023-08-01-preview(7a1cb98) | 2023-08-01-preview(main) |
| Rule | Message |
|---|---|
|
The new version is adding a path that was not found in the old version. New: Microsoft.App/preview/2023-08-01-preview/AppSpaceResources.json#L18:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.App/preview/2023-08-01-preview/AppSpaceResources.json#L68:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.App/preview/2023-08-01-preview/AppSpaces.json#L18:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.App/preview/2023-08-01-preview/AppSpaces.json#L57:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.App/preview/2023-08-01-preview/AppSpaces.json#L99:5 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 2 Errors, 39 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-preview-2023-08 | package-preview-2023-08(7a1cb98) | package-preview-2023-08(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 16 Errors, 0 Warnings failed [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=397416&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - sdk/resourcemanager/appcontainers/armappcontainers - 3.0.0-beta.1- Field `EndTime`, `StartTime`, `Status`, `Template` of struct `JobExecution` has been removed + Function `*timeRFC3339.Parse` has been removed + Function `*timeRFC3339.UnmarshalText` has been removed + Function `timeRFC3339.MarshalText` has been removed
️❌ azure-sdk-for-python-track2 failed [Detail]
❌Code Generator Failed [Logs] Generate from 2de82b1c4707fa6bf868cfc8aca8d055a03a9009. SDK Automation 14.0.0command 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] npm notice cmderr [automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.3 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.3> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice cmdout [automation_generate.sh] [Autorest] error | DuplicateOperation | Duplicate Operation 'AppSpaces' > 'listby_resourcegroup' detected(This is most likely due to 2 operation using the same 'operationId' or 'tags'). Duplicates have those paths: cmdout [automation_generate.sh] [Autorest] - get /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/appSpaces/{appSpaceName}/spaceResources cmdout [automation_generate.sh] [Autorest] - get /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/appSpaces cmdout [automation_generate.sh] [Autorest] fatal | Error: 1 errors occured -- cannot continue. cmdout [automation_generate.sh] [Autorest] fatal | Process() cancelled due to failure cmdout [automation_generate.sh] [Autorest] error | Error: Plugin checker reported failure. cmdout [automation_generate.sh] [Autorest] error | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing. cmdout [automation_generate.sh] [Autorest] error | DuplicateOperation | Duplicate Operation 'AppSpaces' > 'listby_resourcegroup' detected(This is most likely due to 2 operation using the same 'operationId' or 'tags'). Duplicates have those paths: cmdout [automation_generate.sh] [Autorest] - get /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/appSpaces/{appSpaceName}/spaceResources cmdout [automation_generate.sh] [Autorest] - get /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/appSpaces cmdout [automation_generate.sh] [Autorest] fatal | Error: 1 errors occured -- cannot continue. cmdout [automation_generate.sh] [Autorest] fatal | Process() cancelled due to failure cmdout [automation_generate.sh] [Autorest] error | Error: Plugin checker reported failure. cmdout [automation_generate.sh] [Autorest] error | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing. cmdout [automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh warn Skip package processing as generation is failed
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from 2de82b1c4707fa6bf868cfc8aca8d055a03a9009. SDK Automation 14.0.0command ./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 -> 23.3.1 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 -> 23.3.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip 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 failed [Detail]
❌Code Generator Failed [Logs] Generate from 2de82b1c4707fa6bf868cfc8aca8d055a03a9009. SDK Automation 14.0.0command 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 cmderr [generator automation-v2] [ERROR] total 1 error(s): cmderr [generator automation-v2] [ERROR] failed to execute `go generate` '[33;1mWARNING: Unable to find version for /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers[0m cmderr [generator automation-v2] [ERROR] Cannot find go module under resourcemanager/appcontainers/armappcontainers, try to build in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers cmderr [generator automation-v2] [ERROR] ##[command]Cleaning auto-generated files in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers cmderr [generator automation-v2] [ERROR] ##[command]Executing autorest.go in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers cmderr [generator automation-v2] [ERROR] autorest --use=@autorest/[email protected] --go --track2 --output-folder=/mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers --clear-output-folder=false --go.clear-output-folder=false --honor-body-placement=true --remove-unreferenced-types=false ./autorest.md cmderr [generator automation-v2] [ERROR] AutoRest code generation utility [cli version: 3.6.1; node: v16.20.2] cmderr [generator automation-v2] [ERROR] (C) 2018 Microsoft Corporation. cmderr [generator automation-v2] [ERROR] https://aka.ms/autorest cmderr [generator automation-v2] [ERROR] There is a new version of AutoRest available (3.6.3). cmderr [generator automation-v2] [ERROR] > You can install the newer version with with npm install -g autorest@latest cmderr [generator automation-v2] [ERROR] info | Loading AutoRest core '/home/cloudtest/.autorest/@[email protected]/nodemodules/@autorest/core/dist' (3.9.7) cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and will be removed in the future. cmderr [generator automation-v2] [ERROR] info | Installing AutoRest extension '@autorest/go' (4.0.0-preview.60 -> 4.0.0-preview.60) cmderr [generator automation-v2] [ERROR] info | Installed AutoRest extension '@autorest/go' (4.0.0-preview.60->4.0.0-preview.60) cmderr [generator automation-v2] [ERROR] info | Installing AutoRest extension '@autorest/modelerfour' (4.26.2 -> 4.26.2) cmderr [generator automation-v2] [ERROR] info | Installed AutoRest extension '@autorest/modelerfour' (4.26.2->4.26.2) cmderr [generator automation-v2] [ERROR] warning | IgnoredPropertyNextToRef | Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > DaprComponentServiceBinding > properties > metadata) cmderr [generator automation-v2] [ERROR] keys: [ [32m'type'[39m ] cmderr [generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/CommonDefinitions.json:832:9 cmderr [generator automation-v2] [ERROR] warning | IgnoredPropertyNextToRef | Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > Resource > properties > systemData) cmderr [generator automation-v2] [ERROR] keys: [ [32m'type'[39m ] cmderr [generator automation-v2] [ERROR] warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. cmderr [generator automation-v2] [ERROR] warning | UsingTemporaryFlag | modelerfour.treat-type-object-as-anything options is a temporary flag. It WILL be removed in the future. cmderr [generator automation-v2] [ERROR] warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used. cmderr [generator automation-v2] [ERROR] error | DuplicateOperation | Duplicate Operation 'AppSpaces' > 'ListByResourceGroup' detected(This is most likely due to 2 operation using the same 'operationId' or 'tags'). Duplicates have those paths: cmderr [generator automation-v2] [ERROR] - get /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/appSpaces/{appSpaceName}/spaceResources cmderr [generator automation-v2] [ERROR] - get /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/appSpaces cmderr [generator automation-v2] [ERROR] fatal | Error: 1 errors occured -- cannot continue. cmderr [generator automation-v2] [ERROR] fatal | Process() cancelled due to failure cmderr [generator automation-v2] [ERROR] error | Error: Plugin checker reported failure. cmderr [generator automation-v2] [ERROR] error | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing. cmderr [generator automation-v2] [ERROR] ##[error]Error running autorest.go cmderr [generator automation-v2] [ERROR] build.go:5: running "pwsh": exit status 1 cmderr [generator automation-v2] [ERROR] ': exit status 1 error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation-v2 warn Skip package processing as generation is failed
️🔄 azure-sdk-for-js inProgress [Detail]
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs] Generate from 2de82b1c4707fa6bf868cfc8aca8d055a03a9009. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] cmderr [initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.3 cmderr [initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.3> 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
️✔️app [View full logs] [Preview Schema Changes]
️❌ azure-powershell failed [Detail]
❌Pipeline Framework Failed [Logs] Generate from 2de82b1c4707fa6bf868cfc8aca8d055a03a9009. SDK Automation 14.0.0command 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 SSL error: syscall failure: Broken pipe Error: SSL error: syscall failure: Broken pipe
️✔️Az.app.DefaultTag [View full logs]error Fatal error: SSL error: syscall failure: Broken pipe error The following packages are still pending: error Az.app.DefaultTag
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | Microsoft.App | https://apiview.dev/Assemblies/Review/6908c438f01f4b938259ac76707d98bb |
Please complete PR template and due diligence sections if continuing with this PR
