AgentConfiguration interface

Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM.

Properties

configMode

Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft.

extensionsAllowList

Array of extensions that are allowed to be installed or updated.

extensionsBlockList

Array of extensions that are blocked (cannot be installed or updated)

extensionsEnabled

Specifies whether the extension service is enabled or disabled.

guestConfigurationEnabled

Specified whether the guest configuration service is enabled or disabled.

incomingConnectionsPorts

Specifies the list of ports that the agent will be able to listen on.

proxyBypass

List of service names which should not use the specified proxy server.

proxyUrl

Specifies the URL of the proxy to be used.

Property Details

configMode

Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft.

configMode?: string

Property Value

string

extensionsAllowList

Array of extensions that are allowed to be installed or updated.

extensionsAllowList?: ConfigurationExtension[]

Property Value

extensionsBlockList

Array of extensions that are blocked (cannot be installed or updated)

extensionsBlockList?: ConfigurationExtension[]

Property Value

extensionsEnabled

Specifies whether the extension service is enabled or disabled.

extensionsEnabled?: string

Property Value

string

guestConfigurationEnabled

Specified whether the guest configuration service is enabled or disabled.

guestConfigurationEnabled?: string

Property Value

string

incomingConnectionsPorts

Specifies the list of ports that the agent will be able to listen on.

incomingConnectionsPorts?: string[]

Property Value

string[]

proxyBypass

List of service names which should not use the specified proxy server.

proxyBypass?: string[]

Property Value

string[]

proxyUrl

Specifies the URL of the proxy to be used.

proxyUrl?: string

Property Value

string