Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. maintenance
  5. getConfiguration

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.maintenance.getConfiguration

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Use this data source to access information about an existing Maintenance Configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const existing = azure.maintenance.getConfiguration({
    name: "example-mc",
    resourceGroupName: "example-resources",
});
export const id = existingAzurermMaintenanceConfiguration.id;

    import pulumi
import pulumi_azure as azure

existing = azure.maintenance.get_configuration(name="example-mc",
    resource_group_name="example-resources")
pulumi.export("id", existing_azurerm_maintenance_configuration["id"])

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/maintenance"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := maintenance.LookupConfiguration(ctx, &maintenance.LookupConfigurationArgs{
			Name:              "example-mc",
			ResourceGroupName: "example-resources",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", existingAzurermMaintenanceConfiguration.Id)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var existing = Azure.Maintenance.GetConfiguration.Invoke(new()
    {
        Name = "example-mc",
        ResourceGroupName = "example-resources",
    });

    return new Dictionary<string, object?>
    {
        ["id"] = existingAzurermMaintenanceConfiguration.Id,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.maintenance.MaintenanceFunctions;
import com.pulumi.azure.maintenance.inputs.GetConfigurationArgs;
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) {
        final var existing = MaintenanceFunctions.getConfiguration(GetConfigurationArgs.builder()
            .name("example-mc")
            .resourceGroupName("example-resources")
            .build());

        ctx.export("id", existingAzurermMaintenanceConfiguration.id());
    }
}

    variables:
  existing:
    fn::invoke:
      function: azure:maintenance:getConfiguration
      arguments:
        name: example-mc
        resourceGroupName: example-resources
