-
Notifications
You must be signed in to change notification settings - Fork 5.6k
[CDN] Add new API version 2024-05-01-preview for CDN #29369
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.9) | new version | base version |
|---|---|---|
| afdx.json | 2024-05-01-preview(27679f3) | 2024-02-01(main) |
| afdx.json | 2024-05-01-preview(27679f3) | 2023-07-01-preview(main) |
| cdn.json | 2024-05-01-preview(27679f3) | 2024-02-01(main) |
| cdn.json | 2024-05-01-preview(27679f3) | 2023-07-01-preview(main) |
| cdnwebapplicationfirewall.json | 2024-05-01-preview(27679f3) | 2024-02-01(main) |
| cdnwebapplicationfirewall.json | 2024-05-01-preview(27679f3) | 2023-07-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
1023 - TypeFormatChanged |
The new version has a different format 'arm-id' than the previous one ''. New: Microsoft.Cdn/preview/2024-05-01-preview/cdn.json#L3139:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L2968:9 |
1023 - TypeFormatChanged |
The new version has a different format 'arm-id' than the previous one ''. New: Microsoft.Cdn/preview/2024-05-01-preview/cdn.json#L3279:9 Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3107:9 |
1025 - RequiredStatusChange |
The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L5381:7 Old: Microsoft.Cdn/stable/2024-02-01/afdx.json#L4926:7 |
1034 - AddedRequiredProperty |
The new version has new required property 'secretVersion' that was not found in the old version. New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L5367:5 Old: Microsoft.Cdn/stable/2024-02-01/afdx.json#L4913:5 |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-preview-2024-05 | package-preview-2024-05(27679f3) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L3549 |
RPC-Get-V1-11 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L136 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L185 |
PostResponseCodes |
202 response for a LRO POST operation must not have a response schema specified. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L292 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L347 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L357 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L406 |
ResourceNameRestriction |
The resource name parameter 'customDomainName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L406 |
PutResponseCodes |
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/preview/2024-05-01-preview/afdx.json#L458 |
RepeatedPathInfo |
The 'profileName' already appears in the path, please don't repeat it in the request body. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L473 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L521 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L530 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:certificateType. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L573 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L605 |
DeleteResponseCodes |
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/preview/2024-05-01-preview/afdx.json#L614 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L668 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L678 |
ResourceNameRestriction |
The resource name parameter 'customDomainName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L678 |
PostResponseCodes |
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/preview/2024-05-01-preview/afdx.json#L679 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L730 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L740 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L789 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L789 |
PutResponseCodes |
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/preview/2024-05-01-preview/afdx.json#L841 |
RepeatedPathInfo |
The 'profileName' already appears in the path, please don't repeat it in the request body. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L856 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L913 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L988 |
DeleteResponseCodes |
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/preview/2024-05-01-preview/afdx.json#L997 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L1051 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L1061 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L1061 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️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
|
Generated ApiView
|
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
|
/pr RequestMerge |
|
Refer the PR in private repo: https://github.com/Azure/azure-rest-api-specs-pr/pull/17753 |
|
Removing the MergeRequested label as this PR needs to be ARMSignedOff and obtain a BreakingChange Approval before being able to be merged. To unblock this PR, follow the process at aka.ms/brch. |
|
@razvanbadea-msft The PR in private repo already got |
|
The changes to the REST API definition are correcting the definition to accurately describe the service behavior,so bypass the review process by adding
|
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
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!
Refer the PR in private repo: https://github.com/Azure/azure-rest-api-specs-pr/pull/17753
- Add new version 2024-05-01-preview
- Add a new property
grpcStatein route: https://github.com/Azure/azure-rest-api-specs-pr/pull/17753/commits/9b8b8e8e8dbc12e65a8123384d2ff34d7d298f8a- Add cipher suites for custom domain resource: https://github.com/Azure/azure-rest-api-specs-pr/pull/17753/commits/d8c333d694e65e4d0da5e47d11be991c17094181
- Add keygroup API: https://github.com/Azure/azure-rest-api-specs-pr/pull/17753/commits/c6e8b27695045aef6e1a64f0f90a91e7e268ead1
- Add property to support mTLS in secret and custom domain resource: https://github.com/Azure/azure-rest-api-specs-pr/pull/17753/commits/ffc1c400c0ce9c9600801fb1347ff12089c11c47
- Add API for classic CDN migration to AFD: https://github.com/Azure/azure-rest-api-specs-pr/pull/17753/commits/ac9a5749d218179b7846a920f360ae18505ea1b7
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:
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 ApiViewcomment 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
Purpose of this PRandDue diligence checklist.write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext 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.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.