@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.31 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";
/**
* Definition of the schedule.
*
* Uses Azure REST API version 2023-11-01. In version 2.x of the Azure Native provider, it used API version 2022-08-08.
*
* Other available API versions: 2015-10-31, 2019-06-01, 2020-01-13-preview, 2022-08-08, 2023-05-15-preview, 2024-10-23. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native automation [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Schedule extends pulumi.CustomResource {
/**
* Get an existing Schedule 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): Schedule;
/**
* Returns true if the given object is an instance of Schedule. 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 Schedule;
/**
* Gets or sets the advanced schedule.
*/
readonly advancedSchedule: pulumi.Output<outputs.automation.AdvancedScheduleResponse | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Gets or sets the creation time.
*/
readonly creationTime: pulumi.Output<string | undefined>;
/**
* Gets or sets the description.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Gets or sets the end time of the schedule.
*/
readonly expiryTime: pulumi.Output<string | undefined>;
/**
* Gets or sets the expiry time's offset in minutes.
*/
readonly expiryTimeOffsetMinutes: pulumi.Output<number | undefined>;
/**
* Gets or sets the frequency of the schedule.
*/
readonly frequency: pulumi.Output<string | undefined>;
/**
* Gets or sets the interval of the schedule.
*/
readonly interval: pulumi.Output<any | undefined>;
/**
* Gets or sets a value indicating whether this schedule is enabled.
*/
readonly isEnabled: pulumi.Output<boolean | undefined>;
/**
* Gets or sets the last modified time.
*/
readonly lastModifiedTime: pulumi.Output<string | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Gets or sets the next run time of the schedule.
*/
readonly nextRun: pulumi.Output<string | undefined>;
/**
* Gets or sets the next run time's offset in minutes.
*/
readonly nextRunOffsetMinutes: pulumi.Output<number | undefined>;
/**
* Gets or sets the start time of the schedule.
*/
readonly startTime: pulumi.Output<string | undefined>;
/**
* Gets the start time's offset in minutes.
*/
readonly startTimeOffsetMinutes: pulumi.Output<number>;
/**
* Gets or sets the time zone of the schedule.
*/
readonly timeZone: pulumi.Output<string | undefined>;
/**
* The type of the resource.
*/
readonly type: pulumi.Output<string>;
/**
* Create a Schedule 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: ScheduleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Schedule resource.
*/
export interface ScheduleArgs {
/**
* Gets or sets the AdvancedSchedule.
*/
advancedSchedule?: pulumi.Input<inputs.automation.AdvancedScheduleArgs>;
/**
* The name of the automation account.
*/
automationAccountName: pulumi.Input<string>;
/**
* Gets or sets the description of the schedule.
*/
description?: pulumi.Input<string>;
/**
* Gets or sets the end time of the schedule.
*/
expiryTime?: pulumi.Input<string>;
/**
* Gets or sets the frequency of the schedule.
*/
frequency: pulumi.Input<string | enums.automation.ScheduleFrequency>;
/**
* Gets or sets the interval of the schedule.
*/
interval?: any;
/**
* Gets or sets the name of the Schedule.
*/
name: pulumi.Input<string>;
/**
* Name of an Azure Resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The schedule name.
*/
scheduleName?: pulumi.Input<string>;
/**
* Gets or sets the start time of the schedule.
*/
startTime: pulumi.Input<string>;
/**
* Gets or sets the time zone of the schedule.
*/
timeZone?: pulumi.Input<string>;
}