azcmagent config
Configure settings for the Azure connected machine agent. Configurations are stored locally and are unique to each machine. Available configuration properties vary by agent version. Use azcmagent config info to see all available configuration properties and supported values for the currently installed agent.
Commands
| Command | Purpose |
|---|---|
| azcmagent config clear | Clear a configuration property's value |
| azcmagent config get | Gets a configuration property's value |
| azcmagent config info | Describes all available configuration properties and supported values |
| azcmagent config list | Lists all configuration properties and values |
| azcmagent config set | Set a value for a configuration property |
azcmagent config clear
Clear a configuration property's value and reset it to its default state.
Usage
azcmagent config clear [property] [flags]
Examples
Clear the proxy server URL property.
azcmagent config clear proxy.url
Flags
Common flags available for all commands
--config
Takes in a path to a JSON or YAML file containing inputs to the command. The configuration file should contain a series of key-value pairs where the key matches an available command line option. For example, to pass in the --verbose flag, the configuration file would look like:
{
"verbose": true
}
If a command line option is found in both the command invocation and a configuration file, the value specified on the command line will take precedence.
-h, --help
Get help for the current command, including its syntax and command line options.
-j, --json
Output the command result in the JSON format.
--log-stderr
Redirect error and verbose messages to the standard error (stderr) stream. By default, all output is sent to the standard output (stdout) stream.
--no-color
Disable color output for terminals that do not support ANSI colors.
-v, --verbose
Show more detailed logging information while the command executes. Useful for troubleshooting issues when running a command.
azcmagent config get
Get a configuration property's value.
Usage
azcmagent config get [property] [flags]
Examples
Get the agent mode.
azcmagent config get config.mode
Flags
Common flags available for all commands
--config
Takes in a path to a JSON or YAML file containing inputs to the command. The configuration file should contain a series of key-value pairs where the key matches an available command line option. For example, to pass in the --verbose flag, the configuration file would look like:
{
"verbose": true
}
If a command line option is found in both the command invocation and a configuration file, the value specified on the command line will take precedence.
-h, --help
Get help for the current command, including its syntax and command line options.
-j, --json
Output the command result in the JSON format.
--log-stderr
Redirect error and verbose messages to the standard error (stderr) stream. By default, all output is sent to the standard output (stdout) stream.
--no-color
Disable color output for terminals that do not support ANSI colors.
-v, --verbose
Show more detailed logging information while the command executes. Useful for troubleshooting issues when running a command.
azcmagent config info
Describes available configuration properties and supported values. When run without specifying a specific property, the command describes all available properties their supported values.
Usage
azcmagent config info [property] [flags]
Examples
Describe all available configuration properties and supported values.
azcmagent config info
Learn more about the extensions allowlist property and its supported values.
azcmagent config info extensions.allowlist
Flags
Common flags available for all commands
--config
Takes in a path to a JSON or YAML file containing inputs to the command. The configuration file should contain a series of key-value pairs where the key matches an available command line option. For example, to pass in the --verbose flag, the configuration file would look like:
{
"verbose": true
}
If a command line option is found in both the command invocation and a configuration file, the value specified on the command line will take precedence.
-h, --help
Get help for the current command, including its syntax and command line options.
-j, --json
Output the command result in the JSON format.
--log-stderr
Redirect error and verbose messages to the standard error (stderr) stream. By default, all output is sent to the standard output (stdout) stream.
--no-color
Disable color output for terminals that do not support ANSI colors.
-v, --verbose
Show more detailed logging information while the command executes. Useful for troubleshooting issues when running a command.
azcmagent config list
Lists all configuration properties and their current values
Usage
azcmagent config list [flags]
Examples
List the current agent configuration.
azcmagent config list
Flags
Common flags available for all commands
--config
Takes in a path to a JSON or YAML file containing inputs to the command. The configuration file should contain a series of key-value pairs where the key matches an available command line option. For example, to pass in the --verbose flag, the configuration file would look like:
{
"verbose": true
}
If a command line option is found in both the command invocation and a configuration file, the value specified on the command line will take precedence.
-h, --help
Get help for the current command, including its syntax and command line options.
-j, --json
Output the command result in the JSON format.
--log-stderr
Redirect error and verbose messages to the standard error (stderr) stream. By default, all output is sent to the standard output (stdout) stream.
--no-color
Disable color output for terminals that do not support ANSI colors.
-v, --verbose
Show more detailed logging information while the command executes. Useful for troubleshooting issues when running a command.
azcmagent config set
Set a value for a configuration property.
Usage
azcmagent config set [property] [value] [flags]
Examples
Configure the agent to use a proxy server.
azcmagent config set proxy.url "http://proxy.contoso.corp:8080"
Append an extension to the extension allowlist.
azcmagent config set extensions.allowlist "Microsoft.Azure.Monitor/AzureMonitorWindowsAgent" --add
Flags
-a, --add
Append the value to the list of existing values. If not specified, the default behavior is to replace the list of existing values. This flag is only supported for configuration properties that support more than one value. Can't be used with the --remove flag.
-r, --remove
Remove the specified value from the list, retaining all other values. If not specified, the default behavior is to replace the list of existing values. This flag is only supported for configuration properties that support more than one value. Can't be used in conjunction with the --add flag.
Common flags available for all commands
--config
Takes in a path to a JSON or YAML file containing inputs to the command. The configuration file should contain a series of key-value pairs where the key matches an available command line option. For example, to pass in the --verbose flag, the configuration file would look like:
{
"verbose": true
}
If a command line option is found in both the command invocation and a configuration file, the value specified on the command line will take precedence.
-h, --help
Get help for the current command, including its syntax and command line options.
-j, --json
Output the command result in the JSON format.
--log-stderr
Redirect error and verbose messages to the standard error (stderr) stream. By default, all output is sent to the standard output (stdout) stream.
--no-color
Disable color output for terminals that do not support ANSI colors.
-v, --verbose
Show more detailed logging information while the command executes. Useful for troubleshooting issues when running a command.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for