Class ConfigurationSetting

Configuration setting of LCM (Local Configuration Manager).

Inheritance

Object

ConfigurationSetting

Namespace: System.Dynamic.ExpandoObject

Assembly: Microsoft.Azure.Management.GuestConfiguration.dll

Syntax

public class ConfigurationSetting

Constructors

ConfigurationSetting()

Initializes a new instance of the ConfigurationSetting class.

Declaration

public ConfigurationSetting ();

ConfigurationSetting(String, String, String, Nullable<Double>, String, Nullable<Double>)

Initializes a new instance of the ConfigurationSetting class.

Declaration

public ConfigurationSetting (string configurationMode = null, string allowModuleOverwrite = null, string actionAfterReboot = null, Nullable<double> refreshFrequencyMins = null, string rebootIfNeeded = null, Nullable<double> configurationModeFrequencyMins = null);

Parameters

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

String allowModuleOverwrite If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false. Possible values include: 'True', 'False'

String actionAfterReboot Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration. Possible values include: 'ContinueConfiguration', 'StopConfiguration'

Nullable<Double> 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.

String 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. Possible values include: 'True', 'False'

Nullable<Double> 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.

Properties

ActionAfterReboot

Gets specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration. Possible values include: 'ContinueConfiguration', 'StopConfiguration'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="actionAfterReboot")]
public string ActionAfterReboot { get; }

Property Value

String

AllowModuleOverwrite

Gets or sets if true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false. Possible values include: 'True', 'False'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="allowModuleOverwrite")]
public string AllowModuleOverwrite { get; set; }

Property Value

String

ConfigurationMode

Gets specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. Possible values include: 'ApplyOnly', 'ApplyAndMonitor', 'ApplyAndAutoCorrect'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="configurationMode")]
public string ConfigurationMode { get; }

Property Value

String

ConfigurationModeFrequencyMins

Gets 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.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="configurationModeFrequencyMins")]
public Nullable<double> ConfigurationModeFrequencyMins { get; }

Property Value

Nullable<Double>

RebootIfNeeded

Gets 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. Possible values include: 'True', 'False'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="rebootIfNeeded")]
public string RebootIfNeeded { get; }

Property Value

String

RefreshFrequencyMins

Gets 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.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="refreshFrequencyMins")]
public Nullable<double> RefreshFrequencyMins { get; }

Property Value

Nullable<Double>