cli config get¶
Gets value of a CLI for Microsoft 365 configuration option
Usage¶
m365 cli config get [options]
Options¶
-k, --key <key>
- Config key to get the value of
-h, --help [help]
- Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are
options
,examples
,remarks
,response
,full
. Default isfull
. --query [query]
- JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
- Output type.
json,text,csv,md
. Defaultjson
--verbose
- Runs command with verbose logging
--debug
- Runs command with debug logging
Available settings¶
Following is the list of configuration settings available in CLI for Microsoft 365.
Setting name | Definition | Default value |
---|---|---|
autoOpenLinksInBrowser |
Automatically open the browser for all commands which return a url and expect the user to copy paste this to the browser. For example when logging in, using m365 login in device code mode. |
false |
copyDeviceCodeToClipboard |
Automatically copy the device code to the clipboard when running m365 login command in device code mode |
false |
csvEscape |
Single character used for escaping; only apply to characters matching the quote and the escape options | " |
csvHeader |
Display the column names on the first line | true |
csvQuote |
The quote characters surrounding a field. An empty quote value will preserve the original field, whether it contains quotation marks or not. |
|
csvQuoted |
Quote all the non-empty fields even if not required | false |
csvQuotedEmpty |
Quote empty strings and overrides quoted_string on empty strings when defined | false |
disableTelemetry |
Disables sending of telemetry data | false |
errorOutput |
Defines if errors should be written to stdout or stderr |
stderr |
helpMode |
Defines what part of command's help to display. Allowed values are options , examples , remarks , response , full |
full |
output |
Defines the default output when issuing a command | json |
printErrorsAsPlainText |
When output mode is set to json , print error messages as plain-text rather than JSON |
true |
prompt |
Prompts for missing values in required options | false |
showHelpOnFailure |
Automatically display help when executing a command failed | true |
Remarks¶
If the specified setting has not been configured, CLI will return no output.
Examples¶
Get the output configured for CLI for Microsoft 365
m365 cli config get --key output
Response¶
When retrieving the output
key, responses will look like this:
"json"
json
json