Skip to main content

cli config set

Sets CLI for Microsoft 365 configuration options

Usage

m365 cli config set [options]

Options

-k, --key <key>

Config key to specify

-v, --value <value>

Config value to set

-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 is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--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 nameDefinitionDefault value
authTypeDefault login method to use when running m365 login without the --authType option.deviceCode
autoOpenLinksInBrowserAutomatically 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
clientIdID of the default Entra ID app use by the CLI to authenticate``
clientSecretSecret of the default Entra ID app use by the CLI to authenticate``
clientCertificateFilePath to the file containing the client certificate to use for authentication``
clientCertificateBase64EncodedBase64-encoded client certificate contents``
clientCertificatePasswordPassword to the client certificate file``
copyDeviceCodeToClipboardAutomatically copy the device code to the clipboard when running m365 login command in device code modefalse
csvEscapeSingle character used for escaping; only apply to characters matching the quote and the escape options"
csvHeaderDisplay the column names on the first linetrue
csvQuoteThe quote characters surrounding a field. An empty quote value will preserve the original field, whether it contains quotation marks or not.
csvQuotedQuote all the non-empty fields even if not requiredfalse
csvQuotedEmptyQuote empty strings and overrides quoted_string on empty strings when definedfalse
disableTelemetryDisables sending of telemetry datafalse
errorOutputDefines if errors should be written to stdout or stderrstderr
helpModeDefines what part of command's help to display. Allowed values are options, examples, remarks, response, fulloptions
helpTargetDefines the way the command help will be shown. Allowed values are console or web
outputDefines the default output when issuing a command. Allowed values are json, text, csv, md, nonejson
printErrorsAsPlainTextWhen output mode is set to json, print error messages as plain-text rather than JSONtrue
promptPrompts for missing values in required options and enables interactive selection when multiple values are available for a command that requires a specific value to be retrieved.true
promptListPageSizeBy default, lists of choices longer than 7 will be paginated. Use this option to control how many choices will appear on the screen at once.7
showHelpOnFailureAutomatically display help when executing a command failedtrue
tenantIdID of the default tenant to use when authenticating with``

Examples

Configure CLI to automatically display help when executing a command failed

m365 cli config set --key showHelpOnFailure --value true

Configure the default CLI output to JSON

m365 cli config set --key output --value json

Response

The command won't return a response on success.

More information

CTRL + M