Microsoft.Maintenance maintenanceConfigurations 2020-04-01

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.

Usage Examples

Bicep Samples

A basic example of deploying Maintenance Configuration.

param location string = 'westeurope'
param resourceName string = 'acctest0001'

resource maintenanceConfiguration 'Microsoft.Maintenance/maintenanceConfigurations@2022-07-01-preview' = {
  name: resourceName
  location: location
  properties: {
    extensionProperties: {}
    maintenanceScope: 'SQLDB'
    namespace: 'Microsoft.Maintenance'
    visibility: 'Custom'
  }
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Maintenance Configuration AVM Resource Module for Maintenance Configuration

Resource format

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

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

Property Values

Microsoft.Maintenance/maintenanceConfigurations

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

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. MaintenanceConfigurationPropertiesExtensionProperties
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

MaintenanceConfigurationPropertiesExtensionProperties

Name Description Value

MaintenanceConfigurationTags

Name Description Value

ARM template resource definition

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

Usage Examples

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",
  "properties": {
    "extensionProperties": {
      "{customized property}": "string"
    },
    "maintenanceScope": "string",
    "namespace": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Maintenance/maintenanceConfigurations

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

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. MaintenanceConfigurationPropertiesExtensionProperties
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

MaintenanceConfigurationPropertiesExtensionProperties

Name Description Value

MaintenanceConfigurationTags

Name Description Value

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.

Usage Examples

Terraform Samples

A basic example of deploying Maintenance Configuration.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "maintenanceConfiguration" {
  type      = "Microsoft.Maintenance/maintenanceConfigurations@2022-07-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      extensionProperties = {
      }
      maintenanceScope = "SQLDB"
      namespace        = "Microsoft.Maintenance"
      visibility       = "Custom"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Maintenance Configuration AVM Resource Module for Maintenance Configuration

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"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      extensionProperties = {
        {customized property} = "string"
      }
      maintenanceScope = "string"
      namespace = "string"
    }
  }
}

Property Values

Microsoft.Maintenance/maintenanceConfigurations

Name Description Value
location Gets or sets location of the resource string
name The resource name string (required)
properties Gets or sets properties of the resource MaintenanceConfigurationProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Maintenance/maintenanceConfigurations@2020-04-01"

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. MaintenanceConfigurationPropertiesExtensionProperties
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

MaintenanceConfigurationPropertiesExtensionProperties

Name Description Value

MaintenanceConfigurationTags

Name Description Value
  • Last updated on