Share via

Microsoft.Maintenance configurationAssignments

  • Article

Bicep resource definition

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-10-01-preview' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    filter: {
      locations: [
        'string'
      ]
      osTypes: [
        'string'
      ]
      resourceGroups: [
        'string'
      ]
      resourceTypes: [
        'string'
      ]
      tagSettings: {
        filterOperator: 'string'
        tags: {
          {customized property}: [
            'string'
          ]
        }
      }
    }
    maintenanceConfigurationId: 'string'
    resourceId: 'string'
  }
}

Property values

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

ConfigurationAssignmentProperties

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

Microsoft.Maintenance/configurationAssignments

Name Description Value
location Location of the resource string
name The resource name string (required)
properties Properties of the configuration assignment ConfigurationAssignmentProperties
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.

TagSettingsProperties

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

TagSettingsPropertiesTags

Name Description Value

ARM template resource definition

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-10-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "filter": {
      "locations": [ "string" ],
      "osTypes": [ "string" ],
      "resourceGroups": [ "string" ],
      "resourceTypes": [ "string" ],
      "tagSettings": {
        "filterOperator": "string",
        "tags": {
          "{customized property}": [ "string" ]
        }
      }
    },
    "maintenanceConfigurationId": "string",
    "resourceId": "string"
  }
}

Property values

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

ConfigurationAssignmentProperties

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

Microsoft.Maintenance/configurationAssignments

Name Description Value
apiVersion The api version '2023-10-01-preview'
location Location of the resource string
name The resource name string (required)
properties Properties of the configuration assignment ConfigurationAssignmentProperties
type The resource type 'Microsoft.Maintenance/configurationAssignments'

TagSettingsProperties

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

TagSettingsPropertiesTags

Name Description Value

Terraform (AzAPI provider) resource definition

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

  • Subscription* 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-10-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  body = jsonencode({
    properties = {
      filter = {
        locations = [
          "string"
        ]
        osTypes = [
          "string"
        ]
        resourceGroups = [
          "string"
        ]
        resourceTypes = [
          "string"
        ]
        tagSettings = {
          filterOperator = "string"
          tags = {
            {customized property} = [
              "string"
            ]
          }
        }
      }
      maintenanceConfigurationId = "string"
      resourceId = "string"
    }
  })
}

Property values

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

ConfigurationAssignmentProperties

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

Microsoft.Maintenance/configurationAssignments

Name Description Value
location Location of the resource 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 configuration assignment ConfigurationAssignmentProperties
type The resource type "Microsoft.Maintenance/configurationAssignments@2023-10-01-preview"

TagSettingsProperties

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

TagSettingsPropertiesTags

Name Description Value