Share via

Microsoft.Maintenance configurationAssignments

  • Article

Bicep resource definition

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

The configurationAssignments 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.Maintenance/configurationAssignments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Maintenance/configurationAssignments@2023-04-01' = {
  name: 'string'
  location: 'string'
  scope: resourceSymbolicName
  properties: {
    filter: {
      locations: [
        'string'
      ]
      osTypes: [
        'string'
      ]
      resourceGroups: [
        'string'
      ]
      resourceTypes: [
        'string'
      ]
      tagSettings: {
        filterOperator: 'string'
        tags: {}
      }
    }
    maintenanceConfigurationId: 'string'
    resourceId: 'string'
  }
}

Property values

configurationAssignments

Name Description Value
name The resource name string (required)
location Location of the resource string
scope Use when creating an extension resource at a scope that is different than the deployment scope. Target resource

For Bicep, set this property to the symbolic name of the resource to apply the extension resource.
properties Properties of the configuration assignment ConfigurationAssignmentProperties

ConfigurationAssignmentProperties

Name Description Value
filter Properties of the configuration assignment ConfigurationAssignmentFilterProperties
maintenanceConfigurationId The maintenance configuration Id string
resourceId The unique resourceId string

ConfigurationAssignmentFilterProperties

Name Description Value
locations List of locations to scope the query to. string[]
osTypes List of allowed operating systems. string[]
resourceGroups List of allowed resource groups. string[]
resourceTypes List of allowed resources. string[]
tagSettings Tag settings for the VM. TagSettingsProperties

TagSettingsProperties

Name Description Value
filterOperator Filter VMs by Any or All specified tags. 'All'
'Any'
tags Dictionary of tags with its list of values. object

ARM template resource definition

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

The configurationAssignments 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.Maintenance/configurationAssignments resource, add the following JSON to your template.

{
  "type": "Microsoft.Maintenance/configurationAssignments",
  "apiVersion": "2023-04-01",
  "name": "string",
  "location": "string",
  "scope": "string",
  "properties": {
    "filter": {
      "locations": [ "string" ],
      "osTypes": [ "string" ],
      "resourceGroups": [ "string" ],
      "resourceTypes": [ "string" ],
      "tagSettings": {
        "filterOperator": "string",
        "tags": {}
      }
    },
    "maintenanceConfigurationId": "string",
    "resourceId": "string"
  }
}

Property values

configurationAssignments

Name Description Value
type The resource type 'Microsoft.Maintenance/configurationAssignments'
apiVersion The resource api version '2023-04-01'
name The resource name string (required)
location Location of the resource string
scope Use when creating an extension resource at a scope that is different than the deployment scope. Target resource

For JSON, set the value to the full name of the resource to apply the extension resource to.
properties Properties of the configuration assignment ConfigurationAssignmentProperties

ConfigurationAssignmentProperties

Name Description Value
filter Properties of the configuration assignment ConfigurationAssignmentFilterProperties
maintenanceConfigurationId The maintenance configuration Id string
resourceId The unique resourceId string

ConfigurationAssignmentFilterProperties

Name Description Value
locations List of locations to scope the query to. string[]
osTypes List of allowed operating systems. string[]
resourceGroups List of allowed resource groups. string[]
resourceTypes List of allowed resources. string[]
tagSettings Tag settings for the VM. TagSettingsProperties

TagSettingsProperties

Name Description Value
filterOperator Filter VMs by Any or All specified tags. 'All'
'Any'
tags Dictionary of tags with its list of values. object

Terraform (AzAPI provider) resource definition

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

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

  • Subscriptions
  • Resource groups

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

Resource format

To create a Microsoft.Maintenance/configurationAssignments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Maintenance/configurationAssignments@2023-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      filter = {
        locations = [
          "string"
        ]
        osTypes = [
          "string"
        ]
        resourceGroups = [
          "string"
        ]
        resourceTypes = [
          "string"
        ]
        tagSettings = {
          filterOperator = "string"
          tags = {}
        }
      }
      maintenanceConfigurationId = "string"
      resourceId = "string"
    }
  })
}

Property values

configurationAssignments

Name Description Value
type The resource type "Microsoft.Maintenance/configurationAssignments@2023-04-01"
name The resource name string (required)
location Location of the resource string
parent_id The ID of the resource to apply this extension resource to. string (required)
properties Properties of the configuration assignment ConfigurationAssignmentProperties

ConfigurationAssignmentProperties

Name Description Value
filter Properties of the configuration assignment ConfigurationAssignmentFilterProperties
maintenanceConfigurationId The maintenance configuration Id string
resourceId The unique resourceId string

ConfigurationAssignmentFilterProperties

Name Description Value
locations List of locations to scope the query to. string[]
osTypes List of allowed operating systems. string[]
resourceGroups List of allowed resource groups. string[]
resourceTypes List of allowed resources. string[]
tagSettings Tag settings for the VM. TagSettingsProperties

TagSettingsProperties

Name Description Value
filterOperator Filter VMs by Any or All specified tags. "All"
"Any"
tags Dictionary of tags with its list of values. object