Add azd config options command for config discoverability
#6390
+558
−0
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
Co-authored-by: spboyer <7681382+spboyer@users.noreply.github.com>
Co-authored-by: spboyer <7681382+spboyer@users.noreply.github.com>
Co-authored-by: spboyer <7681382+spboyer@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add command to list all possible azd config settings
Add Dec 17, 2025
azd config options command for config discoverability
Member
|
@copilot does this also encompass the possible ENV values that azd uses for configs and feature flags? |
Co-authored-by: spboyer <7681382+spboyer@users.noreply.github.com>
Contributor
Author
Yes! I've updated the implementation to include environment variable information. The output now shows:
The command output now includes an "Environment Variable" column in table format, and the Commit: f20cebb Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Member
|
@copilot show what the command is and the help looks like for the command. |
Contributor
Author
Command Usageazd config optionsHelp OutputThe command appears in Output ExamplesTable format (default): JSON format: $ azd config options -o json | jq '.[0:2]'
[
{
"Key": "defaults.subscription",
"Description": "Default Azure subscription ID to use for operations.",
"Type": "string",
"AllowedValues": null,
"Example": "00000000-0000-0000-0000-000000000000",
"EnvVar": ""
},
{
"Key": "alpha.all",
"Description": "Enable or disable all alpha features at once.",
"Type": "string",
"AllowedValues": ["on", "off"],
"EnvVar": "AZD_ALPHA_ENABLE_ALL"
}
]Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Member
|
@copilot in the output of the command, the table, can we also show the current value that is set. |
Co-authored-by: spboyer <7681382+spboyer@users.noreply.github.com>
Contributor
Author
Added! The table now includes a "Current Value" column that shows the currently configured value for each setting. Example output with some values set: The column displays:
Commit: 6accc32 Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
spboyer
requested review from
hemarina,
vhvb1989,
wbreza and
weikanglim
as code owners
Member
|
/azp run azure-dev - cli |
|
Azure Pipelines successfully started running 1 pipeline(s). |
weikanglim
reviewed
Jan 7, 2026
weikanglim
reviewed
Jan 7, 2026
cli/azd/cmd/config.go
Outdated
| }) | ||
| } | ||
|
|
||
| columns := []output.Column{ |
Contributor
There was a problem hiding this comment.
Real hard to read when wrapped:
Collaborator
There was a problem hiding this comment.
I was about to leave the same comment. If all of these columns are important, I would recommend making the display a JSON format by default, rather than a table.
If we want a table, I think the columns should just be "Variable", "Current Value", "Allowed Values". Add a link to the docs for the description and examples, or add a tag --verbose for full content.
Member
There was a problem hiding this comment.
JSON is not very readable, linking to docs is meh experience. User could just expand their window :-)
Contributor
There was a problem hiding this comment.
The GUIDs in the Current Value and Example columns (defaults.subscription key) are making those columns extra wide and hard to read when wrapped. On my typical VS Code setup (left sidebar, window fully maximized), the output still wraps:
I feel that Current Value would make most sense to omit, since users can use azd config get? We don't include the current value in azd config options --output json either. Otherwise, JSON feels more readable to me.
Contributor
There was a problem hiding this comment.
The way we format azd config list-alpha feels more readable to me as well:
$ azd config list-alpha
Name: aca.persistDomains
Description: Do not change custom domains when deploying Azure Container Apps.
Status: Off
Name: aca.persistIngressSessionAffinity
Description: Do not change Ingress Session Affinity when deploying Azure Container Apps.
Status: Off
Name: aks.helm
Description: Enable Helm support for AKS deployments.
Status: Off
Name: aks.kustomize
Description: Enable Kustomize support for AKS deployments.
Status: Off
Name: azd.operations
Description: Extends provisioning providers with azd operations.
Status: Off
Name: deployment.stacks
Description: Enables Azure deployment stacks for ARM/Bicep based deployments.
Status: On
Name: language.custom
Description: Enables support for services to use custom language.
Status: Off
Name: llm
Description: Enables the use of LLMs in the CLI.
Status: Off
Contributor
Author
There was a problem hiding this comment.
Changed the default output format to a readable list format similar to azd config list-alpha. The new format:
- Shows one option per section with key/value pairs
- Much easier to read and doesn't wrap
- Removed Current Value from default output (users can use
azd config get) - Table format still available with
-o table
New default output:
Key: defaults.subscription
Description: Default Azure subscription ID to use for operations.
Example: 00000000-0000-0000-0000-000000000000
Key: alpha.all
Description: Enable or disable all alpha features at once.
Allowed Values: on, off
Environment Variable: AZD_ALPHA_ENABLE_ALL
Member
There was a problem hiding this comment.
How about reducing detail in the list view and adding a show command for more info on a single command?
$ azd config options
Key Type Current Value Environment Variable
defaults.subscription string XXXX-XXXX-12313
defaults.location string eastus2
alpha.all string AZD_ALPHA_ENABLE_ALL
alpha.llm string on AZD_ALPHA_ENABLE_LLM
alpha.language.custom string off AZD_ALPHA_ENABLE_LANGUAGE_CUSTOM
(env) AZD_CONFIG_DIR envvar
$azd config show alpha.all
Key: alpha.all
Description: Enable or disable all alpha features at once.
Allowed Values: on, off
Environment Variable: AZD_ALPHA_ENABLE_ALL
@SophCarp thoughts?
Collaborator
There was a problem hiding this comment.
We already have azd config show:
azd config show shows your current configurations (which honestly I think should be azd config list but that's beside the point).
I guess you could do azd config options list and azd config options show to get the table and then the details of one specific one, but that also means 3 nouns before the verb rather than 2. We do have some of those already ( ex: azd template source list ) but not too may. Doing this would also make command be a verb which we try to maintain.
Member
There was a problem hiding this comment.
show returns everything in JSON, does not take a parameter for a specific one nor does it offer a format like az i.e. az group list -o table
No, I am not in favor of adding an addition verb here either.
Contributor
There was a problem hiding this comment.
The latest iteration seems good to me. There's some overlap between command descriptions if we want to differentiate between get, options and show a bit more:
get : Gets a configuration.
list-alpha : Display the list of available features in alpha stage.
options : List all available configuration settings.
show : Show all the configuration values.
Collaborator
|
|
Member
@copilot address the help properly for |
- Add getCmdConfigOptionsHelpFooter function with usage examples - Include examples for table format, JSON format, and setting config values - Update usage test snapshots to include new help examples - Improves discoverability and user experience for the new command Co-authored-by: spboyer <7681382+spboyer@users.noreply.github.com>
Contributor
Author
Fixed! Added proper help examples for The help now includes:
Commit: 2baf73e Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
- Change default format from table to list format similar to list-alpha - Table format is still available with -o table flag - List format is much more readable and doesn't wrap on normal terminals - Remove Current Value column from default output (users can use azd config get) - Update help examples to reflect new default format - Update usage test snapshots Addresses feedback about table readability issues from @JeffreyCA and @SophCarp Co-authored-by: spboyer <7681382+spboyer@users.noreply.github.com>
- Add tests for JSON format output - Add tests for table format output - Add tests for default list format output - Tests verify expected config options are present - Tests verify output contains correct fields Addresses test coverage feedback from @spboyer Co-authored-by: spboyer <7681382+spboyer@users.noreply.github.com>
Contributor
Author
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Contributor
|
@copilot Can you check the formatting:
And also make sure all snapshots are up to date by running this from
|
- Remove trailing whitespace and fix indentation - All formatting issues resolved Addresses feedback from @JeffreyCA Co-authored-by: JeffreyCA <9157833+JeffreyCA@users.noreply.github.com>
Contributor
Author
Fixed!
Commit: d049097 Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Contributor
|
/azp run azure-dev - cli |
|
Azure Pipelines successfully started running 1 pipeline(s). |
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
Jan 13, 2026
weikanglim
approved these changes
Jan 13, 2026
JeffreyCA
approved these changes
Jan 13, 2026
Contributor
|
/check-enforcer override |
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.
Implementation Plan: Add
azd config optionscommandazd config optionscommand actionChanges Made
resources/config_options.yamlwith all config settingspkg/config/config_options.goto load and expose config optionsazd config optionscommand with JSON and table output formatspkg/config/config_options_test.gocmd/config_options_test.go-o tableCommand Output
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.