azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[CDN][2024-02-01] Refactor the inheritance hierarchy for rule actions and conditions to fix Pandora SDK const conflict
… and conditions to fix Pandora SDK const conflict
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.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
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 created in adherence to OpenAPI specs PR creation guidance).
- [ ] 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.
- [x] Other, please clarify:
- Our existing swagger definition does not follow the best practice of polymorphism to define class inheritance hierarchy, a hard-coded property (typeName) with a single ENUM value is used in a lot of places for deserialization purpose. It will break the Hashicorp Pandora SDK generation which will impact Terraform integration for Azure Front Door Standard/Premium service. In our case, with so many ENUMs with the same name “typeName”, it will complain about const name conflict when generating Golang SDK: https://github.com/hashicorp/pandora/issues/2831. Azure SDK Track2 for Golang does not have the problem as they did some workaround to add prefixes when the name is conflicting, which is not recommended by Pandora team. This PR aims to refactor the inheritance hierarchy for rule actions/conditions to fix Pandora SDK const conflict.
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. - If you don't have permissions to remove or add labels to the PR, request
write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories - 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 ARM review (PR workflow diagram Step 2), 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: 72 Errors, 59 Warnings failed [Detail]
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| cdn.json | 2024-02-01(34acb48) | 2024-02-01(main) |
Only 23 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The new version is adding enum value(s) 'DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3825:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3872:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3926:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3980:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4038:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4092:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4150:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4204:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4249:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4304:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4358:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4412:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4457:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4515:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4565:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4612:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleHostNameConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4667:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleSslProtocolConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4722:9 |
|
The new version is adding enum value(s) 'DeliveryRuleRemoteAddressConditionParameters, DeliveryRuleRequestMethodConditionParameters, DeliveryRuleQueryStringConditionParameters, DeliveryRulePostArgsConditionParameters, DeliveryRuleRequestUriConditionParameters, DeliveryRuleRequestHeaderConditionParameters, DeliveryRuleRequestBodyConditionParameters, DeliveryRuleRequestSchemeConditionParameters, DeliveryRuleUrlPathMatchConditionParameters, DeliveryRuleUrlFileExtensionMatchConditionParameters, DeliveryRuleUrlFilenameConditionParameters, DeliveryRuleHttpVersionConditionParameters, DeliveryRuleCookiesConditionParameters, DeliveryRuleIsDeviceConditionParameters, DeliveryRuleSocketAddrConditionParameters, DeliveryRuleClientPortConditionParameters, DeliveryRuleServerPortConditionParameters, DeliveryRuleHostNameConditionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3167:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4777:9 |
|
The new version is adding enum value(s) 'DeliveryRuleUrlSigningActionParameters, DeliveryRuleOriginGroupOverrideActionParameters, DeliveryRuleUrlRewriteActionParameters, DeliveryRuleHeaderActionParameters, DeliveryRuleCacheExpirationActionParameters, DeliveryRuleCacheKeyQueryStringBehaviorActionParameters, DeliveryRuleRouteConfigurationOverrideActionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3205:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4868:9 |
|
The new version is adding enum value(s) 'DeliveryRuleUrlRedirectActionParameters, DeliveryRuleOriginGroupOverrideActionParameters, DeliveryRuleUrlRewriteActionParameters, DeliveryRuleHeaderActionParameters, DeliveryRuleCacheExpirationActionParameters, DeliveryRuleCacheKeyQueryStringBehaviorActionParameters, DeliveryRuleRouteConfigurationOverrideActionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3205:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L4943:9 |
|
The new version is adding enum value(s) 'DeliveryRuleUrlRedirectActionParameters, DeliveryRuleUrlSigningActionParameters, DeliveryRuleUrlRewriteActionParameters, DeliveryRuleHeaderActionParameters, DeliveryRuleCacheExpirationActionParameters, DeliveryRuleCacheKeyQueryStringBehaviorActionParameters, DeliveryRuleRouteConfigurationOverrideActionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3205:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L5023:9 |
|
The new version is adding enum value(s) 'DeliveryRuleUrlRedirectActionParameters, DeliveryRuleUrlSigningActionParameters, DeliveryRuleOriginGroupOverrideActionParameters, DeliveryRuleHeaderActionParameters, DeliveryRuleCacheExpirationActionParameters, DeliveryRuleCacheKeyQueryStringBehaviorActionParameters, DeliveryRuleRouteConfigurationOverrideActionParameters' from the old version. New: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3205:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L5062: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 specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-02 | package-2024-02(34acb48) | package-2024-02(main) |
The following errors/warnings exist before current PR submission:
Only 23 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L118 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L163 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L228 |
|
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L261 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L293 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L299 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L346 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L403 |
|
202 response for a LRO POST operation must not have a response schema specified. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L414 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L466 |
|
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L476 |
|
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.Cdn/stable/2024-02-01/cdn.json#L477 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L521 |
|
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L531 |
|
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L577 |
|
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L623 |
|
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L672 |
|
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L721 |
|
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L721 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L773 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L845 |
|
Properties of a PATCH request body must not have default value, property:isHttpAllowed. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L885 |
|
Properties of a PATCH request body must not have default value, property:isHttpsAllowed. Location: Microsoft.Cdn/stable/2024-02-01/cdn.json#L885 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 27 Errors, 0 Warnings failed [Detail]
Only 23 items are listed, please refer to log for more details.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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=440419&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
️⚠️ azure-sdk-for-python warning [Detail]
- For more instructions, please refer to the FAQ .
⚠️Warning in generating from 6f8b00af3da9ed27bfd06b09f4c8c977b9e5435f. 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] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. cmderr [automation_init.sh] npm notice cmderr [automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.2 cmderr [automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.2 cmderr [automation_init.sh] npm notice To update run: npm install -g [email protected] cmderr [automation_init.sh] npm notice command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
️✔️azure-mgmt-cdn [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Added model CertificateSourceParameters info [Changelog] - Added model CertificateSourceParametersType info [Changelog] - Added model DeliveryRuleActionParameters info [Changelog] - Added model DeliveryRuleActionParametersType info [Changelog] - Added model DeliveryRuleConditionParameters info [Changelog] - Added model DeliveryRuleConditionParametersType info [Changelog] - Added model IsDeviceMatchValue info [Changelog] - Added model KeyVaultSigningKeyParametersType info [Changelog] - Added model RequestMethodMatchValue info [Changelog] - Added model RequestSchemeMatchValue
️❌ azure-sdk-for-java failed [Detail]
- For more instructions, please refer to the FAQ .
❌Code Generator Failed in generating from 6f8b00af3da9ed27bfd06b09f4c8c977b9e5435f. SDK Automation 14.0.0command ./eng/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json cmdout [Java-Sdk-Automation] [ERROR] COMPILATION ERROR : cmdout [Java-Sdk-Automation] [ERROR] /mnt/vss/_work/1/s/azure-sdk-for-java/sdk/cdn/azure-resourcemanager-cdn-generated/src/main/java/com/azure/resourcemanager/cdn/generated/models/PolicySettings.java:[178,60] cannot find symbol cmdout [Java-Sdk-Automation] [ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.13.0:compile (default-compile) on project azure-resourcemanager-cdn-generated: Compilation failure cmdout [Java-Sdk-Automation] [ERROR] /mnt/vss/_work/1/s/azure-sdk-for-java/sdk/cdn/azure-resourcemanager-cdn-generated/src/main/java/com/azure/resourcemanager/cdn/generated/models/PolicySettings.java:[178,60] cannot find symbol cmdout [Java-Sdk-Automation] [ERROR] symbol: method toInt() cmdout [Java-Sdk-Automation] [ERROR] location: variable defaultCustomBlockResponseStatusCode of type com.azure.resourcemanager.cdn.generated.models.PolicySettingsDefaultCustomBlockResponseStatusCode cmdout [Java-Sdk-Automation] [ERROR] cmdout [Java-Sdk-Automation] [ERROR] -> [Help 1] cmdout [Java-Sdk-Automation] [ERROR] cmdout [Java-Sdk-Automation] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch. cmdout [Java-Sdk-Automation] [ERROR] Re-run Maven using the -X switch to enable full debug logging. cmdout [Java-Sdk-Automation] [ERROR] cmdout [Java-Sdk-Automation] [ERROR] For more information about the errors and possible solutions, please read the following articles: cmdout [Java-Sdk-Automation] [ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException cmdout [Java-Sdk-Automation] [ERROR] cmdout [Java-Sdk-Automation] [ERROR] After correcting the problems, you can resume the build with the command cmdout [Java-Sdk-Automation] [ERROR] mvn <args> -rf :azure-resourcemanager-cdn-generated cmdout [Java-Sdk-Automation] 2024-07-22 06:17:00 [ERROR] [COMPILE] Maven build fail. cmdout [Java-Sdk-Automation] 2024-07-22 06:17:00 [ERROR] You can inquire in "Language - Java" Teams channel. Please include the link of this Pull Request in the query. cmderr [Java-Sdk-Automation] Traceback (most recent call last): cmderr [Java-Sdk-Automation] File "/mnt/vss/_work/1/s/azure-sdk-for-java/./eng/automation/generate.py", line 429, in <module> cmderr [Java-Sdk-Automation] main() cmderr [Java-Sdk-Automation] File "/mnt/vss/_work/1/s/azure-sdk-for-java/./eng/automation/generate.py", line 340, in main cmderr [Java-Sdk-Automation] return sdk_automation(args["config"][0], args["config"][1]) cmderr [Java-Sdk-Automation] File "/mnt/vss/_work/1/s/azure-sdk-for-java/./eng/automation/generate.py", line 118, in sdk_automation cmderr [Java-Sdk-Automation] packages = sdk_automation_autorest(config) cmderr [Java-Sdk-Automation] File "/mnt/vss/_work/1/s/azure-sdk-for-java/./eng/automation/generate.py", line 206, in sdk_automation_autorest cmderr [Java-Sdk-Automation] "changelog": {"content": changelog, "hasBreakingChange": breaking}, cmderr [Java-Sdk-Automation] UnboundLocalError: local variable 'changelog' referenced before assignment error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-java]: ./eng/automation/generate.py warn Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.
️❌ azure-sdk-for-go failed [Detail]
- For more instructions, please refer to the FAQ .
❌Pipeline Framework Failed in generating from 6f8b00af3da9ed27bfd06b09f4c8c977b9e5435f. 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 To https://github.com/azure-sdk/azure-sdk-for-go! refs/heads/main:refs/heads/main [remote rejected] (cannot lock ref 'refs/heads/main': is at 4e0b68a3e6d0db3ee904f0f0154e13987f1593c6 but expected d6dd015f7261c41002543dcedd4b9660811f0d65)DonePushing to https://github.com/azure-sdk/azure-sdk-for-goPOST git-receive-pack (211 bytes)error: failed to push some refs to 'https://github.com/azure-sdk/azure-sdk-for-go' error GenerationError: The following packages are still pending. error sdk/resourcemanager/cdn/armcdn
️✔️sdk/resourcemanager/cdn/armcdnBreaking Change Detectederror FatalError: To https://github.com/azure-sdk/azure-sdk-for-go! refs/heads/main:refs/heads/main [remote rejected] (cannot lock ref 'refs/heads/main': is at 4e0b68a3e6d0db3ee904f0f0154e13987f1593c6 but expected d6dd015f7261c41002543dcedd4b9660811f0d65)DonePushing to https://github.com/azure-sdk/azure-sdk-for-goPOST git-receive-pack (211 bytes)error: failed to push some refs to 'https://github.com/azure-sdk/azure-sdk-for-go'. Please refer to the inner logs for details or report this issue through https://aka.ms/azsdk/support/specreview-channel. error ErrorStack: Error: To https://github.com/azure-sdk/azure-sdk-for-go! refs/heads/main:refs/heads/main [remote rejected] (cannot lock ref 'refs/heads/main': is at 4e0b68a3e6d0db3ee904f0f0154e13987f1593c6 but expected d6dd015f7261c41002543dcedd4b9660811f0d65)DonePushing to https://github.com/azure-sdk/azure-sdk-for-goPOST git-receive-pack (211 bytes)error: failed to push some refs to 'https://github.com/azure-sdk/azure-sdk-for-go' at Object.action (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1451:25) at PluginStore.exec (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1500:29) at /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1927:43 at new Promise (<anonymous>) at GitExecutorChain.handleTaskData (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1925:16) at GitExecutorChain.<anonymous> (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1909:44) at Generator.next (<anonymous>) at fulfilled (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:52:24) at process.processTicksAndRejections (node:internal/process/task_queues:95:5). error GenerationError: The following packages are still pending. error sdk/resourcemanager/cdn/armcdn
Present SDK breaking changes suppressions Enum `CacheExpirationActionParametersTypeName` has been removed Enum `CacheKeyQueryStringActionParametersTypeName` has been removed Enum `CdnCertificateSourceParametersTypeName` has been removed Enum `ClientPortMatchConditionParametersTypeName` has been removed Enum `CookiesMatchConditionParametersTypeName` has been removed Enum `DeliveryRuleAction` has been removed Enum `HTTPVersionMatchConditionParametersTypeName` has been removed Enum `HeaderActionParametersTypeName` has been removed Enum `HostNameMatchConditionParametersTypeName` has been removed Enum `IsDeviceMatchConditionParametersMatchValuesItem` has been removed Enum `IsDeviceMatchConditionParametersTypeName` has been removed Enum `KeyVaultCertificateSourceParametersTypeName` has been removed Enum `KeyVaultSigningKeyParametersTypeName` has been removed Enum `OriginGroupOverrideActionParametersTypeName` has been removed Enum `PostArgsMatchConditionParametersTypeName` has been removed Enum `QueryStringMatchConditionParametersTypeName` has been removed Enum `RemoteAddressMatchConditionParametersTypeName` has been removed Enum `RequestBodyMatchConditionParametersTypeName` has been removed Enum `RequestHeaderMatchConditionParametersTypeName` has been removed Enum `RequestMethodMatchConditionParametersMatchValuesItem` has been removed Enum `RequestMethodMatchConditionParametersTypeName` has been removed Enum `RequestSchemeMatchConditionParametersMatchValuesItem` has been removed Enum `RequestSchemeMatchConditionParametersTypeName` has been removed Enum `RequestURIMatchConditionParametersTypeName` has been removed Enum `RouteConfigurationOverrideActionParametersTypeName` has been removed Enum `SSLProtocolMatchConditionParametersTypeName` has been removed Enum `ServerPortMatchConditionParametersTypeName` has been removed Enum `SocketAddrMatchConditionParametersTypeName` has been removed Enum `URLFileExtensionMatchConditionParametersTypeName` has been removed Enum `URLFileNameMatchConditionParametersTypeName` has been removed Enum `URLPathMatchConditionParametersTypeName` has been removed Enum `URLRedirectActionParametersTypeName` has been removed Enum `URLRewriteActionParametersTypeName` has been removed Enum `URLSigningActionParametersTypeName` has been removed Function `*DeliveryRuleActionAutoGenerated.GetDeliveryRuleActionAutoGenerated` has been removed Function `*DeliveryRuleCacheExpirationAction.GetDeliveryRuleActionAutoGenerated` has been removed Function `*DeliveryRuleCacheKeyQueryStringAction.GetDeliveryRuleActionAutoGenerated` has been removed Function `*DeliveryRuleRequestHeaderAction.GetDeliveryRuleActionAutoGenerated` has been removed Function `*DeliveryRuleResponseHeaderAction.GetDeliveryRuleActionAutoGenerated` has been removed Function `*DeliveryRuleRouteConfigurationOverrideAction.GetDeliveryRuleActionAutoGenerated` has been removed Function `*OriginGroupOverrideAction.GetDeliveryRuleActionAutoGenerated` has been removed Function `*URLRedirectAction.GetDeliveryRuleActionAutoGenerated` has been removed Function `*URLRewriteAction.GetDeliveryRuleActionAutoGenerated` has been removed Function `*URLSigningAction.GetDeliveryRuleActionAutoGenerated` has been removed Type of `CacheExpirationActionParameters.TypeName` has been changed from `*CacheExpirationActionParametersTypeName` to `*DeliveryRuleActionParametersType` Type of `CacheKeyQueryStringActionParameters.TypeName` has been changed from `*CacheKeyQueryStringActionParametersTypeName` to `*DeliveryRuleActionParametersType` Type of `CertificateSourceParameters.TypeName` has been changed from `*CdnCertificateSourceParametersTypeName` to `*CertificateSourceParametersType` Type of `ClientPortMatchConditionParameters.TypeName` has been changed from `*ClientPortMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `CookiesMatchConditionParameters.TypeName` has been changed from `*CookiesMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `DeliveryRule.Actions` has been changed from `[]DeliveryRuleActionAutoGeneratedClassification` to `[]DeliveryRuleActionClassification` Type of `DeliveryRuleCacheExpirationAction.Name` has been changed from `*DeliveryRuleAction` to `*DeliveryRuleActionName` Type of `DeliveryRuleCacheKeyQueryStringAction.Name` has been changed from `*DeliveryRuleAction` to `*DeliveryRuleActionName` Type of `DeliveryRuleRequestHeaderAction.Name` has been changed from `*DeliveryRuleAction` to `*DeliveryRuleActionName` Type of `DeliveryRuleResponseHeaderAction.Name` has been changed from `*DeliveryRuleAction` to `*DeliveryRuleActionName` Type of `DeliveryRuleRouteConfigurationOverrideAction.Name` has been changed from `*DeliveryRuleAction` to `*DeliveryRuleActionName` Type of `HTTPVersionMatchConditionParameters.TypeName` has been changed from `*HTTPVersionMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `HeaderActionParameters.TypeName` has been changed from `*HeaderActionParametersTypeName` to `*DeliveryRuleActionParametersType` Type of `HostNameMatchConditionParameters.TypeName` has been changed from `*HostNameMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `IsDeviceMatchConditionParameters.MatchValues` has been changed from `[]*IsDeviceMatchConditionParametersMatchValuesItem` to `[]*IsDeviceMatchValue` Type of `IsDeviceMatchConditionParameters.TypeName` has been changed from `*IsDeviceMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `KeyVaultCertificateSourceParameters.TypeName` has been changed from `*KeyVaultCertificateSourceParametersTypeName` to `*CertificateSourceParametersType` Type of `KeyVaultSigningKeyParameters.TypeName` has been changed from `*KeyVaultSigningKeyParametersTypeName` to `*KeyVaultSigningKeyParametersType` Type of `OriginGroupOverrideAction.Name` has been changed from `*DeliveryRuleAction` to `*DeliveryRuleActionName` Type of `OriginGroupOverrideActionParameters.TypeName` has been changed from `*OriginGroupOverrideActionParametersTypeName` to `*DeliveryRuleActionParametersType` Type of `PostArgsMatchConditionParameters.TypeName` has been changed from `*PostArgsMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `QueryStringMatchConditionParameters.TypeName` has been changed from `*QueryStringMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `RemoteAddressMatchConditionParameters.TypeName` has been changed from `*RemoteAddressMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `RequestBodyMatchConditionParameters.TypeName` has been changed from `*RequestBodyMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `RequestHeaderMatchConditionParameters.TypeName` has been changed from `*RequestHeaderMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `RequestMethodMatchConditionParameters.MatchValues` has been changed from `[]*RequestMethodMatchConditionParametersMatchValuesItem` to `[]*RequestMethodMatchValue` Type of `RequestMethodMatchConditionParameters.TypeName` has been changed from `*RequestMethodMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `RequestSchemeMatchConditionParameters.MatchValues` has been changed from `[]*RequestSchemeMatchConditionParametersMatchValuesItem` to `[]*RequestSchemeMatchValue` Type of `RequestSchemeMatchConditionParameters.TypeName` has been changed from `*RequestSchemeMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `RequestURIMatchConditionParameters.TypeName` has been changed from `*RequestURIMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `RouteConfigurationOverrideActionParameters.TypeName` has been changed from `*RouteConfigurationOverrideActionParametersTypeName` to `*DeliveryRuleActionParametersType` Type of `RuleProperties.Actions` has been changed from `[]DeliveryRuleActionAutoGeneratedClassification` to `[]DeliveryRuleActionClassification` Type of `RuleUpdatePropertiesParameters.Actions` has been changed from `[]DeliveryRuleActionAutoGeneratedClassification` to `[]DeliveryRuleActionClassification` Type of `SSLProtocolMatchConditionParameters.TypeName` has been changed from `*SSLProtocolMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `ServerPortMatchConditionParameters.TypeName` has been changed from `*ServerPortMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `SocketAddrMatchConditionParameters.TypeName` has been changed from `*SocketAddrMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `URLFileExtensionMatchConditionParameters.TypeName` has been changed from `*URLFileExtensionMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `URLFileNameMatchConditionParameters.TypeName` has been changed from `*URLFileNameMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `URLPathMatchConditionParameters.TypeName` has been changed from `*URLPathMatchConditionParametersTypeName` to `*DeliveryRuleConditionParametersType` Type of `URLRedirectAction.Name` has been changed from `*DeliveryRuleAction` to `*DeliveryRuleActionName` Type of `URLRedirectActionParameters.TypeName` has been changed from `*URLRedirectActionParametersTypeName` to `*DeliveryRuleActionParametersType` Type of `URLRewriteAction.Name` has been changed from `*DeliveryRuleAction` to `*DeliveryRuleActionName` Type of `URLRewriteActionParameters.TypeName` has been changed from `*URLRewriteActionParametersTypeName` to `*DeliveryRuleActionParametersType` Type of `URLSigningAction.Name` has been changed from `*DeliveryRuleAction` to `*DeliveryRuleActionName` Type of `URLSigningActionParameters.TypeName` has been changed from `*URLSigningActionParametersTypeName` to `*DeliveryRuleActionParametersType`
Please refer to the guidance for suppressing SDK breaking changes.
️❌ azure-sdk-for-net-track2 failed [Detail]
- For more instructions, please refer to the FAQ .
❌Failed in generating from 6f8b00af3da9ed27bfd06b09f4c8c977b9e5435f. 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 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] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714 cmderr [Invoke-GenerateAndBuildV2.ps1] Line | cmderr [Invoke-GenerateAndBuildV2.ps1] 714 | GeneratePackage -projectFolder $projectFolder -sdkRootPath $s … cmderr [Invoke-GenerateAndBuildV2.ps1] | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] | Failed to generate sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:787 cmderr [Invoke-GenerateAndBuildV2.ps1] Line | cmderr [Invoke-GenerateAndBuildV2.ps1] 787 | … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s … cmderr [Invoke-GenerateAndBuildV2.ps1] | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] | Cannot find path cmderr [Invoke-GenerateAndBuildV2.ps1] | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because cmderr [Invoke-GenerateAndBuildV2.ps1] | it does not exist.
❌Azure.ResourceManager.Cdn [Preview SDK Changes]info [Changelog]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
- For more instructions, please refer to the FAQ .
️✔️Succeeded in generating from 6f8b00af3da9ed27bfd06b09f4c8c977b9e5435f. 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 Warning: File azure-sdk-for-js_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel. command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️@azure/arm-cdn [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added Interface CertificateSourceParameters info [Changelog] - Added Interface DeliveryRuleAction info [Changelog] - Added Interface DeliveryRuleActionParameters info [Changelog] - Added Interface DeliveryRuleConditionParameters info [Changelog] - Added Type Alias CertificateSourceParametersType info [Changelog] - Added Type Alias CertificateSourceParametersUnion info [Changelog] - Added Type Alias DeliveryRuleActionName info [Changelog] - Added Type Alias DeliveryRuleActionParametersType info [Changelog] - Added Type Alias DeliveryRuleActionParametersUnion info [Changelog] - Added Type Alias DeliveryRuleActionUnion info [Changelog] - Added Type Alias DeliveryRuleConditionParametersType info [Changelog] - Added Type Alias DeliveryRuleConditionParametersUnion info [Changelog] - Added Type Alias IsDeviceMatchValue info [Changelog] - Added Type Alias KeyVaultSigningKeyParametersType info [Changelog] - Added Type Alias RequestMethodMatchValue info [Changelog] - Added Type Alias RequestSchemeMatchValue info [Changelog] - Added Enum KnownCertificateSourceParametersType info [Changelog] - Added Enum KnownDeliveryRuleActionName info [Changelog] - Added Enum KnownDeliveryRuleActionParametersType info [Changelog] - Added Enum KnownDeliveryRuleConditionParametersType info [Changelog] - Added Enum KnownIsDeviceMatchValue info [Changelog] - Added Enum KnownKeyVaultSigningKeyParametersType info [Changelog] - Added Enum KnownRequestMethodMatchValue info [Changelog] - Added Enum KnownRequestSchemeMatchValue info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Type of parameter actions of interface DeliveryRule is changed from DeliveryRuleActionAutoGeneratedUnion[] to DeliveryRuleActionUnion[] info [Changelog] - Type of parameter matchValues of interface IsDeviceMatchConditionParameters is changed from IsDeviceMatchConditionParametersMatchValuesItem[] to IsDeviceMatchValue[] info [Changelog] - Type of parameter typeName of interface KeyVaultSigningKeyParameters is changed from "KeyVaultSigningKeyParameters" to KeyVaultSigningKeyParametersType info [Changelog] - Type of parameter matchValues of interface RequestMethodMatchConditionParameters is changed from RequestMethodMatchConditionParametersMatchValuesItem[] to RequestMethodMatchValue[] info [Changelog] - Type of parameter matchValues of interface RequestSchemeMatchConditionParameters is changed from RequestSchemeMatchConditionParametersMatchValuesItem[] to RequestSchemeMatchValue[] info [Changelog] - Type of parameter actions of interface Rule is changed from DeliveryRuleActionAutoGeneratedUnion[] to DeliveryRuleActionUnion[] info [Changelog] - Type of parameter actions of interface RuleUpdateParameters is changed from DeliveryRuleActionAutoGeneratedUnion[] to DeliveryRuleActionUnion[] info [Changelog] - Type of parameter actions of interface RuleUpdatePropertiesParameters is changed from DeliveryRuleActionAutoGeneratedUnion[] to DeliveryRuleActionUnion[] info [Changelog] - Removed Enum KnownDeliveryRuleAction info [Changelog] - Removed Enum KnownIsDeviceMatchConditionParametersMatchValuesItem info [Changelog] - Removed Enum KnownRequestMethodMatchConditionParametersMatchValuesItem info [Changelog] - Removed Enum KnownRequestSchemeMatchConditionParametersMatchValuesItem
Present SDK breaking changes suppressions Removed Enum KnownDeliveryRuleAction Removed Enum KnownIsDeviceMatchConditionParametersMatchValuesItem Removed Enum KnownRequestMethodMatchConditionParametersMatchValuesItem Removed Enum KnownRequestSchemeMatchConditionParametersMatchValuesItem Type of parameter actions of interface DeliveryRule is changed from DeliveryRuleActionAutoGeneratedUnion[] to DeliveryRuleActionUnion[] Type of parameter actions of interface Rule is changed from DeliveryRuleActionAutoGeneratedUnion[] to DeliveryRuleActionUnion[] Type of parameter actions of interface RuleUpdateParameters is changed from DeliveryRuleActionAutoGeneratedUnion[] to DeliveryRuleActionUnion[] Type of parameter actions of interface RuleUpdatePropertiesParameters is changed from DeliveryRuleActionAutoGeneratedUnion[] to DeliveryRuleActionUnion[] Type of parameter matchValues of interface IsDeviceMatchConditionParameters is changed from IsDeviceMatchConditionParametersMatchValuesItem[] to IsDeviceMatchValue[] Type of parameter matchValues of interface RequestMethodMatchConditionParameters is changed from RequestMethodMatchConditionParametersMatchValuesItem[] to RequestMethodMatchValue[] Type of parameter matchValues of interface RequestSchemeMatchConditionParameters is changed from RequestSchemeMatchConditionParametersMatchValuesItem[] to RequestSchemeMatchValue[] Type of parameter typeName of interface KeyVaultSigningKeyParameters is changed from "KeyVaultSigningKeyParameters" to KeyVaultSigningKeyParametersType
Please refer to the guidance for suppressing SDK breaking changes.
️❌ azure-resource-manager-schemas failed [Detail]
- For more instructions, please refer to the FAQ .
❌Code Generator Failed in generating from 6f8b00af3da9ed27bfd06b09f4c8c977b9e5435f. 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] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az' cmderr [initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'... cmderr [initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types' cmderr [initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'... cmderr [initScript.sh] npm notice cmderr [initScript.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.2 cmderr [initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.2 cmderr [initScript.sh] npm notice To update run: npm install -g [email protected] cmderr [initScript.sh] npm notice error Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh warn Warning: File azure-resource-manager-schemas_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel. command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json cmderr [generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500 cmderr [generateScript.sh] return new TSError(diagnosticText, diagnosticCodes) cmderr [generateScript.sh] ^ cmderr [generateScript.sh] TSError: ⨯ Unable to compile TypeScript: cmderr [generateScript.sh] cmd/generateall.ts(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations. cmderr [generateScript.sh] cmd/generateall.ts(42,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type. cmderr [generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type. cmderr [generateScript.sh] cmd/generateall.ts(94,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(105,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'. cmderr [generateScript.sh] cmd/generateall.ts(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig. cmderr [generateScript.sh] at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500:12) cmderr [generateScript.sh] at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:504:19) cmderr [generateScript.sh] at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:739:36) cmderr [generateScript.sh] at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:955:32) cmderr [generateScript.sh] at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1043:43) cmderr [generateScript.sh] at Module._extensions..js (node:internal/modules/cjs/loader:1422:10) cmderr [generateScript.sh] at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1046:12) cmderr [generateScript.sh] at Module.load (node:internal/modules/cjs/loader:1203:32) cmderr [generateScript.sh] at Function.Module._load (node:internal/modules/cjs/loader:1019:12) cmderr [generateScript.sh] at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12) error Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh warn Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.
️⚠️ azure-powershell warning [Detail]
- For more instructions, please refer to the FAQ .
⚠️Warning in generating from 6f8b00af3da9ed27bfd06b09f4c8c977b9e5435f. 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.cdn.DefaultTag [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/cdn/armcdn | https://apiview.dev/Assemblies/Review/5e345519a8864b018f9aae9fb7ba934c?revisionId=7a319c5843a24f08951e078b34c5a705 |
| .Net | Azure.ResourceManager.Cdn | There is no API change compared with the previous version |
| JavaScript | @azure/arm-cdn | https://apiview.dev/Assemblies/Review/d03c7f4c0d164abd85030a921f78f9ad?revisionId=fb2fcd1534094a09babaeb918e3190f5 |
| Swagger | Microsoft.Cdn | https://apiview.dev/Assemblies/Review/903c889b8b1e4bf9bd097f6d66eb1cdd?revisionId=f8a53a13d9c54c88b87ed3a969d164b2 |
@t-bzhan I have reviewed the PR changes and it looks like this is just changing the way polymorphism is described to be more in-line with Azure conventions, so I'm willing to approve the breaking changes at the REST API level. But I think you need to work with the SDK teams for any languages that are affected to minimize the impact there.
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
ModelValidation errors need fixing, would be great to get that done before further ARM review
ModelValidation errors need fixing, would be great to get that done before further ARM review
Hi @TimLovellSmith , the ModelValidation errors are not related to this PR. Can we skip this step for now? I’ll submit a separate PR to address them after this one.
ModelValidation errors need fixing, would be great to get that done before further ARM review
Hi @TimLovellSmith , the ModelValidation errors are not related to this PR. Can we skip this step for now? I’ll submit a separate PR to address them after this one.
ModelValidation is required to fix before merge
ModelValidation errors need fixing, would be great to get that done before further ARM review
Hi @TimLovellSmith , the ModelValidation errors are not related to this PR. Can we skip this step for now? I’ll submit a separate PR to address them after this one.
ModelValidation is required to fix before merge
Hi @TimLovellSmith , I understand the importance of maintaining correct Swagger definitions. However, I find the model validation errors a bit confusing. Specifically, the first two errors seem contradictory. The first error indicates that I added an additional id field in the example because our Swagger doesn’t define it. On the other hand, the second error complains that I’m missing the id because the resource definition is marked as x-ms-azure-resource: true. I attempted to move the id into the properties, but that approach didn’t work either. Could you kindly suggest the next steps to resolve this?
Below is the error if I moved the id into the properties:
{
code: 'OBJECT_ADDITIONAL_PROPERTIES',
message: 'Additional properties not allowed: id',
schemaUrl: 'D:\\github2\\azure-rest-api-specs\\specification\\cdn\\resource-manager\\Microsoft.Cdn\\stable\\2024-02-01\\cdn.json',
exampleUrl: 'D:\\github2\\azure-rest-api-specs\\specification\\cdn\\resource-manager\\Microsoft.Cdn\\stable\\2024-02-01\\examples\\Endpoints_ListByProfile.json',
schemaPosition: { line: 5505, column: 36 },
schemaJsonPath: '#/additionalProperties',
examplePosition: { line: 32, column: 27 },
exampleJsonPath: '$responses.200.body.value[0].properties.origins[0].properties.id',
severity: 0,
source: 'response',
operationId: 'Endpoints_ListByProfile',
level: '\x1B[31merror\x1B[39m'
}
{
code: 'MISSING_RESOURCE_ID',
message: 'id is required to return in response of GET/PUT resource calls but not being provided',
schemaUrl: 'D:\\github2\\azure-rest-api-specs\\specification\\cdn\\resource-manager\\Microsoft.Cdn\\stable\\2024-02-01\\cdn.json',
exampleUrl: 'D:\\github2\\azure-rest-api-specs\\specification\\cdn\\resource-manager\\Microsoft.Cdn\\stable\\2024-02-01\\examples\\Endpoints_ListByProfile.json',
schemaPosition: { line: 5487, column: 26 },
schemaJsonPath: '#/x-ms-azure-resource',
examplePosition: { line: 28, column: 17 },
exampleJsonPath: '$responses.200.body.value[0].properties.origins[0]',
severity: 0,
source: 'response',
operationId: 'Endpoints_ListByProfile',
level: '\x1B[31merror\x1B[39m'
}
I didn't see any significant changes from ARM POV, which is good for a refactor, so I've signed off for ARM. but we still need to figure out what is up with model validation
I think having 'id' at the top level is the way to go but there might be something a bit 'off' with the way you are using x-ms-azure-resource actually. Just tagging your resource type with that doesn't give it any properties like 'id'. Instead, you should inherit from ProxyResource (or else TrackedResource).
},
POST operations shouldn't normally return resources. Do you really need to return these properties? Consider deprecating or removing them, if not.
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:2977 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
"x-ms-azure-resource": true
POST operations shouldn't normally return resources, so I'd remove this tag. Unless it is too breaking for SDK.
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:2983 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
"description": "Resource ID.",
What resource is it returning the ID of? a 'can migrate result' is not an azure resource.
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:2969 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
"x-ms-azure-resource": true
POST request bodies should not be marked as x-ms-azure-resource, except perhaps in the very UNusual case they're creating a new resource.
I recommend removing this unless it is too breaking for SDK.
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:3054 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
"x-ms-azure-resource": true
this would be [ARMBlockingComment] but its not part of the proposed change: POST request bodies should not be marked as x-ms-azure-resource, except perhaps in the very UNusual case they're creating a new resource
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:3087 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
"x-ms-azure-resource": true
this would be [ARMBlockingComment] if it were a new REST API but its not part of the proposed change:
POST operations shouldn't normally return resources. Do you really need to return these properties 'id' and 'type'? Consider deprecating or removing them, if not.
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:3122 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
"description": "Resource ID.",
of?
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:3108 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
"x-ms-azure-resource": true
I assume your Origins are modeled as resources... and then you should ideally inherit ProxyResource instead of using this tag.
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:5503 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
"x-ms-azure-resource": true
Should be [ARMBlockingComment] were this a new API (but its not right)
This tag shouldn't be on the 'properties' property bag!
Please remove it! ... Unless its too breaking.
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:5579 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
"x-ms-azure-resource": true
If this is a proxy resource represented elsewhere in the API, then you can inherit "allOf" ProxyResource from common-types
Otherwise, I believe this tag shouldn't be there.
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:5597 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
"x-ms-azure-resource": true
Should be [ARMBlockingComment] if this were this a new API:
x-ms-azure-resource tag shouldn't be added on the 'properties' property bag deifnition!
Please remove it, if you can get approval for the possibly SDK breaking change.
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:5632 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
"x-ms-azure-resource": true
Remove this.
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:5642 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
},
Please remove these definitions of 'Resource' and 'ProxyReosurce', and everywhere you reference them, instead inherit "allOf", from ProxyResource, TrackedResoruce, or Resource in common-types types.json
../../../../../common-types/resource-management/v6/types.json](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/common-types/resource-management/v6/types.json)
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:7030 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
},
Please remove these and everywhere you reference them, instead inherit "allOf", from ProxyResource, TrackedResource, or Resource in common-types' types.json
../../../../../common-types/resource-management/v6/types.json](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/common-types/resource-management/v6/types.json)
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:7082 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
"PrivateEndpointStatus": {
Is there a reason you didn't use the definition here? Is this not following the normal private link integration pattern?
(I notice the common types version does not define the "Timeout" or "Pending" statuses, but where is the requirement for those from?!)
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:7097 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
},
Consider removing these and instead referencing the ErrorResponse definitions from common-types.
This feedback is more like 'optional' at this point, in case its breaking.
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:7225 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)
}
Optional, but since you're already making SDK breaking changes....
For sake of consistency with other RPs and reviewability, I would like to recommend removing these parameter definitions from your spec, and instead always referencing the ones from common-types.
e.g.
../../../../../common-types/resource-management/v6/types.json#parameters/SubscriptionIdParameter
Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json:7251 in dafbb66. [](commit_id = dafbb66d086ca156bd0b5f23e7a946dd2ce41431, deletion_comment = False)