Share via

ConfigurationSetting interface

  • Reference
Package:
@azure/arm-guestconfiguration

Configuration setting of LCM (Local Configuration Manager).

Properties

actionAfterReboot

Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration NOTE: This property will not be serialized. It can only be populated by the server.
allowModuleOverwrite

If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false NOTE: This property will not be serialized. It can only be populated by the server.
configurationMode

Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. NOTE: This property will not be serialized. It can only be populated by the server.
configurationModeFrequencyMins

How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. NOTE: This property will not be serialized. It can only be populated by the server.
rebootIfNeeded

Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. NOTE: This property will not be serialized. It can only be populated by the server.
refreshFrequencyMins

The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

actionAfterReboot

Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration NOTE: This property will not be serialized. It can only be populated by the server.

actionAfterReboot?: string

Property Value

string

allowModuleOverwrite

If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false NOTE: This property will not be serialized. It can only be populated by the server.

allowModuleOverwrite?: boolean

Property Value

boolean

configurationMode

Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. NOTE: This property will not be serialized. It can only be populated by the server.

configurationMode?: string

Property Value

string

configurationModeFrequencyMins

How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. NOTE: This property will not be serialized. It can only be populated by the server.

configurationModeFrequencyMins?: number

Property Value

number

rebootIfNeeded

Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. NOTE: This property will not be serialized. It can only be populated by the server.

rebootIfNeeded?: boolean

Property Value

boolean

refreshFrequencyMins

The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. NOTE: This property will not be serialized. It can only be populated by the server.

refreshFrequencyMins?: number

Property Value

number