Microsoft.GuestConfiguration guestConfigurationAssignments 2018-01-20-preview

• Latest
• 2024-04-05
• 2022-01-25
• 2021-01-25
• 2020-06-25
• 2018-11-20
• 2018-06-30-preview
• 2018-01-20-preview

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

Property Values

ConfigurationParameter

Name	Description	Value

ConfigurationParameterList

Name	Description	Value
value	Represents the list for configuration parameters.	ConfigurationParameter[]

GuestConfigurationAssignmentProperties

Name	Description	Value
guestConfiguration	The guest configuration to assign.	GuestConfigurationNavigation

GuestConfigurationNavigation

Name	Description	Value
configurationParameter	The configuration parameters for the guest configuration.	ConfigurationParameterList
kind	Kind of the guest configuration. For example:DSC	'DSC'
name	Name of the guest configuration.	string
type	Type 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.

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

Property Values

ConfigurationParameter

Name	Description	Value

ConfigurationParameterList

Name	Description	Value
value	Represents the list for configuration parameters.	ConfigurationParameter[]

GuestConfigurationAssignmentProperties

Name	Description	Value
guestConfiguration	The guest configuration to assign.	GuestConfigurationNavigation

GuestConfigurationNavigation

Name	Description	Value
configurationParameter	The configuration parameters for the guest configuration.	ConfigurationParameterList
kind	Kind of the guest configuration. For example:DSC	'DSC'
name	Name of the guest configuration.	string
type	Type of the guest configuration.	string

Microsoft.GuestConfiguration/guestConfigurationAssignments

Name	Description	Value
apiVersion	The api version	'2018-01-20-preview'
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'

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

Property Values

ConfigurationParameter

Name	Description	Value

ConfigurationParameterList

Name	Description	Value
value	Represents the list for configuration parameters.	ConfigurationParameter[]

GuestConfigurationAssignmentProperties

Name	Description	Value
guestConfiguration	The guest configuration to assign.	GuestConfigurationNavigation

GuestConfigurationNavigation

Name	Description	Value
configurationParameter	The configuration parameters for the guest configuration.	ConfigurationParameterList
kind	Kind of the guest configuration. For example:DSC	'DSC'
name	Name of the guest configuration.	string
type	Type 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@2018-01-20-preview"