Support Key Vault references in Bicep and JSON parameter files#4744
Merged
Conversation
JeffreyCA
requested review from
hemarina,
vhvb1989,
wbreza and
weikanglim
as code owners
January 31, 2025 01:18
weikanglim
reviewed
Jan 31, 2025
weikanglim
reviewed
Jan 31, 2025
weikanglim
approved these changes
Jan 31, 2025
weikanglim
left a comment
weikanglim
left a comment
Contributor
There was a problem hiding this comment.
LGTM. I really appreciate how clean these changes were. It really helped highlight to me the idea of how much of azd interpreting bicepparam / ARM files are really "passthrough changes to the ARM control plane".
I also really like that the existing code allowed us to add this change simply without affecting how param prompting works in azd.
Collaborator
Azure Dev CLI Install InstructionsInstall scriptsMacOS/Linux
bash: pwsh: WindowsPowerShell install MSI install Standalone Binary
MSI
Documentationlearn.microsoft.com documentationtitle: Azure Developer CLI reference
|
vhvb1989
approved these changes
Feb 1, 2025
vhvb1989
left a comment
vhvb1989
left a comment
Member
There was a problem hiding this comment.
LGTM.
Just adding a question about if we should be parsing the key vault reference or not.
14 tasks
1 task
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
4 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.
Fixes #4706
This PR adds support for Key Vault references in parameter files, so you can now define a
paraminmain.bicepthat has a key vault reference (instead of a simple value) inmain.bicepparamormain.parameters.json.The issue was that when deserializing the
main.parameters.jsonfile, the model type used did not have the necessary fields for key vault references. As a result, theValuefield would beniland causeazdto prompt the user for a value, ignoring the value in the Key Vault secret.Example
main.bicep:
main.bicepparam:
main.parameters.json:
{ "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", "contentVersion": "1.0.0.0", "parameters": { "kvSecret": { "reference": { "keyVault": { "id": "/subscriptions/<subscription>/resourceGroups/<resource group>/providers/Microsoft.KeyVault/vaults/<vault>" }, "secretName": "testsecret" } } } }Validation
Tested
azd upon sample code that uses Bicep and JSON parameter files with KV references and confirmed that the secret value flowed through to the deployment output.Also tested with
alpha.deployment.stacksset toonandoff.