Share via


LcmConfigurationSetting Class

Definition

Configuration setting of LCM (Local Configuration Manager).

public class LcmConfigurationSetting : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.GuestConfiguration.Models.LcmConfigurationSetting>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.GuestConfiguration.Models.LcmConfigurationSetting>
public class LcmConfigurationSetting
type LcmConfigurationSetting = class
    interface IJsonModel<LcmConfigurationSetting>
    interface IPersistableModel<LcmConfigurationSetting>
type LcmConfigurationSetting = class
Public Class LcmConfigurationSetting
Implements IJsonModel(Of LcmConfigurationSetting), IPersistableModel(Of LcmConfigurationSetting)
Public Class LcmConfigurationSetting
Inheritance
LcmConfigurationSetting
Implements

Properties

ActionAfterReboot

Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration.

ConfigurationMode

Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect.

ConfigurationModeFrequencyInMins

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.

IsModuleOverwriteAllowed

If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false.

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.

RefreshFrequencyInMins

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.

Explicit Interface Implementations

IJsonModel<LcmConfigurationSetting>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<LcmConfigurationSetting>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<LcmConfigurationSetting>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<LcmConfigurationSetting>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<LcmConfigurationSetting>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to