azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[s360 fix] add default value to $.properties.template.scale.maxReplicas
to fix https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=CCE1B9E9-6969-430D-A682-03A86292EDFD
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. 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
- [ ] 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):
- [ ] I commit to follow the Breaking Change Policy of "no breaking changes"
- [ ] I have reviewed the documentation for the workflow.
- [ ] 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, @najian 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: 2 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.1)] | new version | base version |
|---|---|---|
| CommonDefinitions.json | 2022-01-01-preview(62dabaa) | 2022-01-01-preview(main) |
| CommonDefinitions.json | 2022-06-01-preview(62dabaa) | 2022-06-01-preview(main) |
| Rule | Message |
|---|---|
|
The new version has a different default value than the previous one. New: Microsoft.App/preview/2022-01-01-preview/CommonDefinitions.json#L391:9 Old: Microsoft.App/preview/2022-01-01-preview/CommonDefinitions.json#L391:9 |
|
The new version has a different default value than the previous one. New: Microsoft.App/preview/2022-06-01-preview/CommonDefinitions.json#L485:9 Old: Microsoft.App/preview/2022-06-01-preview/CommonDefinitions.json#L485:9 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️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-01-01-preview | package-2022-01-01-preview(62dabaa) | package-2022-01-01-preview(main) |
| package-preview-2022-06 | package-preview-2022-06(62dabaa) | package-preview-2022-06(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| :warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-06-01-preview/CommonDefinitions.json#L852 |
| :warning: R2015 - ParameterNotDefinedInGlobalParameters | Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-01-01-preview/CommonDefinitions.json#L1 |
| :warning: R2015 - ParameterNotDefinedInGlobalParameters | Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-06-01-preview/CommonDefinitions.json#L1 |
| :warning: R3010 - TrackedResourceListByImmediateParent | The child tracked resource, 'daprComponents' with immediate parent 'ManagedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-06-01-preview/CommonDefinitions.json#L667 |
| :warning: R3010 - TrackedResourceListByImmediateParent | The child tracked resource, 'daprComponents' with immediate parent 'ConnectedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-06-01-preview/CommonDefinitions.json#L667 |
| :warning: R3010 - TrackedResourceListByImmediateParent | The child tracked resource, 'certificates' with immediate parent 'ManagedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-06-01-preview/CommonDefinitions.json#L843 |
| :warning: R3010 - TrackedResourceListByImmediateParent | The child tracked resource, 'certificates' with immediate parent 'ConnectedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-06-01-preview/CommonDefinitions.json#L843 |
️️✔️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.
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from cfbc5f06546b1cd970ecf07e1cf138b11ed5efcf. 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] npm notice 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-appcontainers [View full logs] [Release SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs]Release - Generate from cfbc5f06546b1cd970ecf07e1cf138b11ed5efcf. 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 available: 22.3 -> 22.3.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip available: 22.3 -> 22.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 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 cfbc5f06546b1cd970ecf07e1cf138b11ed5efcf. 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] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - New anonymous field `ManagedEnvironment` in struct `ManagedEnvironmentsClientUpdateResponse` info [Changelog] - New anonymous field `ContainerApp` in struct `ContainerAppsClientUpdateResponse` info [Changelog] info [Changelog] Total 0 breaking change(s), 2 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from cfbc5f06546b1cd970ecf07e1cf138b11ed5efcf. 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
- Only show 120 items here, please refer to log for details.
️✔️@azure/arm-appcontainers [View full logs] [Release SDK Changes]info [Changelog] - Added Interface DiagnosticDataTableResponseObject info [Changelog] - Added Interface DiagnosticRendering info [Changelog] - Added Interface Diagnostics info [Changelog] - Added Interface DiagnosticsCollection info [Changelog] - Added Interface DiagnosticsDataApiResponse info [Changelog] - Added Interface DiagnosticsDefinition info [Changelog] - Added Interface DiagnosticsProperties info [Changelog] - Added Interface DiagnosticsStatus info [Changelog] - Added Interface DiagnosticSupportTopic info [Changelog] - Added Interface EnvironmentAuthToken info [Changelog] - Added Interface EnvironmentSkuProperties info [Changelog] - Added Interface ErrorAdditionalInfo info [Changelog] - Added Interface ErrorDetail info [Changelog] - Added Interface ErrorResponse info [Changelog] - Added Interface ExtendedLocation info [Changelog] - Added Interface InitContainer info [Changelog] - Added Interface IpSecurityRestrictionRule info [Changelog] - Added Interface ManagedEnvironmentDiagnosticsGetDetectorOptionalParams info [Changelog] - Added Interface ManagedEnvironmentDiagnosticsListDetectorsOptionalParams info [Changelog] - Added Interface ManagedEnvironmentOutboundSettings info [Changelog] - Added Interface ManagedEnvironmentsDiagnosticsGetRootOptionalParams info [Changelog] - Added Interface ManagedEnvironmentsGetAuthTokenOptionalParams info [Changelog] - Added Interface ManagedEnvironmentsListWorkloadProfileStatesNextOptionalParams info [Changelog] - Added Interface ManagedEnvironmentsListWorkloadProfileStatesOptionalParams info [Changelog] - Added Interface TcpScaleRule info [Changelog] - Added Interface WorkloadProfile info [Changelog] - Added Interface WorkloadProfileStates info [Changelog] - Added Interface WorkloadProfileStatesCollection info [Changelog] - Added Interface WorkloadProfileStatesProperties info [Changelog] - Added Type Alias Action info [Changelog] - Added Type Alias Applicability info [Changelog] - Added Type Alias AvailableWorkloadProfilesGetNextResponse info [Changelog] - Added Type Alias AvailableWorkloadProfilesGetResponse info [Changelog] - Added Type Alias BillingMetersGetResponse info [Changelog] - Added Type Alias Category info [Changelog] - Added Type Alias ConnectedEnvironmentProvisioningState info [Changelog] - Added Type Alias ConnectedEnvironmentsCertificatesCreateOrUpdateResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsCertificatesGetResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsCertificatesListNextResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsCertificatesListResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsCertificatesUpdateResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsCheckNameAvailabilityResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsCreateOrUpdateResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsDaprComponentsCreateOrUpdateResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsDaprComponentsGetResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsDaprComponentsListNextResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsDaprComponentsListResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsDaprComponentsListSecretsResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsGetResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsListByResourceGroupNextResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsListByResourceGroupResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsListBySubscriptionNextResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsListBySubscriptionResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsStoragesCreateOrUpdateResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsStoragesGetResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsStoragesListResponse info [Changelog] - Added Type Alias ConnectedEnvironmentsUpdateResponse info [Changelog] - Added Type Alias ContainerAppsDiagnosticsGetDetectorResponse info [Changelog] - Added Type Alias ContainerAppsDiagnosticsGetRevisionResponse info [Changelog] - Added Type Alias ContainerAppsDiagnosticsGetRootResponse info [Changelog] - Added Type Alias ContainerAppsDiagnosticsListDetectorsNextResponse info [Changelog] - Added Type Alias ContainerAppsDiagnosticsListDetectorsResponse info [Changelog] - Added Type Alias ContainerAppsDiagnosticsListRevisionsNextResponse info [Changelog] - Added Type Alias ContainerAppsDiagnosticsListRevisionsResponse info [Changelog] - Added Type Alias ContainerAppsGetAuthTokenResponse info [Changelog] - Added Type Alias ContainerAppsUpdateResponse info [Changelog] - Added Type Alias ExtendedLocationTypes info [Changelog] - Added Type Alias LogLevel info [Changelog] - Added Type Alias ManagedEnvironmentDiagnosticsGetDetectorResponse info [Changelog] - Added Type Alias ManagedEnvironmentDiagnosticsListDetectorsResponse info [Changelog] - Added Type Alias ManagedEnvironmentOutBoundType info [Changelog] - Added Type Alias ManagedEnvironmentsDiagnosticsGetRootResponse info [Changelog] - Added Type Alias ManagedEnvironmentsGetAuthTokenResponse info [Changelog] - Added Type Alias ManagedEnvironmentsListWorkloadProfileStatesNextResponse info [Changelog] - Added Type Alias ManagedEnvironmentsListWorkloadProfileStatesResponse info [Changelog] - Added Type Alias ManagedEnvironmentsUpdateResponse info [Changelog] - Added Type Alias SkuName info [Changelog] - Interface CertificateProperties has a new optional parameter subjectAlternativeNames info [Changelog] - Interface Configuration has a new optional parameter maxInactiveRevisions info [Changelog] - Interface ContainerApp has a new optional parameter environmentId info [Changelog] - Interface ContainerApp has a new optional parameter eventStreamEndpoint info [Changelog] - Interface ContainerApp has a new optional parameter extendedLocation info [Changelog] - Interface ContainerApp has a new optional parameter workloadProfileType info [Changelog] - Interface CustomHostnameAnalysisResult has a new optional parameter conflictWithEnvironmentCustomDomain info [Changelog] - Interface Dapr has a new optional parameter enableApiLogging info [Changelog] - Interface Dapr has a new optional parameter httpMaxRequestSize info [Changelog] - Interface Dapr has a new optional parameter httpReadBufferSize info [Changelog] - Interface Dapr has a new optional parameter logLevel info [Changelog] - Interface DaprComponent has a new optional parameter secretStoreComponent info [Changelog] - Interface Ingress has a new optional parameter exposedPort info [Changelog] - Interface Ingress has a new optional parameter ipSecurityRestrictions info [Changelog] - Interface ManagedEnvironment has a new optional parameter customDomainConfiguration info [Changelog] - Interface ManagedEnvironment has a new optional parameter eventStreamEndpoint info [Changelog] - Interface ManagedEnvironment has a new optional parameter sku info [Changelog] - Interface ManagedEnvironment has a new optional parameter workloadProfiles info [Changelog] - Interface ReplicaContainer has a new optional parameter execEndpoint info [Changelog] - Interface ReplicaContainer has a new optional parameter logStreamEndpoint info [Changelog] - Interface Revision has a new optional parameter lastActiveTime info [Changelog] - Interface ScaleRule has a new optional parameter tcp info [Changelog] - Interface Template has a new optional parameter initContainers info [Changelog] - Interface VnetConfiguration has a new optional parameter outboundSettings info [Changelog] - Class ContainerAppsAPIClient has a new parameter availableWorkloadProfiles info [Changelog] - Class ContainerAppsAPIClient has a new parameter billingMeters info [Changelog] - Class ContainerAppsAPIClient has a new parameter connectedEnvironments info [Changelog] - Class ContainerAppsAPIClient has a new parameter connectedEnvironmentsCertificates info [Changelog] - Class ContainerAppsAPIClient has a new parameter connectedEnvironmentsDaprComponents info [Changelog] - Class ContainerAppsAPIClient has a new parameter connectedEnvironmentsStorages info [Changelog] - Class ContainerAppsAPIClient has a new parameter containerAppsDiagnostics info [Changelog] - Class ContainerAppsAPIClient has a new parameter managedEnvironmentDiagnostics info [Changelog] - Class ContainerAppsAPIClient has a new parameter managedEnvironmentsDiagnostics info [Changelog] - Added Enum KnownAction info [Changelog] - Added Enum KnownApplicability info [Changelog] - Added Enum KnownCategory info [Changelog] - Added Enum KnownConnectedEnvironmentProvisioningState info [Changelog] - Added Enum KnownExtendedLocationTypes info [Changelog] - Added Enum KnownLogLevel info [Changelog] - Added Enum KnownManagedEnvironmentOutBoundType info [Changelog] - Added Enum KnownSkuName info [Changelog] - Enum KnownContainerAppProvisioningState has a new value Deleting info [Changelog] - Enum KnownIngressTransportMethod has a new value Tcp
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from cfbc5f06546b1cd970ecf07e1cf138b11ed5efcf. 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] WARN old lockfile 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
️✔️app [View full logs] [Release Schema Changes]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from cfbc5f06546b1cd970ecf07e1cf138b11ed5efcf. 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.ContainerAppsApi [View full logs] [Release SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/appcontainers/armappcontainers | https://apiview.dev/Assemblies/Review/57c59f26d3d64b5cac33face64f0ebf1 |
| Python | track2_azure-mgmt-appcontainers | https://apiview.dev/Assemblies/Review/46f94baae04947d39f22b3ca4178ddac |
| JavaScript | @azure/arm-appcontainers | https://apiview.dev/Assemblies/Review/8637e65e317e4cd39bd56eddedd15bbb |
Hi @najian, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.