Share via

Microsoft.Maintenance maintenanceConfigurations 2020-04-01

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.Maintenance/maintenanceConfigurations@2020-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    extensionProperties: {}
    maintenanceScope: 'string'
    namespace: 'string'
  }
}

Property values

maintenanceConfigurations

Name Description Value
name The resource name string (required)
location Gets or sets location of the resource string
tags Gets or sets tags of the resource Dictionary of tag names and values. See Tags in templates
properties Gets or sets properties of the resource MaintenanceConfigurationProperties

MaintenanceConfigurationProperties

Name Description Value
extensionProperties Gets or sets extensionProperties of the maintenanceConfiguration. This is for future use only and would be a set of key value pairs for additional information e.g. whether to follow SDP etc. object
maintenanceScope Gets or sets maintenanceScope of the configuration. It represent the impact area of the maintenance 'All'
'Host'
'InResource'
'Resource'
namespace Gets or sets namespace of the resource e.g. Microsoft.Maintenance or Microsoft.Sql string

ARM template resource definition

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

{
  "type": "Microsoft.Maintenance/maintenanceConfigurations",
  "apiVersion": "2020-04-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "extensionProperties": {},
    "maintenanceScope": "string",
    "namespace": "string"
  }
}

Property values

maintenanceConfigurations

Name Description Value
type The resource type 'Microsoft.Maintenance/maintenanceConfigurations'
apiVersion The resource api version '2020-04-01'
name The resource name string (required)
location Gets or sets location of the resource string
tags Gets or sets tags of the resource Dictionary of tag names and values. See Tags in templates
properties Gets or sets properties of the resource MaintenanceConfigurationProperties

MaintenanceConfigurationProperties

Name Description Value
extensionProperties Gets or sets extensionProperties of the maintenanceConfiguration. This is for future use only and would be a set of key value pairs for additional information e.g. whether to follow SDP etc. object
maintenanceScope Gets or sets maintenanceScope of the configuration. It represent the impact area of the maintenance 'All'
'Host'
'InResource'
'Resource'
namespace Gets or sets namespace of the resource e.g. Microsoft.Maintenance or Microsoft.Sql string

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Maintenance/maintenanceConfigurations@2020-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      extensionProperties = {}
      maintenanceScope = "string"
      namespace = "string"
    }
  })
}

Property values

maintenanceConfigurations

Name Description Value
type The resource type "Microsoft.Maintenance/maintenanceConfigurations@2020-04-01"
name The resource name string (required)
location Gets or sets location of the resource string
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Gets or sets tags of the resource Dictionary of tag names and values.
properties Gets or sets properties of the resource MaintenanceConfigurationProperties

MaintenanceConfigurationProperties

Name Description Value
extensionProperties Gets or sets extensionProperties of the maintenanceConfiguration. This is for future use only and would be a set of key value pairs for additional information e.g. whether to follow SDP etc. object
maintenanceScope Gets or sets maintenanceScope of the configuration. It represent the impact area of the maintenance "All"
"Host"
"InResource"
"Resource"
namespace Gets or sets namespace of the resource e.g. Microsoft.Maintenance or Microsoft.Sql string