-
Notifications
You must be signed in to change notification settings - Fork 5.4k
[CDN] Add new stable API version 2025-06-01 for Managed Identity Origin Authentication and moving profile CRUD to share.json #35181
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
base: main
Are you sure you want to change the base?
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
|
PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
API Change CheckAPIView identified API level changes in this PR and created the following API reviews
|
24985d1
to
d1974cc
Compare
d1974cc
to
5c450b9
Compare
MSI is normally placed in the top-level "identity" property. Why aren't you following that ARM standard? Ref: https://armwiki.azurewebsites.net/rbac/managed_identities/MSIOnboardingOverview.html?q=identity%20top-level%20property. Refers to: specification/cdn/resource-manager/Microsoft.Cdn/stable/2025-06-01/afdx.json:5236 in 5c450b9. [](commit_id = 5c450b9, deletion_comment = False) |
"definitions": { | ||
"ResourceReference": { | ||
"properties": { | ||
"id": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @mentat9 , all the swagger in share.json here are moved directly from the cdn.json intact. I didn't change anything. This is a strong requirement from doc team.
This has been lingering around since 2021, and we’d like us very much to move away from the manual working around and publishing for efficiency and to avoid human errors.
"ResourceReference": { | ||
"properties": { | ||
"id": { | ||
"type": "string", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add format: arm-id and (if appropriate) x-ms-arm-id-details. Ref: https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-arm-id-details.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
"identity": { | ||
"description": "Managed service identity (system assigned and/or user assigned identities).", | ||
"type": "object", | ||
"$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
"identity": { | ||
"description": "Managed service identity (system assigned and/or user assigned identities).", | ||
"type": "object", | ||
"$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
"StandardPlus_AvgBandWidth_ChinaCdn" | ||
], | ||
"type": "string", | ||
"x-ms-enum": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ChenglongLiu - In future, please do refactoring and adding an API version using separate PRs. It's hard for reviewers to see what's changing across API versions when there is also a bunch of refactoring. In this case, I was able to piece together the changes, and since there weren't a lot, I went ahead with ARM review. |
2cb44ee
to
d63335c
Compare
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting help
section 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!
This commit reorganizes the Swagger configuration by moving a subset of APIs—specifically, the profile operations—into a separate Swagger file.There are no changes to API behavior or functionality; this update is purely structural and aims to improve clarity, maintainability, and the ease of generating documentation.
This change is based on a longstanding request from the Microsoft Learn API documentation team. The goal is to eliminate the need for manual workarounds during documentation publishing—a process that has persisted since 2021—and to reduce the risk of human error while increasing efficiency.
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 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
Purpose of this PR
andDue diligence checklist
.write access
per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Merge
comment. 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.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.