1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. maintenance

Module maintenance

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Functions

Others

Resources

Resource Configuration

class Configuration extends CustomResource

Manages a maintenance configuration.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleConfiguration = new azure.maintenance.Configuration("exampleConfiguration", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    scope: "All",
    tags: {
        Env: "prod",
    },
});

constructor

new Configuration(name: string, args: ConfigurationArgs, opts?: pulumi.CustomResourceOptions)

Create a Configuration resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigurationState, opts?: pulumi.CustomResourceOptions): Configuration

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Configuration

Returns true if the given object is an instance of Configuration. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.

property scope

public scope: pulumi.Output<string | undefined>;

The scope of the Maintenance Configuration. Possible values are All, Host, Resource or InResource. Default to All.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource. The key could not contain upper case letter.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getConfiguration

getConfiguration(args: GetConfigurationArgs, opts?: pulumi.InvokeOptions): Promise<GetConfigurationResult>

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 = azurerm_maintenance_configuration.existing.id;

Others

interface ConfigurationArgs

interface ConfigurationArgs

The set of arguments for constructing a Configuration resource.

property location

location?: pulumi.Input<string>;

Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.

property scope

scope?: pulumi.Input<string>;

The scope of the Maintenance Configuration. Possible values are All, Host, Resource or InResource. Default to All.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource. The key could not contain upper case letter.

interface ConfigurationState

interface ConfigurationState

Input properties used for looking up and filtering Configuration resources.

property location

location?: pulumi.Input<string>;

Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Maintenance Configuration. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group where the Maintenance Configuration should exist. Changing this forces a new resource to be created.

property scope

scope?: pulumi.Input<string>;

The scope of the Maintenance Configuration. Possible values are All, Host, Resource or InResource. Default to All.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource. The key could not contain upper case letter.

interface GetConfigurationArgs

interface GetConfigurationArgs

A collection of arguments for invoking getConfiguration.

property name

name: string;

Specifies the name of the Maintenance Configuration.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the Resource Group where this Maintenance Configuration exists.

interface GetConfigurationResult

interface GetConfigurationResult

A collection of values returned by getConfiguration.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The Azure location where the resource exists.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property scope

scope: string;

The scope of the Maintenance Configuration.

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the resource.