Microsoft.GuestConfiguration guestConfigurationAssignments 2018-01-20-preview

Bicep resource definition

The guestConfigurationAssignments resource type is an extension resource, which means you can apply it to another resource.

Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.

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@2018-01-20-preview' = {
  name: 'string'
  location: 'string'
  scope: resourceSymbolicName
  properties: {
    guestConfiguration: {
      configurationParameter: {
        value: [
          {
          }
        ]
      }
      kind: 'DSC'
      name: 'string'
      type: 'string'
    }
  }
}

Property values

guestConfigurationAssignments

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

ConfigurationParameterList

ConfigurationParameter

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Quickstart templates

The following 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.

ARM template resource definition

The guestConfigurationAssignments resource type is an extension resource, which means you can apply it to another resource.

Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.

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": "2018-01-20-preview",
  "name": "string",
  "location": "string",
  "scope": "string",
  "properties": {
    "guestConfiguration": {
      "configurationParameter": {
        "value": [
          {
          }
        ]
      },
      "kind": "DSC",
      "name": "string",
      "type": "string"
    }
  }
}

Property values

guestConfigurationAssignments

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

ConfigurationParameterList

ConfigurationParameter

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Quickstart templates

The following 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 is an extension resource, which means you can apply it to another resource.

Use the parent_id property on this resource to set the scope for this resource.

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@2018-01-20-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      guestConfiguration = {
        configurationParameter = {
          value = [
            {
            }
          ]
        }
        kind = "DSC"
        name = "string"
        type = "string"
      }
    }
  })
}

Property values

guestConfigurationAssignments

GuestConfigurationAssignmentProperties

GuestConfigurationNavigation

ConfigurationParameterList

ConfigurationParameter

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.