Skip to content

Add only_show_errors and no_color #1924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dbradish-microsoft merged 1 commit into from
Apr 27, 2020
Merged

Add only_show_errors and no_color #1924

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs-ref-conceptual/azure-cli-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,7 @@ see the [Python documentation on INI](https://docs.python.org/3/library/configpa
## CLI configuration values and environment variables

The following table contains all of the sections and option names that can be placed in a configuration file. Their corresponding
environment variables are set as `AZURE_{section}_{name}`, in all caps. For example, the `storage_account` default for `batchai` is set
in the `AZURE_BATCHAI_STORAGE_ACCOUNT` variable.
environment variables are set as `AZURE_{section}_{name}`, in all caps. For example, `output` default for `core` is set in the `AZURE_CORE_OUTPUT` variable, and the `storage_account` default for `batchai` is set in the `AZURE_BATCHAI_STORAGE_ACCOUNT` variable.

When you provide a default value, that argument is no longer required by any command. Instead, the default value is used.

Expand All @@ -88,6 +87,8 @@ When you provide a default value, that argument is no longer required by any com
| __core__ | output | string | The default output format. Can be one of `json`, `jsonc`, `tsv`, or `table`. |
| | disable\_confirm\_prompt | boolean | Turn confirmation prompts on/off. |
| | collect\_telemetry | boolean | Allow Microsoft to collect anonymous data on the usage of the CLI. For privacy information, see the [Azure CLI Terms of Use](https://aka.ms/AzureCliLegal). |
| | only\_show\_errors | boolean | Only show errors during command invocation. In other words, only errors will be written to `stderr`. It suppresses warnings from preview, deprecated and experimental commands. It is also available for individual commands with the `--only-show-errors` parameter. |
| | no\_color | boolean | Disable color. Originally colored messages will be prefixed with `DEBUG`, `INFO`, `WARNING` and `ERROR`. This bypasses the issue of a third-party library where the terminal's color cannot revert back after a `stdout` redirection. |
Copy link
Member Author

@jiasli jiasli Apr 10, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure whether we need to put the details of the context here, including the original issue.

Suggested change
| | no\_color | boolean | Disable color. Originally colored messages will be prefixed with `DEBUG`, `INFO`, `WARNING` and `ERROR`. This bypasses the issue of a third-party library where the terminal's color cannot revert back after a `stdout` redirection. |
| | no\_color | boolean | Disable color. Originally colored messages will be prefixed with `DEBUG`, `INFO`, `WARNING` and `ERROR`. This bypasses the issue of the third-party library colorama ([#200](https://github.com/tartley/colorama/issues/200)) where the terminal's color cannot revert back after a `stdout` redirection. |

| __logging__ | enable\_log\_file | boolean | Turn logging on/off. |
| | log\_dir | string | The directory to write logs to. By default this value is `${AZURE_CONFIG_DIR}/logs`. |
| __storage__ | connection\_string | string | The default connection string to use for `az storage` commands. |
Expand Down