Microsoft.GuestConfiguration guestConfigurationAssignments 2021-01-25

Article
12/09/2024

Bicep resource definition

The guestConfigurationAssignments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.GuestConfiguration/guestConfigurationAssignments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    context: 'string'
    guestConfiguration: {
      assignmentType: 'string'
      configurationParameter: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      configurationProtectedParameter: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      configurationSetting: {
        actionAfterReboot: 'string'
        allowModuleOverwrite: bool
        configurationMode: 'string'
        configurationModeFrequencyMins: int
        rebootIfNeeded: bool
        refreshFrequencyMins: int
      }
      contentHash: 'string'
      contentUri: 'string'
      kind: 'string'
      name: 'string'
      version: 'string'
    }
    latestAssignmentReport: {
      assignment: {
        configuration: {}
      }
      resources: [
        {
          reasons: [
            {}
          ]
        }
      ]
      vm: {}
    }
    vmssVMList: [
      {}
    ]
  }
}

Property Values

AssignmentInfo

Name	Description	Value
configuration	Information about the configuration.	ConfigurationInfo

AssignmentReport

Name	Description	Value
assignment	Configuration details of the guest configuration assignment.	AssignmentInfo
resources	The list of resources for which guest configuration assignment compliance is checked.	AssignmentReportResource[]
vm	Information about the VM.	VMInfo

AssignmentReportResource

Name	Description	Value
reasons	Compliance reason and reason code for a resource.	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Name	Description	Value

ConfigurationInfo

Name	Description	Value

ConfigurationParameter

Name	Description	Value
name	Name of the configuration parameter.	string
value	Value of the configuration parameter.	string

ConfigurationSetting

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

GuestConfigurationAssignmentProperties

Name	Description	Value
context	The source which initiated the guest configuration assignment. Ex: Azure Policy	string
guestConfiguration	The guest configuration to assign.	GuestConfigurationNavigation
latestAssignmentReport	Last reported guest configuration assignment report.	AssignmentReport
vmssVMList	The list of VM Compliance data for VMSS	VmssvmInfo[]

GuestConfigurationNavigation

Name	Description	Value
assignmentType	Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor.	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Audit' 'DeployAndAutoCorrect'
configurationParameter	The configuration parameters for the guest configuration.	ConfigurationParameter[]
configurationProtectedParameter	The protected configuration parameters for the guest configuration.	ConfigurationParameter[]
configurationSetting	The configuration setting for the guest configuration.	ConfigurationSetting
contentHash	Combined hash of the guest configuration package and configuration parameters.	string
contentUri	Uri of the storage where guest configuration package is uploaded.	string
kind	Kind of the guest configuration. For example:DSC	'DSC'
name	Name of the guest configuration.	string
version	Version of the guest configuration.	string

Microsoft.GuestConfiguration/guestConfigurationAssignments

Name	Description	Value
location	Region where the VM is located.	string
name	The resource name	string (required)
properties	Properties of the Guest configuration assignment.	GuestConfigurationAssignmentProperties
scope	Use when creating a resource at a scope that is different than the deployment scope.	Set this property to the symbolic name of a resource to apply the extension resource.

VMInfo

Name	Description	Value

VmssvmInfo

Name	Description	Value

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File	Description
IIS VMs & SQL Server 2014 VM	Create 1 or 2 IIS Windows 2012 R2 Web Servers and one back end SQL Server 2014 in VNET.
Windows VM with Azure secure baseline	The template creates a virtual machine running Windows Server in a new virtual network, with a public IP address. Once the machine has deployed, the guest configuration extension is installed and the Azure secure baseline for Windows Server is applied. If the configuration of the machines drifts, you can re-apply the settings by deploying the template again.

ARM template resource definition

The guestConfigurationAssignments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.GuestConfiguration/guestConfigurationAssignments resource, add the following JSON to your template.

