1. Packages
  2. Azure Classic
  3. API Docs
  4. maintenance
  5. Configuration

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.maintenance.Configuration

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages a maintenance configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleConfiguration = new azure.maintenance.Configuration("example", {
        name: "example-mc",
        resourceGroupName: example.name,
        location: example.location,
        scope: "SQLDB",
        tags: {
            Env: "prod",
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_configuration = azure.maintenance.Configuration("example",
        name="example-mc",
        resource_group_name=example.name,
        location=example.location,
        scope="SQLDB",
        tags={
            "Env": "prod",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/maintenance"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = maintenance.NewConfiguration(ctx, "example", &maintenance.ConfigurationArgs{
    			Name:              pulumi.String("example-mc"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			Scope:             pulumi.String("SQLDB"),
    			Tags: pulumi.StringMap{
    				"Env": pulumi.String("prod"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleConfiguration = new Azure.Maintenance.Configuration("example", new()
        {
            Name = "example-mc",
            ResourceGroupName = example.Name,
            Location = example.Location,
            Scope = "SQLDB",
            Tags = 
            {
                { "Env", "prod" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.maintenance.Configuration;
    import com.pulumi.azure.maintenance.ConfigurationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleConfiguration = new Configuration("exampleConfiguration", ConfigurationArgs.builder()
                .name("example-mc")
                .resourceGroupName(example.name())
                .location(example.location())
                .scope("SQLDB")
                .tags(Map.of("Env", "prod"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleConfiguration:
        type: azure:maintenance:Configuration
        name: example
        properties:
          name: example-mc
          resourceGroupName: ${example.name}
          location: ${example.location}
          scope: SQLDB
          tags:
            Env: prod
    

    Create Configuration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Configuration(name: string, args: ConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def Configuration(resource_name: str,
                      args: ConfigurationArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def Configuration(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      resource_group_name: Optional[str] = None,
                      scope: Optional[str] = None,
                      in_guest_user_patch_mode: Optional[str] = None,
                      install_patches: Optional[ConfigurationInstallPatchesArgs] = None,
                      location: Optional[str] = None,
                      name: Optional[str] = None,
                      properties: Optional[Mapping[str, str]] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      visibility: Optional[str] = None,
                      window: Optional[ConfigurationWindowArgs] = None)
    func NewConfiguration(ctx *Context, name string, args ConfigurationArgs, opts ...ResourceOption) (*Configuration, error)
    public Configuration(string name, ConfigurationArgs args, CustomResourceOptions? opts = null)
    public Configuration(String name, ConfigurationArgs args)
    public Configuration(String name, ConfigurationArgs args, CustomResourceOptions options)
    
    type: azure:maintenance:Configuration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var azureConfigurationResource = new Azure.Maintenance.Configuration("azureConfigurationResource", new()
    {
        ResourceGroupName = "string",
        Scope = "string",
        InGuestUserPatchMode = "string",
        InstallPatches = new Azure.Maintenance.Inputs.ConfigurationInstallPatchesArgs
        {
            Linuxes = new[]
            {
                new Azure.Maintenance.Inputs.ConfigurationInstallPatchesLinuxArgs
                {
                    ClassificationsToIncludes = new[]
                    {
                        "string",
                    },
                    PackageNamesMaskToExcludes = new[]
                    {
                        "string",
                    },
                    PackageNamesMaskToIncludes = new[]
                    {
                        "string",
                    },
                },
            },
            Reboot = "string",
            Windows = new[]
            {
                new Azure.Maintenance.Inputs.ConfigurationInstallPatchesWindowArgs
                {
                    ClassificationsToIncludes = new[]
                    {
                        "string",
                    },
                    KbNumbersToExcludes = new[]
                    {
                        "string",
                    },
                    KbNumbersToIncludes = new[]
                    {
                        "string",
                    },
                },
            },
        },
        Location = "string",
        Name = "string",
        Properties = 
        {
            { "string", "string" },
        },
        Tags = 
        {
            { "string", "string" },
        },
        Visibility = "string",
        Window = new Azure.Maintenance.Inputs.ConfigurationWindowArgs
        {
            StartDateTime = "string",
            TimeZone = "string",
            Duration = "string",
            ExpirationDateTime = "string",
            RecurEvery = "string",
        },
    });
    
    example, err := maintenance.NewConfiguration(ctx, "azureConfigurationResource", &maintenance.ConfigurationArgs{
    	ResourceGroupName:    pulumi.String("string"),
    	Scope:                pulumi.String("string"),
    	InGuestUserPatchMode: pulumi.String("string"),
    	InstallPatches: &maintenance.ConfigurationInstallPatchesArgs{
    		Linuxes: maintenance.ConfigurationInstallPatchesLinuxArray{
    			&maintenance.ConfigurationInstallPatchesLinuxArgs{
    				ClassificationsToIncludes: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    				PackageNamesMaskToExcludes: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    				PackageNamesMaskToIncludes: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    			},
    		},
    		Reboot: pulumi.String("string"),
    		Windows: maintenance.ConfigurationInstallPatchesWindowArray{
    			&maintenance.ConfigurationInstallPatchesWindowArgs{
    				ClassificationsToIncludes: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    				KbNumbersToExcludes: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    				KbNumbersToIncludes: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    			},
    		},
    	},
    	Location: pulumi.String("string"),
    	Name:     pulumi.String("string"),
    	Properties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Visibility: pulumi.String("string"),
    	Window: &maintenance.ConfigurationWindowArgs{
    		StartDateTime:      pulumi.String("string"),
    		TimeZone:           pulumi.String("string"),
    		Duration:           pulumi.String("string"),
    		ExpirationDateTime: pulumi.String("string"),
    		RecurEvery:         pulumi.String("string"),
    	},
    })
    
    var azureConfigurationResource = new Configuration("azureConfigurationResource", ConfigurationArgs.builder()
        .resourceGroupName("string")
        .scope("string")
        .inGuestUserPatchMode("string")
        .installPatches(ConfigurationInstallPatchesArgs.builder()
            .linuxes(ConfigurationInstallPatchesLinuxArgs.builder()
                .classificationsToIncludes("string")
                .packageNamesMaskToExcludes("string")
                .packageNamesMaskToIncludes("string")
                .build())
            .reboot("string")
            .windows(ConfigurationInstallPatchesWindowArgs.builder()
                .classificationsToIncludes("string")
                .kbNumbersToExcludes("string")
                .kbNumbersToIncludes("string")
                .build())
            .build())
        .location("string")
        .name("string")
        .properties(Map.of("string", "string"))
        .tags(Map.of("string", "string"))
        .visibility("string")
        .window(ConfigurationWindowArgs.builder()
            .startDateTime("string")
            .timeZone("string")
            .duration("string")
            .expirationDateTime("string")
            .recurEvery("string")
            .build())
        .build());
    
    azure_configuration_resource = azure.maintenance.Configuration("azureConfigurationResource",
        resource_group_name="string",
        scope="string",
        in_guest_user_patch_mode="string",
        install_patches=azure.maintenance.ConfigurationInstallPatchesArgs(
            linuxes=[azure.maintenance.ConfigurationInstallPatchesLinuxArgs(
                classifications_to_includes=["string"],
                package_names_mask_to_excludes=["string"],
                package_names_mask_to_includes=["string"],
            )],
            reboot="string",
            windows=[azure.maintenance.ConfigurationInstallPatchesWindowArgs(
                classifications_to_includes=["string"],
                kb_numbers_to_excludes=["string"],
                kb_numbers_to_includes=["string"],
            )],
        ),
        location="string",
        name="string",
        properties={
            "string": "string",
        },
        tags={
            "string": "string",
        },
        visibility="string",
        window=azure.maintenance.ConfigurationWindowArgs(
            start_date_time="string",
            time_zone="string",
            duration="string",
            expiration_date_time="string",
            recur_every="string",
        ))
    
    const azureConfigurationResource = new azure.maintenance.Configuration("azureConfigurationResource", {
        resourceGroupName: "string",
        scope: "string",
        inGuestUserPatchMode: "string",
        installPatches: {
            linuxes: [{
                classificationsToIncludes: ["string"],
                packageNamesMaskToExcludes: ["string"],
                packageNamesMaskToIncludes: ["string"],
            }],
            reboot: "string",
            windows: [{
                classificationsToIncludes: ["string"],
                kbNumbersToExcludes: ["string"],
                kbNumbersToIncludes: ["string"],
            }],
        },
        location: "string",
        name: "string",
        properties: {
            string: "string",
        },
        tags: {
            string: "string",
        },
        visibility: "string",
        window: {
            startDateTime: "string",
            timeZone: "string",
            duration: "string",
            expirationDateTime: "string",
            recurEvery: "string",
        },
    });
    
    type: azure:maintenance:Configuration
    properties:
        inGuestUserPatchMode: string
        installPatches:
            linuxes:
                - classificationsToIncludes:
                    - string
                  packageNamesMaskToExcludes:
                    - string
                  packageNamesMaskToIncludes:
                    - string
            reboot: string
            windows:
                - classificationsToIncludes:
                    - string
                  kbNumbersToExcludes:
                    - string
                  kbNumbersToIncludes:
                    - string
        location: string
        name: string
        properties:
            string: string
        resourceGroupName: string
        scope: string
        tags:
            string: string
        visibility: string
        window:
            duration: string
            expirationDateTime: string
            recurEvery: string
            startDateTime: string
            timeZone: string
    

    Configuration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Configuration resource accepts the following input properties:

    ResourceGroupName string
    The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.
    Scope string
    The scope of the Maintenance Configuration. Possible values are Extension, Host, InGuestPatch, OSImage, SQLDB or SQLManagedInstance.
    InGuestUserPatchMode string
    The in guest user patch mode. Possible values are Platform or User. Must be specified when scope is InGuestPatch.
    InstallPatches ConfigurationInstallPatches

    An install_patches block as defined below.

    NOTE: install_patches must be specified when scope is InGuestPatch.

    Location string
    Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.
    Properties Dictionary<string, string>
    A mapping of properties to assign to the resource.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource. The key could not contain upper case letter.
    Visibility string
    The visibility of the Maintenance Configuration. The only allowable value is Custom. Defaults to Custom.
    Window ConfigurationWindow
    A window block as defined below.
    ResourceGroupName string
    The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.
    Scope string
    The scope of the Maintenance Configuration. Possible values are Extension, Host, InGuestPatch, OSImage, SQLDB or SQLManagedInstance.
    InGuestUserPatchMode string
    The in guest user patch mode. Possible values are Platform or User. Must be specified when scope is InGuestPatch.
    InstallPatches ConfigurationInstallPatchesArgs

    An install_patches block as defined below.

    NOTE: install_patches must be specified when scope is InGuestPatch.

    Location string
    Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.
    Properties map[string]string
    A mapping of properties to assign to the resource.
    Tags map[string]string
    A mapping of tags to assign to the resource. The key could not contain upper case letter.
    Visibility string
    The visibility of the Maintenance Configuration. The only allowable value is Custom. Defaults to Custom.
    Window ConfigurationWindowArgs
    A window block as defined below.
    resourceGroupName String
    The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.
    scope String
    The scope of the Maintenance Configuration. Possible values are Extension, Host, InGuestPatch, OSImage, SQLDB or SQLManagedInstance.
    inGuestUserPatchMode String
    The in guest user patch mode. Possible values are Platform or User. Must be specified when scope is InGuestPatch.
    installPatches ConfigurationInstallPatches

    An install_patches block as defined below.

    NOTE: install_patches must be specified when scope is InGuestPatch.

    location String
    Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.
    properties Map<String,String>
    A mapping of properties to assign to the resource.
    tags Map<String,String>
    A mapping of tags to assign to the resource. The key could not contain upper case letter.
    visibility String
    The visibility of the Maintenance Configuration. The only allowable value is Custom. Defaults to Custom.
    window ConfigurationWindow
    A window block as defined below.
    resourceGroupName string
    The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.
    scope string
    The scope of the Maintenance Configuration. Possible values are Extension, Host, InGuestPatch, OSImage, SQLDB or SQLManagedInstance.
    inGuestUserPatchMode string
    The in guest user patch mode. Possible values are Platform or User. Must be specified when scope is InGuestPatch.
    installPatches ConfigurationInstallPatches

    An install_patches block as defined below.

    NOTE: install_patches must be specified when scope is InGuestPatch.

    location string
    Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.
    properties {[key: string]: string}
    A mapping of properties to assign to the resource.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource. The key could not contain upper case letter.
    visibility string
    The visibility of the Maintenance Configuration. The only allowable value is Custom. Defaults to Custom.
    window ConfigurationWindow
    A window block as defined below.
    resource_group_name str
    The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.
    scope str
    The scope of the Maintenance Configuration. Possible values are Extension, Host, InGuestPatch, OSImage, SQLDB or SQLManagedInstance.
    in_guest_user_patch_mode str
    The in guest user patch mode. Possible values are Platform or User. Must be specified when scope is InGuestPatch.
    install_patches ConfigurationInstallPatchesArgs

    An install_patches block as defined below.

    NOTE: install_patches must be specified when scope is InGuestPatch.

    location str
    Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.
    properties Mapping[str, str]
    A mapping of properties to assign to the resource.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource. The key could not contain upper case letter.
    visibility str
    The visibility of the Maintenance Configuration. The only allowable value is Custom. Defaults to Custom.
    window ConfigurationWindowArgs
    A window block as defined below.
    resourceGroupName String
    The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.
    scope String
    The scope of the Maintenance Configuration. Possible values are Extension, Host, InGuestPatch, OSImage, SQLDB or SQLManagedInstance.
    inGuestUserPatchMode String
    The in guest user patch mode. Possible values are Platform or User. Must be specified when scope is InGuestPatch.
    installPatches Property Map

    An install_patches block as defined below.

    NOTE: install_patches must be specified when scope is InGuestPatch.

    location String
    Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.
    properties Map<String>
    A mapping of properties to assign to the resource.
    tags Map<String>
    A mapping of tags to assign to the resource. The key could not contain upper case letter.
    visibility String
    The visibility of the Maintenance Configuration. The only allowable value is Custom. Defaults to Custom.
    window Property Map
    A window block as defined below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Configuration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Configuration Resource

    Get an existing Configuration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ConfigurationState, opts?: CustomResourceOptions): Configuration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            in_guest_user_patch_mode: Optional[str] = None,
            install_patches: Optional[ConfigurationInstallPatchesArgs] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            properties: Optional[Mapping[str, str]] = None,
            resource_group_name: Optional[str] = None,
            scope: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            visibility: Optional[str] = None,
            window: Optional[ConfigurationWindowArgs] = None) -> Configuration
    func GetConfiguration(ctx *Context, name string, id IDInput, state *ConfigurationState, opts ...ResourceOption) (*Configuration, error)
    public static Configuration Get(string name, Input<string> id, ConfigurationState? state, CustomResourceOptions? opts = null)
    public static Configuration get(String name, Output<String> id, ConfigurationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    InGuestUserPatchMode string
    The in guest user patch mode. Possible values are Platform or User. Must be specified when scope is InGuestPatch.
    InstallPatches ConfigurationInstallPatches

    An install_patches block as defined below.

    NOTE: install_patches must be specified when scope is InGuestPatch.

    Location string
    Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.
    Properties Dictionary<string, string>
    A mapping of properties to assign to the resource.
    ResourceGroupName string
    The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.
    Scope string
    The scope of the Maintenance Configuration. Possible values are Extension, Host, InGuestPatch, OSImage, SQLDB or SQLManagedInstance.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource. The key could not contain upper case letter.
    Visibility string
    The visibility of the Maintenance Configuration. The only allowable value is Custom. Defaults to Custom.
    Window ConfigurationWindow
    A window block as defined below.
    InGuestUserPatchMode string
    The in guest user patch mode. Possible values are Platform or User. Must be specified when scope is InGuestPatch.
    InstallPatches ConfigurationInstallPatchesArgs

    An install_patches block as defined below.

    NOTE: install_patches must be specified when scope is InGuestPatch.

    Location string
    Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.
    Properties map[string]string
    A mapping of properties to assign to the resource.
    ResourceGroupName string
    The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.
    Scope string
    The scope of the Maintenance Configuration. Possible values are Extension, Host, InGuestPatch, OSImage, SQLDB or SQLManagedInstance.
    Tags map[string]string
    A mapping of tags to assign to the resource. The key could not contain upper case letter.
    Visibility string
    The visibility of the Maintenance Configuration. The only allowable value is Custom. Defaults to Custom.
    Window ConfigurationWindowArgs
    A window block as defined below.
    inGuestUserPatchMode String
    The in guest user patch mode. Possible values are Platform or User. Must be specified when scope is InGuestPatch.
    installPatches ConfigurationInstallPatches

    An install_patches block as defined below.

    NOTE: install_patches must be specified when scope is InGuestPatch.

    location String
    Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.
    properties Map<String,String>
    A mapping of properties to assign to the resource.
    resourceGroupName String
    The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.
    scope String
    The scope of the Maintenance Configuration. Possible values are Extension, Host, InGuestPatch, OSImage, SQLDB or SQLManagedInstance.
    tags Map<String,String>
    A mapping of tags to assign to the resource. The key could not contain upper case letter.
    visibility String
    The visibility of the Maintenance Configuration. The only allowable value is Custom. Defaults to Custom.
    window ConfigurationWindow
    A window block as defined below.
    inGuestUserPatchMode string
    The in guest user patch mode. Possible values are Platform or User. Must be specified when scope is InGuestPatch.
    installPatches ConfigurationInstallPatches

    An install_patches block as defined below.

    NOTE: install_patches must be specified when scope is InGuestPatch.

    location string
    Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.
    properties {[key: string]: string}
    A mapping of properties to assign to the resource.
    resourceGroupName string
    The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.
    scope string
    The scope of the Maintenance Configuration. Possible values are Extension, Host, InGuestPatch, OSImage, SQLDB or SQLManagedInstance.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource. The key could not contain upper case letter.
    visibility string
    The visibility of the Maintenance Configuration. The only allowable value is Custom. Defaults to Custom.
    window ConfigurationWindow
    A window block as defined below.
    in_guest_user_patch_mode str
    The in guest user patch mode. Possible values are Platform or User. Must be specified when scope is InGuestPatch.
    install_patches ConfigurationInstallPatchesArgs

    An install_patches block as defined below.

    NOTE: install_patches must be specified when scope is InGuestPatch.

    location str
    Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.
    properties Mapping[str, str]
    A mapping of properties to assign to the resource.
    resource_group_name str
    The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.
    scope str
    The scope of the Maintenance Configuration. Possible values are Extension, Host, InGuestPatch, OSImage, SQLDB or SQLManagedInstance.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource. The key could not contain upper case letter.
    visibility str
    The visibility of the Maintenance Configuration. The only allowable value is Custom. Defaults to Custom.
    window ConfigurationWindowArgs
    A window block as defined below.
    inGuestUserPatchMode String
    The in guest user patch mode. Possible values are Platform or User. Must be specified when scope is InGuestPatch.
    installPatches Property Map

    An install_patches block as defined below.

    NOTE: install_patches must be specified when scope is InGuestPatch.

    location String
    Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.
    properties Map<String>
    A mapping of properties to assign to the resource.
    resourceGroupName String
    The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.
    scope String
    The scope of the Maintenance Configuration. Possible values are Extension, Host, InGuestPatch, OSImage, SQLDB or SQLManagedInstance.
    tags Map<String>
    A mapping of tags to assign to the resource. The key could not contain upper case letter.
    visibility String
    The visibility of the Maintenance Configuration. The only allowable value is Custom. Defaults to Custom.
    window Property Map
    A window block as defined below.

    Supporting Types

    ConfigurationInstallPatches, ConfigurationInstallPatchesArgs

    Linuxes List<ConfigurationInstallPatchesLinux>
    A linux block as defined above. This property only applies when scope is set to InGuestPatch
    Reboot string
    Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. Possible values are Always, IfRequired and Never. This property only applies when scope is set to InGuestPatch.
    Windows List<ConfigurationInstallPatchesWindow>
    A windows block as defined above. This property only applies when scope is set to InGuestPatch
    Linuxes []ConfigurationInstallPatchesLinux
    A linux block as defined above. This property only applies when scope is set to InGuestPatch
    Reboot string
    Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. Possible values are Always, IfRequired and Never. This property only applies when scope is set to InGuestPatch.
    Windows []ConfigurationInstallPatchesWindow
    A windows block as defined above. This property only applies when scope is set to InGuestPatch
    linuxes List<ConfigurationInstallPatchesLinux>
    A linux block as defined above. This property only applies when scope is set to InGuestPatch
    reboot String
    Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. Possible values are Always, IfRequired and Never. This property only applies when scope is set to InGuestPatch.
    windows List<ConfigurationInstallPatchesWindow>
    A windows block as defined above. This property only applies when scope is set to InGuestPatch
    linuxes ConfigurationInstallPatchesLinux[]
    A linux block as defined above. This property only applies when scope is set to InGuestPatch
    reboot string
    Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. Possible values are Always, IfRequired and Never. This property only applies when scope is set to InGuestPatch.
    windows ConfigurationInstallPatchesWindow[]
    A windows block as defined above. This property only applies when scope is set to InGuestPatch
    linuxes Sequence[ConfigurationInstallPatchesLinux]
    A linux block as defined above. This property only applies when scope is set to InGuestPatch
    reboot str
    Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. Possible values are Always, IfRequired and Never. This property only applies when scope is set to InGuestPatch.
    windows Sequence[ConfigurationInstallPatchesWindow]
    A windows block as defined above. This property only applies when scope is set to InGuestPatch
    linuxes List<Property Map>
    A linux block as defined above. This property only applies when scope is set to InGuestPatch
    reboot String
    Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. Possible values are Always, IfRequired and Never. This property only applies when scope is set to InGuestPatch.
    windows List<Property Map>
    A windows block as defined above. This property only applies when scope is set to InGuestPatch

    ConfigurationInstallPatchesLinux, ConfigurationInstallPatchesLinuxArgs

    ClassificationsToIncludes List<string>
    List of Classification category of patches to be patched. Possible values are Critical, Security and Other.
    PackageNamesMaskToExcludes List<string>
    List of package names to be excluded from patching.
    PackageNamesMaskToIncludes List<string>
    List of package names to be included for patching.
    ClassificationsToIncludes []string
    List of Classification category of patches to be patched. Possible values are Critical, Security and Other.
    PackageNamesMaskToExcludes []string
    List of package names to be excluded from patching.
    PackageNamesMaskToIncludes []string
    List of package names to be included for patching.
    classificationsToIncludes List<String>
    List of Classification category of patches to be patched. Possible values are Critical, Security and Other.
    packageNamesMaskToExcludes List<String>
    List of package names to be excluded from patching.
    packageNamesMaskToIncludes List<String>
    List of package names to be included for patching.
    classificationsToIncludes string[]
    List of Classification category of patches to be patched. Possible values are Critical, Security and Other.
    packageNamesMaskToExcludes string[]
    List of package names to be excluded from patching.
    packageNamesMaskToIncludes string[]
    List of package names to be included for patching.
    classifications_to_includes Sequence[str]
    List of Classification category of patches to be patched. Possible values are Critical, Security and Other.
    package_names_mask_to_excludes Sequence[str]
    List of package names to be excluded from patching.
    package_names_mask_to_includes Sequence[str]
    List of package names to be included for patching.
    classificationsToIncludes List<String>
    List of Classification category of patches to be patched. Possible values are Critical, Security and Other.
    packageNamesMaskToExcludes List<String>
    List of package names to be excluded from patching.
    packageNamesMaskToIncludes List<String>
    List of package names to be included for patching.

    ConfigurationInstallPatchesWindow, ConfigurationInstallPatchesWindowArgs

    ClassificationsToIncludes List<string>
    List of Classification category of patches to be patched. Possible values are Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools and Updates.
    KbNumbersToExcludes List<string>
    List of KB numbers to be excluded from patching.
    KbNumbersToIncludes List<string>
    List of KB numbers to be included for patching.
    ClassificationsToIncludes []string
    List of Classification category of patches to be patched. Possible values are Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools and Updates.
    KbNumbersToExcludes []string
    List of KB numbers to be excluded from patching.
    KbNumbersToIncludes []string
    List of KB numbers to be included for patching.
    classificationsToIncludes List<String>
    List of Classification category of patches to be patched. Possible values are Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools and Updates.
    kbNumbersToExcludes List<String>
    List of KB numbers to be excluded from patching.
    kbNumbersToIncludes List<String>
    List of KB numbers to be included for patching.
    classificationsToIncludes string[]
    List of Classification category of patches to be patched. Possible values are Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools and Updates.
    kbNumbersToExcludes string[]
    List of KB numbers to be excluded from patching.
    kbNumbersToIncludes string[]
    List of KB numbers to be included for patching.
    classifications_to_includes Sequence[str]
    List of Classification category of patches to be patched. Possible values are Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools and Updates.
    kb_numbers_to_excludes Sequence[str]
    List of KB numbers to be excluded from patching.
    kb_numbers_to_includes Sequence[str]
    List of KB numbers to be included for patching.
    classificationsToIncludes List<String>
    List of Classification category of patches to be patched. Possible values are Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools and Updates.
    kbNumbersToExcludes List<String>
    List of KB numbers to be excluded from patching.
    kbNumbersToIncludes List<String>
    List of KB numbers to be included for patching.

    ConfigurationWindow, ConfigurationWindowArgs

    StartDateTime string
    Effective start date of the maintenance window in YYYY-MM-DD hh:mm format.
    TimeZone string
    The time zone for the maintenance window. A list of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell.
    Duration string
    The duration of the maintenance window in HH:mm format.
    ExpirationDateTime string
    Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format.
    RecurEvery string
    The rate at which a maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules.
    StartDateTime string
    Effective start date of the maintenance window in YYYY-MM-DD hh:mm format.
    TimeZone string
    The time zone for the maintenance window. A list of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell.
    Duration string
    The duration of the maintenance window in HH:mm format.
    ExpirationDateTime string
    Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format.
    RecurEvery string
    The rate at which a maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules.
    startDateTime String
    Effective start date of the maintenance window in YYYY-MM-DD hh:mm format.
    timeZone String
    The time zone for the maintenance window. A list of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell.
    duration String
    The duration of the maintenance window in HH:mm format.
    expirationDateTime String
    Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format.
    recurEvery String
    The rate at which a maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules.
    startDateTime string
    Effective start date of the maintenance window in YYYY-MM-DD hh:mm format.
    timeZone string
    The time zone for the maintenance window. A list of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell.
    duration string
    The duration of the maintenance window in HH:mm format.
    expirationDateTime string
    Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format.
    recurEvery string
    The rate at which a maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules.
    start_date_time str
    Effective start date of the maintenance window in YYYY-MM-DD hh:mm format.
    time_zone str
    The time zone for the maintenance window. A list of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell.
    duration str
    The duration of the maintenance window in HH:mm format.
    expiration_date_time str
    Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format.
    recur_every str
    The rate at which a maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules.
    startDateTime String
    Effective start date of the maintenance window in YYYY-MM-DD hh:mm format.
    timeZone String
    The time zone for the maintenance window. A list of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell.
    duration String
    The duration of the maintenance window in HH:mm format.
    expirationDateTime String
    Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format.
    recurEvery String
    The rate at which a maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules.

    Import

    Maintenance Configuration can be imported using the resource id, e.g.

    $ pulumi import azure:maintenance/configuration:Configuration example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Maintenance/maintenanceConfigurations/example-mc
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi