[Keyvault] az keyvault secret download: Add --overwrite flag#31659
Merged
[Keyvault] az keyvault secret download: Add --overwrite flag#31659
az keyvault secret download: Add --overwrite flag#31659Conversation
️✔️AzureCLI-FullTest
|
|
| rule | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| keyvault secret download | cmd keyvault secret download added parameter overwrite |
|
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>
|
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces an --overwrite flag to the az keyvault secret download command, allowing users to overwrite an existing file instead of failing. It updates the command implementation, CLI parameter definitions, and adds corresponding tests.
- Added
overwriteparameter and conditional logic indownload_secret - Defined the
--overwriteargument in parameter configuration - Expanded tests to cover download without and with the overwrite flag
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test_keyvault_commands.py | Refactored download tests and added overwrite tests |
| custom.py | Updated download_secret to accept and handle flag |
| _params.py | Added --overwrite argument to the download command |
Contributor
|
You need to change Our CI is broken now. Please wait #31652 to be merged and update the code. |
a0x1ab
changed the title
az keyvault secret download : Add overwrite flagaz keyvault secret download : Add --overwrite flag
Member
Author
a0x1ab
changed the title
az keyvault secret download : Add --overwrite flagaz keyvault secret download : Add --overwrite flag
a0x1ab
changed the title
az keyvault secret download : Add --overwrite flagaz keyvault secret download: Add --overwrite flag
bebound
reviewed
Jun 17, 2025
| """ Download a secret from a KeyVault. """ | ||
| if os.path.isfile(file_path) or os.path.isdir(file_path): | ||
| raise CLIError("File or directory named '{}' already exists.".format(file_path)) | ||
| if not overwrite and (os.path.isfile(file_path) or os.path.isdir(file_path)): |
Contributor
There was a problem hiding this comment.
Edge case: if the given path is a directory, we're not able to overwrite it.
bebound
previously approved these changes
Jun 17, 2025
evelyn-ys
reviewed
Jun 17, 2025
Co-authored-by: Yishi Wang <yishiwang@microsoft.com>
evelyn-ys
approved these changes
Jun 17, 2025
bebound
approved these changes
Jun 17, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related command
keyvault
Description
az keyvault secret downloadcommand previously failed when provided with an existing file for the file path parameter.az keyvault secret downloadcommand to overwrite the existing file with the downloaded secret.Testing Guide
az keyvault secret download --vault-name {kv} -n download-{enc} --file "{dest_path}" --overwrite: overwrite existing path file with the contents of the downloaded secretThis 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.