Implement JSON output cleaning for Azure CLI commands #70
+78
−9
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
Added a method to clean JSON output from Azure CLI commands to remove control characters and non-JSON content.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds JSON output sanitization to Azure CLI command processing to handle cases where Azure CLI returns control characters or non-JSON content in its output. The implementation introduces a new CleanJsonOutput helper method that removes control characters and strips any text before the first JSON bracket.
Key changes:
- Added
CleanJsonOutputmethod to remove control characters (0x00-0x1F) and locate JSON start markers - Integrated cleaning logic into four Azure CLI methods:
GetCurrentAccountAsync,ListResourceGroupsAsync,ListAppServicePlansAsync, andListLocationsAsync - Added null/empty output validation after cleaning in all affected methods
src/Microsoft.Agents.A365.DevTools.Cli/Services/AzureCliService.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.Agents.A365.DevTools.Cli/Services/AzureCliService.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.Agents.A365.DevTools.Cli/Services/AzureCliService.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.Agents.A365.DevTools.Cli/Services/AzureCliService.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.Agents.A365.DevTools.Cli/Services/AzureCliService.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.Agents.A365.DevTools.Cli/Services/AzureCliService.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.Agents.A365.DevTools.Cli/Services/AzureCliService.cs
Outdated
Show resolved
Hide resolved
Added JSON output cleaning functionality to improve parsing of Azure CLI responses.
…aning - Added CleanAzureCliJsonOutput method to JsonDeserializationHelper - Updated AzureCliService, AzureAuthValidator, and BotConfigurator to use the shared helper - Removed duplicate CleanJsonOutput methods from individual services - Fixes JSON parsing errors when Azure CLI outputs control characters (0x0C) on Windows
src/Microsoft.Agents.A365.DevTools.Cli/Services/Helpers/JsonDeserializationHelper.cs
Show resolved
Hide resolved
src/Microsoft.Agents.A365.DevTools.Cli/Services/Helpers/JsonDeserializationHelper.cs
Show resolved
Hide resolved
src/Microsoft.Agents.A365.DevTools.Cli/Services/Helpers/JsonDeserializationHelper.cs
Show resolved
Hide resolved
…rom main - Added tenantId parameter back to GetAccessTokenAsync calls - Restored comprehensive error handling for delete endpoint failures - Re-added Microsoft.Agents.A365.DevTools.Cli.Exceptions using statement - Maintains JSON cleaning functionality while aligning with main branch changes
src/Microsoft.Agents.A365.DevTools.Cli/Services/Helpers/JsonDeserializationHelper.cs
Show resolved
Hide resolved
src/Microsoft.Agents.A365.DevTools.Cli/Services/Helpers/JsonDeserializationHelper.cs
Show resolved
Hide resolved
sellakumaran
reviewed
Dec 6, 2025
| // Remove control characters (0x00-0x1F except \r, \n, \t) | ||
| // These characters can appear in Azure CLI output on Windows | ||
| var cleaned = new System.Text.StringBuilder(output.Length); | ||
| foreach (char c in output) |
Contributor
There was a problem hiding this comment.
Do we know what is different with your tenant?
When would we get control characters?
In preview001 or ztaitest12 or testcsaa where we have been testing so far, we didn't see this. Wondering if this can have a negative impact for those tenants/users.
How do we ensure that?
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.
Added a method to clean JSON output from Azure CLI commands to remove control characters and non-JSON content.
The Problem
The error was caused by invalid control characters (specifically 0x0C - form feed character) in the Azure CLI output. When the tool ran az account show --output json, the output contained non-JSON characters that prevented successful JSON deserialization.