Share via


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. NOTE: This property will not be serialized. It can only be populated by the server.

extensionsAllowList

Array of extensions that are allowed to be installed or updated. NOTE: This property will not be serialized. It can only be populated by the server.

extensionsBlockList

Array of extensions that are blocked (cannot be installed or updated) NOTE: This property will not be serialized. It can only be populated by the server.

extensionsEnabled

Specifies whether the extension service is enabled or disabled. NOTE: This property will not be serialized. It can only be populated by the server.

guestConfigurationEnabled

Specified whether the guest configuration service is enabled or disabled. NOTE: This property will not be serialized. It can only be populated by the server.

incomingConnectionsPorts

Specifies the list of ports that the agent will be able to listen on. NOTE: This property will not be serialized. It can only be populated by the server.

proxyBypass

List of service names which should not use the specified proxy server. NOTE: This property will not be serialized. It can only be populated by the server.

proxyUrl

Specifies the URL of the proxy to be used. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

configMode?: string

Property Value

string

extensionsAllowList

Array of extensions that are allowed to be installed or updated. NOTE: This property will not be serialized. It can only be populated by the server.

extensionsAllowList?: ConfigurationExtension[]

Property Value

extensionsBlockList

Array of extensions that are blocked (cannot be installed or updated) NOTE: This property will not be serialized. It can only be populated by the server.

extensionsBlockList?: ConfigurationExtension[]

Property Value

extensionsEnabled

Specifies whether the extension service is enabled or disabled. NOTE: This property will not be serialized. It can only be populated by the server.

extensionsEnabled?: string

Property Value

string

guestConfigurationEnabled

Specified whether the guest configuration service is enabled or disabled. NOTE: This property will not be serialized. It can only be populated by the server.

guestConfigurationEnabled?: string

Property Value

string

incomingConnectionsPorts

Specifies the list of ports that the agent will be able to listen on. NOTE: This property will not be serialized. It can only be populated by the server.

incomingConnectionsPorts?: string[]

Property Value

string[]

proxyBypass

List of service names which should not use the specified proxy server. NOTE: This property will not be serialized. It can only be populated by the server.

proxyBypass?: string[]

Property Value

string[]

proxyUrl

Specifies the URL of the proxy to be used. NOTE: This property will not be serialized. It can only be populated by the server.

proxyUrl?: string

Property Value

string