azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
[Hub Generated] Review request for Microsoft.ContainerInstance to add version stable/2022-09-01
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
- What's the purpose of the update?
- [ ] new service onboarding
- [x] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [x] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
Otherwise your PR may be subject to ARM review requirements. Complete the following:
-
[ ] Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
-
[ ] Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
-
[ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.
Hi, @fnuarnav Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 50 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.1)] | new version | base version |
|---|---|---|
| containerInstance.json | 2022-09-01(2d35226) | 2021-10-01(main) |
| containerInstance.json | 2022-09-01(2d35226) | 2018-02-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-09 | package-2022-09(2d35226) | default(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.ContainerInstance/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ContainerInstance/stable/2022-09-01/containerInstance.json#L424 |
|
The schema 'GitRepoVolume' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerInstance/stable/2022-09-01/containerInstance.json#L1146 |
|
The schema 'ContainerGroupIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerInstance/stable/2022-09-01/containerInstance.json#L1515 |
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerInstance/stable/2022-09-01/containerInstance.json#L2341 |
|
The schema 'CloudErrorBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerInstance/stable/2022-09-01/containerInstance.json#L2350 |
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: timestamps Location: Microsoft.ContainerInstance/stable/2022-09-01/containerInstance.json#L537 |
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: readOnly Location: Microsoft.ContainerInstance/stable/2022-09-01/containerInstance.json#L1120 |
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: readOnly Location: Microsoft.ContainerInstance/stable/2022-09-01/containerInstance.json#L1211 |
| :warning: R4009 - RequiredReadOnlySystemData | The response of operation:'ContainerGroups_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ContainerInstance/stable/2022-09-01/containerInstance.json#L114 |
| :warning: R4009 - RequiredReadOnlySystemData | The response of operation:'ContainerGroups_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ContainerInstance/stable/2022-09-01/containerInstance.json#L155 |
| :warning: R4009 - RequiredReadOnlySystemData | The response of operation:'ContainerGroups_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ContainerInstance/stable/2022-09-01/containerInstance.json#L215 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - sdk/resourcemanager/containerinstance/armcontainerinstance - 3.0.0+ Struct `CloudErrorBody` has been removed + Struct `CloudError` has been removed
️❌ azure-sdk-for-net-track2 failed [Detail]
❌Failed [Logs]Release - Generate from 7685d4cfce761cd0544afea9ab65992a701805ab. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json warn File azure-sdk-for-net_tmp/initOutput.json not found to read command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json cmderr [Invoke-GenerateAndBuildV2.ps1] [91mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:611 cmderr [Invoke-GenerateAndBuildV2.ps1] [96mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [96m 611 | [0m [96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [96m | [91m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [91m[96m | [91mFailed to build sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] [0m
❌Azure.ResourceManager.ContainerInstance [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Nullable<Azure.ResourceManager.ContainerInstance.Models.AutoGeneratedDomainNameLabelScope> Azure.ResourceManager.ContainerInstance.Models.ContainerGroupIPAddress.DnsNameLabelReusePolicy.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/containerinstance/Azure.ResourceManager.ContainerInstance/src/Azure.ResourceManager.ContainerInstance.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.ContainerInstance.Models.ContainerGroupIPAddress.DnsNameLabelReusePolicy.set(System.Nullable<Azure.ResourceManager.ContainerInstance.Models.AutoGeneratedDomainNameLabelScope>)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/containerinstance/Azure.ResourceManager.ContainerInstance/src/Azure.ResourceManager.ContainerInstance.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.ContainerInstance/Debug/netstandard2.0/Azure.ResourceManager.ContainerInstance.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/containerinstance/Azure.ResourceManager.ContainerInstance/src/Azure.ResourceManager.ContainerInstance.csproj]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from 7685d4cfce761cd0544afea9ab65992a701805ab. 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: 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] npm notice New patch version of npm available! 8.19.2 -> 8.19.3 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.3> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-containerinstance [View full logs] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Model ContainerGroup has a new parameter extensions info [Changelog] - Model ContainerGroupProperties has a new parameter extensions info [Changelog] - Model EncryptionProperties has a new parameter identity
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs]Release - Generate from 7685d4cfce761cd0544afea9ab65992a701805ab. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json warn No file changes detected after generation warn No package detected after generation
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 7685d4cfce761cd0544afea9ab65992a701805ab. 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/containerinstance/armcontainerinstance [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Struct `CloudError` has been removed info [Changelog] - Struct `CloudErrorBody` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New struct `DeploymentExtensionSpec` info [Changelog] - New struct `DeploymentExtensionSpecProperties` info [Changelog] - New field `Identity` in struct `EncryptionProperties` info [Changelog] - New field `Extensions` in struct `ContainerGroupPropertiesProperties` info [Changelog] info [Changelog] Total 4 breaking change(s), 6 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 7685d4cfce761cd0544afea9ab65992a701805ab. 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-containerinstance [View full logs] [Release SDK Changes]info [Changelog] **Features** info [Changelog] info [Changelog] - Added Interface DeploymentExtensionSpec info [Changelog] - Interface ContainerGroupProperties has a new optional parameter extensions info [Changelog] - Interface EncryptionProperties has a new optional parameter identity
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from 7685d4cfce761cd0544afea9ab65992a701805ab. 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 WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile 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
️✔️containerinstance [View full logs] [Release Schema Changes]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 7685d4cfce761cd0544afea9ab65992a701805ab. 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.ContainerInstance [View full logs] [Release SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/containerinstance/armcontainerinstance | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| Python | track2_azure-mgmt-containerinstance | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| .Net | Azure.ResourceManager.ContainerInstance | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| JavaScript | @azure/arm-containerinstance | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
Hi, @fnuarnav your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).