Share via


GuestConfigurationNavigation Class

Definition

Guest configuration is an artifact that encapsulates DSC configuration and its dependencies. The artifact is a zip file containing DSC configuration (as MOF) and dependent resources and other dependencies like modules.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.GuestConfigurationNavigationTypeConverter))]
public class GuestConfigurationNavigation : Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.IGuestConfigurationNavigation
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.GuestConfigurationNavigationTypeConverter))>]
type GuestConfigurationNavigation = class
    interface IGuestConfigurationNavigation
    interface IJsonSerializable
Public Class GuestConfigurationNavigation
Implements IGuestConfigurationNavigation
Inheritance
GuestConfigurationNavigation
Attributes
Implements

Constructors

Name Description
GuestConfigurationNavigation()

Creates an new GuestConfigurationNavigation instance.

Properties

Name Description
AssignmentSource

Specifies the origin of the configuration.

AssignmentType

Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor.

ConfigurationParameter

The configuration parameters for the guest configuration.

ConfigurationProtectedParameter

The protected configuration parameters for the guest configuration.

ConfigurationSettingActionAfterReboot

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

ConfigurationSettingAllowModuleOverwrite

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

ConfigurationSettingConfigurationMode

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

ConfigurationSettingConfigurationModeFrequencyMin

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.

ConfigurationSettingRebootIfNeeded

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.

ConfigurationSettingRefreshFrequencyMin

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.

ContentHash

Combined hash of the guest configuration package and configuration parameters.

ContentType

Specifies the content type of the configuration. Possible values could be Builtin or Custom.

ContentUri

Uri of the storage where guest configuration package is uploaded.

Kind

Kind of the guest configuration. For example:DSC

Name

Name of the guest configuration.

Version

Version of the guest configuration.

Methods

Name Description
DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of GuestConfigurationNavigation.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of GuestConfigurationNavigation.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.IGuestConfigurationNavigation.

FromJsonString(String)

Creates a new instance of GuestConfigurationNavigation, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of GuestConfigurationNavigation into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to