ConfigurationSetting Class

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.Api20220125

Assembly:: Az.GuestConfiguration.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Configuration setting of LCM (Local Configuration Manager).

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.Api20220125.ConfigurationSettingTypeConverter))]
public class ConfigurationSetting : Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.Api20220125.IConfigurationSetting

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.Api20220125.ConfigurationSettingTypeConverter))>]
type ConfigurationSetting = class
    interface IConfigurationSetting
    interface IJsonSerializable

Public Class ConfigurationSetting
Implements IConfigurationSetting

Inheritance: Object
ConfigurationSetting

Attributes: TypeConverterAttribute

Implements: IConfigurationSetting IJsonSerializable

Constructors

Name	Description
ConfigurationSetting()	Creates an new ConfigurationSetting instance.

Properties

Name	Description
ActionAfterReboot	Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration
AllowModuleOverwrite	If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false
ConfigurationMode	Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect.
ConfigurationModeFrequencyMin	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.
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.
RefreshFrequencyMin	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.

Methods

Name	Description
DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of ConfigurationSetting.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of ConfigurationSetting.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.Api20220125.IConfigurationSetting.
FromJsonString(String)	Creates a new instance of ConfigurationSetting, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of ConfigurationSetting into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()

Applies to