Fix: Add JSON escape to variables before syncing to remote pipeline #5568
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
Add JSON escape to variables before syncing to remote Add JSON escape to variables before syncing to remote Add JSON escape to variables before syncing to remote Add JSON escape to variables before syncing to remote
Menghua1
requested review from
wbreza,
vhvb1989,
hemarina,
weikanglim,
JeffreyCA,
tg-msft and
rajeshkamal5050
as code owners
1 task
Azure Dev CLI Install InstructionsInstall scriptsMacOS/Linux
bash: pwsh: WindowsPowerShell install MSI install Standalone Binary
MSI
Documentationlearn.microsoft.com documentationtitle: Azure Developer CLI reference
|
wbreza
reviewed
Aug 8, 2025
@wbreza I’ve updated the PR description with a specific issue example. Please have a look! |
|
@vhvb1989 can you review this? |
|
@vhvb1989 @rajeshkamal5050 FWIW, I suspect that this happens only in Aspire use-cases when a user provides a JSON string as a parameter value. It wouldn't happen in normal azd when the parameter is marked as an I wasn't entirely sure if moving forward wwith this fix would bring about other edge cases to consider. From my quick eyes, arbitrarily assuming one way or another didn't seem like the right approach, but I haven't dug into any deeper. |
|
This issue also occurs in non-Aspire azd projects when user-entered parameter values contain quotes, backslashes, or special characters that require escaping. For example, if the input is This PR escapes the parameters before syncing, ensuring that the remote variable value is consistent with the local |
|
@Menghua1 , I don't love the idea of having each provider (gh and azdo) to manually handle the values within their implementation. I wonder if this is something that the pipeline manager can handle before calling the provider so the provider doesn't need to care. Ideally, I would love to see a change where the values are scaped right away when they are read from the environment config, with a note about it. |
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.
Fixes issue #5507.
This PR adds a step to JSON-escape the parameters from the local
.azure/envName/config.jsonbefore syncing them to the remote pipeline, ensuring that environment parameter values remain consistent between local and remote.Issue Example
In the local
.azure/envName/config.jsonfile, there is a parameter defined as a JSON string:{ "AzureAd_TokenValidationParameters_ValidAudiences": "[\"api://e935a748-8b59-4c26-a59c-9bcc83f5ab57\"]" }When running
azd pipeline configand syncing the variables in the.azure/envName/config.jsonfile to the remote pipeline, the value becomes unescaped:This causes azd to treat the value as an array type instead of a string in the remote pipeline, resulting in Bicep parameter parsing failures
ERROR: initializing provisioning manager: resolving bicep parameters file: error unmarshalling Bicep template parameters: invalid character 'a' after object key:value pair.Notably, running
azd uplocally works as expected because the value is preserved as a JSON string in the.azure/envName/config.jsonfile.This PR ensures parameter values are JSON-escaped before syncing to the remote pipeline, keeping them consistent with the local environment.
@rajeshkamal5050 and @vhvb1989 for notification.