outputs:
  id: ${existingAzurermMaintenanceConfiguration.id}

    Using getConfiguration

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConfiguration(args: GetConfigurationArgs, opts?: InvokeOptions): Promise<GetConfigurationResult>
function getConfigurationOutput(args: GetConfigurationOutputArgs, opts?: InvokeOptions): Output<GetConfigurationResult>
    def get_configuration(name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetConfigurationResult
def get_configuration_output(name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetConfigurationResult]
    func LookupConfiguration(ctx *Context, args *LookupConfigurationArgs, opts ...InvokeOption) (*LookupConfigurationResult, error)
func LookupConfigurationOutput(ctx *Context, args *LookupConfigurationOutputArgs, opts ...InvokeOption) LookupConfigurationResultOutput

    > Note: This function is named LookupConfiguration in the Go SDK.

    public static class GetConfiguration 
{
    public static Task<GetConfigurationResult> InvokeAsync(GetConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetConfigurationResult> Invoke(GetConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetConfigurationResult> getConfiguration(GetConfigurationArgs args, InvokeOptions options)
public static Output<GetConfigurationResult> getConfiguration(GetConfigurationArgs args, InvokeOptions options)

    fn::invoke:
  function: azure:maintenance/getConfiguration:getConfiguration
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    Specifies the name of the Maintenance Configuration.
    ResourceGroupName string
    Specifies the name of the Resource Group where this Maintenance Configuration exists.
    Name string
    Specifies the name of the Maintenance Configuration.
    ResourceGroupName string
    Specifies the name of the Resource Group where this Maintenance Configuration exists.
    name String
    Specifies the name of the Maintenance Configuration.
    resourceGroupName String
    Specifies the name of the Resource Group where this Maintenance Configuration exists.
    name string
    Specifies the name of the Maintenance Configuration.
    resourceGroupName string
    Specifies the name of the Resource Group where this Maintenance Configuration exists.
    name str
    Specifies the name of the Maintenance Configuration.
    resource_group_name str
    Specifies the name of the Resource Group where this Maintenance Configuration exists.
    name String
    Specifies the name of the Maintenance Configuration.
    resourceGroupName String
    Specifies the name of the Resource Group where this Maintenance Configuration exists.

    getConfiguration Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    InGuestUserPatchMode string
    The in guest user patch mode.
    InstallPatches List<GetConfigurationInstallPatch>
    An install_patches block as defined below.
    Location string
    The Azure location where the resource exists.
    Name string
    Properties Dictionary<string, string>
    The properties assigned to the resource.
    ResourceGroupName string
    Scope string
    The scope of the Maintenance Configuration.
    Tags Dictionary<string, string>
    A mapping of tags assigned to the resource.
    Visibility string
    The visibility of the Maintenance Configuration.
    Windows List<GetConfigurationWindow>
    A window block as defined below.
    Id string
    The provider-assigned unique ID for this managed resource.
    InGuestUserPatchMode string
    The in guest user patch mode.
    InstallPatches []GetConfigurationInstallPatch
    An install_patches block as defined below.
    Location string
    The Azure location where the resource exists.
    Name string
    Properties map[string]string
    The properties assigned to the resource.
    ResourceGroupName string
    Scope string
    The scope of the Maintenance Configuration.
    Tags map[string]string
    A mapping of tags assigned to the resource.
    Visibility string
    The visibility of the Maintenance Configuration.
    Windows []GetConfigurationWindow
    A window block as defined below.
    id String
    The provider-assigned unique ID for this managed resource.
    inGuestUserPatchMode String
    The in guest user patch mode.
    installPatches List<GetConfigurationInstallPatch>
    An install_patches block as defined below.
    location String
    The Azure location where the resource exists.
    name String
    properties Map<String,String>
    The properties assigned to the resource.
    resourceGroupName String
    scope String
    The scope of the Maintenance Configuration.
    tags Map<String,String>
    A mapping of tags assigned to the resource.
    visibility String
    The visibility of the Maintenance Configuration.
    windows List<GetConfigurationWindow>
    A window block as defined below.
    id string
    The provider-assigned unique ID for this managed resource.
    inGuestUserPatchMode string
    The in guest user patch mode.
    installPatches GetConfigurationInstallPatch[]
    An install_patches block as defined below.
    location string
    The Azure location where the resource exists.
    name string
    properties {[key: string]: string}
    The properties assigned to the resource.
    resourceGroupName string
    scope string
    The scope of the Maintenance Configuration.
    tags {[key: string]: string}
    A mapping of tags assigned to the resource.
    visibility string
    The visibility of the Maintenance Configuration.
    windows GetConfigurationWindow[]
    A window block as defined below.
    id str
    The provider-assigned unique ID for this managed resource.
    in_guest_user_patch_mode str
    The in guest user patch mode.
    install_patches Sequence[GetConfigurationInstallPatch]
    An install_patches block as defined below.
    location str
    The Azure location where the resource exists.
    name str
    properties Mapping[str, str]
    The properties assigned to the resource.
    resource_group_name str
    scope str
    The scope of the Maintenance Configuration.
    tags Mapping[str, str]
    A mapping of tags assigned to the resource.
    visibility str
    The visibility of the Maintenance Configuration.
    windows Sequence[GetConfigurationWindow]
    A window block as defined below.
    id String
    The provider-assigned unique ID for this managed resource.
    inGuestUserPatchMode String
    The in guest user patch mode.
    installPatches List<Property Map>
    An install_patches block as defined below.
    location String
    The Azure location where the resource exists.
    name String
    properties Map<String>
    The properties assigned to the resource.
    resourceGroupName String
    scope String
    The scope of the Maintenance Configuration.
    tags Map<String>
    A mapping of tags assigned to the resource.
    visibility String
    The visibility of the Maintenance Configuration.
    windows List<Property Map>
    A window block as defined below.

    Supporting Types

    GetConfigurationInstallPatch

    Linuxes List<GetConfigurationInstallPatchLinux>
    A linux block as defined below.
    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.
    Windows List<GetConfigurationInstallPatchWindow>
    A windows block as defined below.
    Linuxes []GetConfigurationInstallPatchLinux
    A linux block as defined below.
    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.
    Windows []GetConfigurationInstallPatchWindow
    A windows block as defined below.
    linuxes List<GetConfigurationInstallPatchLinux>
    A linux block as defined below.
    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.
    windows List<GetConfigurationInstallPatchWindow>
    A windows block as defined below.
    linuxes GetConfigurationInstallPatchLinux[]
    A linux block as defined below.
    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.
    windows GetConfigurationInstallPatchWindow[]
    A windows block as defined below.
    linuxes Sequence[GetConfigurationInstallPatchLinux]
    A linux block as defined below.
    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.
    windows Sequence[GetConfigurationInstallPatchWindow]
    A windows block as defined below.
    linuxes List<Property Map>
    A linux block as defined below.
    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.
    windows List<Property Map>
    A windows block as defined below.

    GetConfigurationInstallPatchLinux

    ClassificationsToIncludes List<string>
    List of Classification category of patches to be patched.
    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.
    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.
    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.
    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.
    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.
    packageNamesMaskToExcludes List<String>
    List of package names to be excluded from patching.
    packageNamesMaskToIncludes List<String>
    List of package names to be included for patching.

    GetConfigurationInstallPatchWindow

    ClassificationsToIncludes List<string>
    List of Classification category of patches to be patched.
    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.
    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.
    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.
    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.
    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.
    kbNumbersToExcludes List<String>
    List of KB numbers to be excluded from patching.
    kbNumbersToIncludes List<String>
    List of KB numbers to be included for patching.

    GetConfigurationWindow

    Duration string
    The duration of the maintenance window.
    ExpirationDateTime string
    Effective expiration date of the maintenance window.
    RecurEvery string
    The rate at which a maintenance window is expected to recur.
    StartDateTime string
    Effective start date of the maintenance window.
    TimeZone string
    The time zone for the maintenance window.
    Duration string
    The duration of the maintenance window.
    ExpirationDateTime string
    Effective expiration date of the maintenance window.
    RecurEvery string
    The rate at which a maintenance window is expected to recur.
    StartDateTime string
    Effective start date of the maintenance window.
    TimeZone string
    The time zone for the maintenance window.
    duration String
    The duration of the maintenance window.
    expirationDateTime String
    Effective expiration date of the maintenance window.
    recurEvery String
    The rate at which a maintenance window is expected to recur.
    startDateTime String
    Effective start date of the maintenance window.
    timeZone String
    The time zone for the maintenance window.
    duration string
    The duration of the maintenance window.
    expirationDateTime string
    Effective expiration date of the maintenance window.
    recurEvery string
    The rate at which a maintenance window is expected to recur.
    startDateTime string
    Effective start date of the maintenance window.
    timeZone string
    The time zone for the maintenance window.
    duration str
    The duration of the maintenance window.
    expiration_date_time str
    Effective expiration date of the maintenance window.
    recur_every str
    The rate at which a maintenance window is expected to recur.
    start_date_time str
    Effective start date of the maintenance window.
    time_zone str
    The time zone for the maintenance window.
    duration String
    The duration of the maintenance window.
    expirationDateTime String
    Effective expiration date of the maintenance window.
    recurEvery String
    The rate at which a maintenance window is expected to recur.
    startDateTime String
    Effective start date of the maintenance window.
    timeZone String
    The time zone for the maintenance window.

    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 v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure