azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Microsoft.App - adding space and space resource to spec for new App Space resource types
…1-02-preview for Microsoft.App
ARM (Control Plane) API Specification Update Pull Request
[!TIP] Overwhelmed by all this guidance? See the
Getting helpsection 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.
Click here to see the details of Step 1
Breaking changes review (Diagram 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.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
- For help with 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).
- [x] 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:
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
- [x] 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 PRandDue diligence checklist. - To understand what you must do next to merge this PR, see the
Next Steps to Mergecomment. 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
queuedstate, please add a comment with contents/azp run. This should result in a new comment denoting aPR validation pipelinehas 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.
Next Steps to Merge
✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.![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.5)] | new version | base version |
|---|---|---|
| AppSpaceResources.json | 2023-11-02-preview(140e739) | 2023-11-02-preview(main) |
| AppSpaces.json | 2023-11-02-preview(140e739) | 2023-11-02-preview(main) |
| Rule | Message |
|---|---|
|
The new version is adding a path that was not found in the old version. New: Microsoft.App/preview/2023-11-02-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-11-02-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-11-02-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-11-02-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-11-02-preview/AppSpaces.json#L99:5 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 2 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.7) | new version | base version |
|---|---|---|
| package-preview-2023-11 | package-preview-2023-11(140e739) | package-preview-2023-11(release-app-Microsoft.App-2023-11-02-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: MissingSegmentsInNestedResourceListOperation | A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.App/preview/2023-11-02-preview/AppSpaceResources.json#L18 |
RPC-Get-V1-11 |
| :warning: XmsIdentifierValidation | Missing identifier id in array item property Location: Microsoft.App/preview/2023-11-02-preview/AppSpaceResources.json#L388 |
️️✔️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]
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 7588bc97979493a05e3987fa4560fe8a51673dba. 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
️✔️track2_azure-mgmt-appcontainers [View full logs] [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation ContainerAppsAPIClientOperationsMixin.get_custom_domain_verification_id info [Changelog] - Added operation JobsOperations.get_detector info [Changelog] - Added operation JobsOperations.list_detectors info [Changelog] - Added operation JobsOperations.proxy_get info [Changelog] - Added operation group AppResiliencyOperations info [Changelog] - Added operation group AppSpaceResourcesOperations info [Changelog] - Added operation group AppSpacesOperations info [Changelog] - Added operation group BuildAuthTokenOperations info [Changelog] - Added operation group BuildersOperations info [Changelog] - Added operation group BuildsByBuilderResourceOperations info [Changelog] - Added operation group BuildsOperations info [Changelog] - Added operation group DaprComponentResiliencyPoliciesOperations info [Changelog] - Added operation group DaprSubscriptionsOperations info [Changelog] - Added operation group DotNetComponentsOperations info [Changelog] - Added operation group JavaComponentsOperations info [Changelog] - Added operation group ManagedEnvironmentUsagesOperations info [Changelog] - Added operation group UsagesOperations info [Changelog] - Model AuthConfig has a new parameter encryption_settings info [Changelog] - Model AvailableWorkloadProfileProperties has a new parameter gpus info [Changelog] - Model CertificateProperties has a new parameter certificate_key_vault_properties info [Changelog] - Model CertificateProperties has a new parameter certificate_type info [Changelog] - Model CustomDomainConfiguration has a new parameter certificate_key_vault_properties info [Changelog] - Model DaprComponent has a new parameter service_component_bind info [Changelog] - Model GithubActionConfiguration has a new parameter build_environment_variables info [Changelog] - Model Ingress has a new parameter additional_port_mappings info [Changelog] - Model Ingress has a new parameter target_port_http_scheme info [Changelog] - Model Job has a new parameter extended_location info [Changelog] - Model JobPatchProperties has a new parameter extended_location info [Changelog] - Model LogAnalyticsConfiguration has a new parameter dynamic_json_columns info [Changelog] - Model Login has a new parameter token_store info [Changelog] - Model ManagedEnvironment has a new parameter app_insights_configuration info [Changelog] - Model ManagedEnvironment has a new parameter identity info [Changelog] - Model ManagedEnvironment has a new parameter open_telemetry_configuration info [Changelog] - Model ManagedEnvironmentStorageProperties has a new parameter nfs_azure_file info [Changelog] - Model ServiceBind has a new parameter client_type info [Changelog] - Model ServiceBind has a new parameter customized_keys
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from 7588bc97979493a05e3987fa4560fe8a51673dba. 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 -> 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] e Time Time Current cmderr [init.sh] Dload Upload Total Spent Left Speed cmderr [init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz... cmderr [init.sh] ################### 100.0% cmderr [init.sh] Computing checksum with sha256sum cmderr [init.sh] Checksums matched! cmderr [init.sh] notice cmderr [init.sh] npm notice New major version of npm available! 9.5.0 -> 10.4.0 cmderr [init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.0> cmderr [init.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [init.sh] npm notice 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 7588bc97979493a05e3987fa4560fe8a51673dba. 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
️✔️sdk/resourcemanager/appcontainers/armappcontainers [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 7588bc97979493a05e3987fa4560fe8a51673dba. SDK Automation 14.0.0command 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 7588bc97979493a05e3987fa4560fe8a51673dba. 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] npm notice cmderr [initScript.sh] npm notice New minor version of npm available! 10.2.4 -> 10.4.0 cmderr [initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.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
️✔️app [View full logs] [Preview Schema Changes]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 7588bc97979493a05e3987fa4560fe8a51673dba. 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
️✔️Az.app.DefaultTag [View full logs] [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/appcontainers/armappcontainers | https://apiview.dev/Assemblies/Review/c5375c6f5a4443168e64c981277b8377?revisionId=5540aea493c744e4b6805c05481e17c8 |
| Java | azure-resourcemanager-appcontainers | https://apiview.dev/Assemblies/Review/7da9ac1e2db64477ada2ba8bbb71169b?revisionId=b754aff7be4f400698f93065996ea584 |
| JavaScript | @azure/arm-appcontainers | https://apiview.dev/Assemblies/Review/ba41cd9978b542efb0688a072b2319a1?revisionId=878ca0acf50a4448abf95211a197ad3f |
| Swagger | Microsoft.App | https://apiview.dev/Assemblies/Review/53999dbad23b45cba7812a00a713cab8?revisionId=529ba36418d048a5a556e3172db0423e |
Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Commenter does not have sufficient privileges for PR 27483 in repo Azure/azure-rest-api-specs
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @reillyanderson. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
![microsoft-github-policy-service[bot] avatar](https://avatars.githubusercontent.com/in/95686?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @reillyanderson. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.