{
  "type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
  "apiVersion": "2021-01-25",
  "name": "string",
  "location": "string",
  "properties": {
    "context": "string",
    "guestConfiguration": {
      "assignmentType": "string",
      "configurationParameter": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "configurationProtectedParameter": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "configurationSetting": {
        "actionAfterReboot": "string",
        "allowModuleOverwrite": "bool",
        "configurationMode": "string",
        "configurationModeFrequencyMins": "int",
        "rebootIfNeeded": "bool",
        "refreshFrequencyMins": "int"
      },
      "contentHash": "string",
      "contentUri": "string",
      "kind": "string",
      "name": "string",
      "version": "string"
    },
    "latestAssignmentReport": {
      "assignment": {
        "configuration": {
        }
      },
      "resources": [
        {
          "reasons": [
            {
            }
          ]
        }
      ],
      "vm": {
      }
    },
    "vmssVMList": [
      {
      }
    ]
  }
}

Property Values

AssignmentInfo

Name	Description	Value
configuration	Information about the configuration.	ConfigurationInfo

AssignmentReport

Name	Description	Value
assignment	Configuration details of the guest configuration assignment.	AssignmentInfo
resources	The list of resources for which guest configuration assignment compliance is checked.	AssignmentReportResource[]
vm	Information about the VM.	VMInfo

AssignmentReportResource

Name	Description	Value
reasons	Compliance reason and reason code for a resource.	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Name	Description	Value

ConfigurationInfo

Name	Description	Value

ConfigurationParameter

Name	Description	Value
name	Name of the configuration parameter.	string
value	Value of the configuration parameter.	string

ConfigurationSetting

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

GuestConfigurationAssignmentProperties

Name	Description	Value
context	The source which initiated the guest configuration assignment. Ex: Azure Policy	string
guestConfiguration	The guest configuration to assign.	GuestConfigurationNavigation
latestAssignmentReport	Last reported guest configuration assignment report.	AssignmentReport
vmssVMList	The list of VM Compliance data for VMSS	VmssvmInfo[]

GuestConfigurationNavigation

Name	Description	Value
assignmentType	Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor.	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Audit' 'DeployAndAutoCorrect'
configurationParameter	The configuration parameters for the guest configuration.	ConfigurationParameter[]
configurationProtectedParameter	The protected configuration parameters for the guest configuration.	ConfigurationParameter[]
configurationSetting	The configuration setting for the guest configuration.	ConfigurationSetting
contentHash	Combined hash of the guest configuration package and configuration parameters.	string
contentUri	Uri of the storage where guest configuration package is uploaded.	string
kind	Kind of the guest configuration. For example:DSC	'DSC'
name	Name of the guest configuration.	string
version	Version of the guest configuration.	string

Microsoft.GuestConfiguration/guestConfigurationAssignments

Name	Description	Value
apiVersion	The api version	'2021-01-25'
location	Region where the VM is located.	string
name	The resource name	string (required)
properties	Properties of the Guest configuration assignment.	GuestConfigurationAssignmentProperties
type	The resource type	'Microsoft.GuestConfiguration/guestConfigurationAssignments'

VMInfo

Name	Description	Value

VmssvmInfo

Name	Description	Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
IIS VMs & SQL Server 2014 VM	Create 1 or 2 IIS Windows 2012 R2 Web Servers and one back end SQL Server 2014 in VNET.
Windows VM with Azure secure baseline	The template creates a virtual machine running Windows Server in a new virtual network, with a public IP address. Once the machine has deployed, the guest configuration extension is installed and the Azure secure baseline for Windows Server is applied. If the configuration of the machines drifts, you can re-apply the settings by deploying the template again.

Terraform (AzAPI provider) resource definition

The guestConfigurationAssignments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.GuestConfiguration/guestConfigurationAssignments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25"
  name = "string"
  parent_id = "string"
  location = "string"
  body = jsonencode({
    properties = {
      context = "string"
      guestConfiguration = {
        assignmentType = "string"
        configurationParameter = [
          {
            name = "string"
            value = "string"
          }
        ]
        configurationProtectedParameter = [
          {
            name = "string"
            value = "string"
          }
        ]
        configurationSetting = {
          actionAfterReboot = "string"
          allowModuleOverwrite = bool
          configurationMode = "string"
          configurationModeFrequencyMins = int
          rebootIfNeeded = bool
          refreshFrequencyMins = int
        }
        contentHash = "string"
        contentUri = "string"
        kind = "string"
        name = "string"
        version = "string"
      }
      latestAssignmentReport = {
        assignment = {
          configuration = {
          }
        }
        resources = [
          {
            reasons = [
              {
              }
            ]
          }
        ]
        vm = {
        }
      }
      vmssVMList = [
        {
        }
      ]
    }
  })
}

