Share via


IGuestConfigurationAssignment Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.GuestConfigurationAssignmentTypeConverter))]
public interface IGuestConfigurationAssignment : Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.IProxyResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.GuestConfigurationAssignmentTypeConverter))>]
type IGuestConfigurationAssignment = interface
    interface IJsonSerializable
    interface IProxyResource
    interface IResource
Public Interface IGuestConfigurationAssignment
Implements IProxyResource
Derived
Attributes
Implements

Properties

Name Description
AssignmentHash

Combined hash of the configuration package and parameters.

AssignmentName

Name of the guest configuration assignment.

ComplianceStatus

A value indicating compliance status of the machine for the assigned guest configuration.

ConfigurationName

Name of the 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.

ConfigurationVersion

Version of the configuration.

Context

The source which initiated the guest configuration assignment. Ex: Azure Policy

GuestConfigurationAssignmentType

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

GuestConfigurationContentHash

Combined hash of the guest configuration package and configuration parameters.

GuestConfigurationContentType

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

GuestConfigurationContentUri

Uri of the storage where guest configuration package is uploaded.

GuestConfigurationKind

Kind of the guest configuration. For example:DSC

GuestConfigurationName

Name of the guest configuration.

GuestConfigurationParameter

The configuration parameters for the guest configuration.

GuestConfigurationProtectedParameter

The protected configuration parameters for the guest configuration.

GuestConfigurationVersion

Version of the guest configuration.

Id

ARM resource id of the guest configuration assignment.

(Inherited from IResource)
LastComplianceStatusChecked

Date and time when last compliance status was checked.

LatestAssignmentReportComplianceStatus

A value indicating compliance status of the machine for the assigned guest configuration.

LatestAssignmentReportEndTime

End date and time of the guest configuration assignment compliance status check.

LatestAssignmentReportId

GUID that identifies the guest configuration assignment report under a subscription, resource group.

LatestAssignmentReportOperationType

Type of report, Consistency or Initial

LatestAssignmentReportResource

The list of resources for which guest configuration assignment compliance is checked.

LatestAssignmentReportStartTime

Start date and time of the guest configuration assignment compliance status check.

LatestReportId

Id of the latest report for the guest configuration assignment.

Location

Region where the VM is located.

(Inherited from IResource)
Name

Name of the guest configuration assignment.

(Inherited from IResource)
ParameterHash

parameter hash for the guest configuration assignment.

PropertiesLatestAssignmentReportId

ARM resource id of the report for the guest configuration assignment.

ProvisioningState

The provisioning state, which only appears in the response.

ResourceType

Type of the resource - VMSS / VM

Source

Specifies the origin of the configuration.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

TargetResourceId

VM resource Id.

Type

The type of the resource.

(Inherited from IResource)
VMId

Azure resource Id of the VM.

VmssVMList

The list of VM Compliance data for VMSS

VMUuid

UUID(Universally Unique Identifier) of the VM.

Methods

Name Description
ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to