@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 9.88 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Maintenance configuration record type
*
* Uses Azure REST API version 2023-10-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-11-01-preview.
*
* Other available API versions: 2022-11-01-preview, 2023-04-01, 2023-09-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native maintenance [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class MaintenanceConfiguration extends pulumi.CustomResource {
/**
* Get an existing MaintenanceConfiguration resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): MaintenanceConfiguration;
/**
* Returns true if the given object is an instance of MaintenanceConfiguration. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is MaintenanceConfiguration;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00.
*/
readonly duration: pulumi.Output<string | undefined>;
/**
* Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59.
*/
readonly expirationDateTime: pulumi.Output<string | undefined>;
/**
* Gets or sets extensionProperties of the maintenanceConfiguration
*/
readonly extensionProperties: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The input parameters to be passed to the patch run operation.
*/
readonly installPatches: pulumi.Output<outputs.maintenance.InputPatchConfigurationResponse | undefined>;
/**
* Gets or sets location of the resource
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Gets or sets maintenanceScope of the configuration
*/
readonly maintenanceScope: pulumi.Output<string | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Gets or sets namespace of the resource
*/
readonly namespace: pulumi.Output<string | undefined>;
/**
* Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6.
*/
readonly recurEvery: pulumi.Output<string | undefined>;
/**
* Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone.
*/
readonly startDateTime: pulumi.Output<string | undefined>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.maintenance.SystemDataResponse>;
/**
* Gets or sets tags of the resource
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time.
*/
readonly timeZone: pulumi.Output<string | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Gets or sets the visibility of the configuration. The default value is 'Custom'
*/
readonly visibility: pulumi.Output<string | undefined>;
/**
* Create a MaintenanceConfiguration resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: MaintenanceConfigurationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a MaintenanceConfiguration resource.
*/
export interface MaintenanceConfigurationArgs {
/**
* Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00.
*/
duration?: pulumi.Input<string>;
/**
* Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59.
*/
expirationDateTime?: pulumi.Input<string>;
/**
* Gets or sets extensionProperties of the maintenanceConfiguration
*/
extensionProperties?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The input parameters to be passed to the patch run operation.
*/
installPatches?: pulumi.Input<inputs.maintenance.InputPatchConfigurationArgs>;
/**
* Gets or sets location of the resource
*/
location?: pulumi.Input<string>;
/**
* Gets or sets maintenanceScope of the configuration
*/
maintenanceScope?: pulumi.Input<string | enums.maintenance.MaintenanceScope>;
/**
* Gets or sets namespace of the resource
*/
namespace?: pulumi.Input<string>;
/**
* Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6.
*/
recurEvery?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the MaintenanceConfiguration
*/
resourceName?: pulumi.Input<string>;
/**
* Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone.
*/
startDateTime?: pulumi.Input<string>;
/**
* Gets or sets tags of the resource
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time.
*/
timeZone?: pulumi.Input<string>;
/**
* Gets or sets the visibility of the configuration. The default value is 'Custom'
*/
visibility?: pulumi.Input<string | enums.maintenance.Visibility>;
}