Property Values

AssignmentInfo

Name	Description	Value
configuration	Information about the configuration.	ConfigurationInfo

AssignmentReport

Name	Description	Value
assignment	Configuration details of the guest configuration assignment.	AssignmentInfo
resources	The list of resources for which guest configuration assignment compliance is checked.	AssignmentReportResource[]
vm	Information about the VM.	VMInfo

AssignmentReportResource

Name	Description	Value
reasons	Compliance reason and reason code for a resource.	AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Name	Description	Value

ConfigurationInfo

Name	Description	Value

ConfigurationParameter

Name	Description	Value
name	Name of the configuration parameter.	string
value	Value of the configuration parameter.	string

ConfigurationSetting

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

GuestConfigurationAssignmentProperties

Name	Description	Value
context	The source which initiated the guest configuration assignment. Ex: Azure Policy	string
guestConfiguration	The guest configuration to assign.	GuestConfigurationNavigation
latestAssignmentReport	Last reported guest configuration assignment report.	AssignmentReport
vmssVMList	The list of VM Compliance data for VMSS	VmssvmInfo[]

GuestConfigurationNavigation

Name	Description	Value
assignmentType	Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor.	'ApplyAndAutoCorrect' 'ApplyAndMonitor' 'Audit' 'DeployAndAutoCorrect'
configurationParameter	The configuration parameters for the guest configuration.	ConfigurationParameter[]
configurationProtectedParameter	The protected configuration parameters for the guest configuration.	ConfigurationParameter[]
configurationSetting	The configuration setting for the guest configuration.	ConfigurationSetting
contentHash	Combined hash of the guest configuration package and configuration parameters.	string
contentUri	Uri of the storage where guest configuration package is uploaded.	string
kind	Kind of the guest configuration. For example:DSC	'DSC'
name	Name of the guest configuration.	string
version	Version of the guest configuration.	string

Microsoft.GuestConfiguration/guestConfigurationAssignments

Name	Description	Value
location	Region where the VM is located.	string
name	The resource name	string (required)
parent_id	The ID of the resource to apply this extension resource to.	string (required)
properties	Properties of the Guest configuration assignment.	GuestConfigurationAssignmentProperties
type	The resource type	"Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25"

VMInfo

Name	Description	Value

VmssvmInfo

Name	Description	Value

Share via

Microsoft.GuestConfiguration guestConfigurationAssignments 2021-01-25

Bicep resource definition

Resource format

Property Values

AssignmentInfo

AssignmentReport

AssignmentReportResource

AssignmentReportResourceComplianceReason

ConfigurationInfo

ConfigurationParameter

ConfigurationSetting

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

Microsoft.GuestConfiguration/guestConfigurationAssignments

VMInfo

VmssvmInfo

Usage Examples

Azure Quickstart Samples

ARM template resource definition

Resource format

Property Values

AssignmentInfo

AssignmentReport

AssignmentReportResource

AssignmentReportResourceComplianceReason

ConfigurationInfo

ConfigurationParameter

ConfigurationSetting

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

Microsoft.GuestConfiguration/guestConfigurationAssignments

VMInfo

VmssvmInfo

Usage Examples

Azure Quickstart Templates

Terraform (AzAPI provider) resource definition

Resource format

Property Values

AssignmentInfo

AssignmentReport

AssignmentReportResource

AssignmentReportResourceComplianceReason

ConfigurationInfo

ConfigurationParameter

ConfigurationSetting

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

Microsoft.GuestConfiguration/guestConfigurationAssignments

VMInfo

VmssvmInfo

Feedback

Additional resources