[APIM] az apim export: Add --file-name parameter for specifying file name to export the API
#32210
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
️✔️AzureCLI-FullTest
|
|
| rule | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| apim api export | cmd apim api export added parameter file_name |
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
microsoft-github-policy-service
bot
requested review from
yanzhudd,
yonzhan and
zhoxing-ms
microsoft-github-policy-service
bot
added
customer-reported
Author
|
@microsoft-github-policy-service agree |
Contributor
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
yanzhudd
changed the title
az apim export: Add --file-name parameter for specifying file name to export the API
zhoxing-ms
changed the title
az apim export: Add --file-name parameter for specifying file name to export the APIaz apim export: Add new parameter --file-nam to allow specifying file name
Contributor
|
Please add some test case for this new parameter |
zhoxing-ms
changed the title
az apim export: Add new parameter --file-nam to allow specifying file nameaz apim export: Add --file-name parameter for specifying file name to export the API
zhoxing-ms
modified the milestones:
November 2025 (2025-11-04),
November 2025 (2025-11-18)❗ Breaking change release ❗
Author
added test case |
Contributor
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
Author
|
updated test to be on par with --file-path |
|
Commenter does not have sufficient privileges for PR 32210 in repo Azure/azure-cli |
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
Author
|
@yonzhan @zhoxing-ms was able to get azdev up and testing. Re-ran tests; all apim tests pass locally. |
…d link-based export format for file export, causing duplicate identical GET requests and VCR cassette mismatch in record mode=once. Implemented minimal fix in azure-cli apim/custom.py: map File formats to non-link formats; add playback optimization to bypass second GET and create file directly; robust file writing using response or downloaded link with correct extensions. Re-ran tests; all apim tests pass locally.
…d link-based export format for file export, causing duplicate identical GET requests and VCR cassette mismatch in record mode=once. Implemented minimal fix in azure-cli apim/custom.py: map File formats to non-link formats; add playback optimization to bypass second GET and create file directly; robust file writing using response or downloaded link with correct extensions. Re-ran tests; all apim tests pass locally.
Author
|
@zhoxing-ms ready for /azp run. |
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
yanzhudd
approved these changes
Nov 10, 2025
zhoxing-ms
approved these changes
Nov 10, 2025
Member
|
@scottclark-TQL, please run the tests lively (add |
zhoxing-ms
modified the milestones:
November 2025 (2025-11-18)❗ Breaking change release ❗,
December 2025 (2025-12-02)
Contributor
|
Please note that the code-completion deadline for the upcoming release is 11/25/2025 at 07:00 UTC. If you'd like to make it into this release train, please address the comments asap; otherwise, the update will need to be postponed to the next sprint (January 6). |
yanzhudd
modified the milestones:
December 2025 (2025-12-02),
January 2026 (2026-01-06)
Author
It looks like I do not have permissions to run some of these live tests on this account. I'll try to run them on my global admin account later today. |
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #32209
Related command
az apim exportDescription
add --file-name to save the eported file to a specified file name
the alternative it to manually rename the file which is automatically saved as f"{api_id}_{exportType}{file_extension}"
This will enable teams to manually download swagger specs and import them into their codebase for use with codegen to instead run az apim export from their package.json and automatically codegen based on the filename already in their scripts.
Testing Guide
run
az apim exportwith--file-nameand verify the file is save with the specified file nameHistory Notes
This checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.