import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a Trigger Schedule inside a Azure Data Factory. * * ## Example Usage * * ```typescript * 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 exampleFactory = new azure.datafactory.Factory("example", { * name: "example", * location: example.location, * resourceGroupName: example.name, * }); * const examplePipeline = new azure.datafactory.Pipeline("example", { * name: "example", * dataFactoryId: exampleFactory.id, * }); * const exampleTriggerSchedule = new azure.datafactory.TriggerSchedule("example", { * name: "example", * dataFactoryId: exampleFactory.id, * pipelineName: examplePipeline.name, * interval: 5, * frequency: "Day", * }); * ``` * * ## Import * * Data Factory Schedule Trigger can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:datafactory/triggerSchedule:TriggerSchedule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/triggers/example * ``` */ export declare class TriggerSchedule extends pulumi.CustomResource { /** * Get an existing TriggerSchedule 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 state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: TriggerScheduleState, opts?: pulumi.CustomResourceOptions): TriggerSchedule; /** * Returns true if the given object is an instance of TriggerSchedule. 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 TriggerSchedule; /** * Specifies if the Data Factory Schedule Trigger is activated. Defaults to `true`. */ readonly activated: pulumi.Output; /** * List of tags that can be used for describing the Data Factory Schedule Trigger. */ readonly annotations: pulumi.Output; /** * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. */ readonly dataFactoryId: pulumi.Output; /** * The Schedule Trigger's description. */ readonly description: pulumi.Output; /** * The time the Schedule Trigger should end. The time will be represented in UTC. */ readonly endTime: pulumi.Output; /** * The trigger frequency. Valid values include `Minute`, `Hour`, `Day`, `Week`, `Month`. Defaults to `Minute`. */ readonly frequency: pulumi.Output; /** * The interval for how often the trigger occurs. This defaults to `1`. */ readonly interval: pulumi.Output; /** * Specifies the name of the Data Factory Schedule Trigger. Changing this forces a new resource to be created. Must be globally unique. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions. */ readonly name: pulumi.Output; /** * The Data Factory Pipeline name that the trigger will act on. */ readonly pipelineName: pulumi.Output; /** * The pipeline parameters that the trigger will act upon. */ readonly pipelineParameters: pulumi.Output<{ [key: string]: string; }>; /** * A `pipeline` block as defined below. */ readonly pipelines: pulumi.Output; /** * A `schedule` block as defined below, which further specifies the recurrence schedule for the trigger. A schedule is capable of limiting or increasing the number of trigger executions specified by the `frequency` and `interval` properties. */ readonly schedule: pulumi.Output; /** * The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC. */ readonly startTime: pulumi.Output; /** * The timezone of the start/end time. */ readonly timeZone: pulumi.Output; /** * Create a TriggerSchedule 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: TriggerScheduleArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering TriggerSchedule resources. */ export interface TriggerScheduleState { /** * Specifies if the Data Factory Schedule Trigger is activated. Defaults to `true`. */ activated?: pulumi.Input; /** * List of tags that can be used for describing the Data Factory Schedule Trigger. */ annotations?: pulumi.Input[]>; /** * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. */ dataFactoryId?: pulumi.Input; /** * The Schedule Trigger's description. */ description?: pulumi.Input; /** * The time the Schedule Trigger should end. The time will be represented in UTC. */ endTime?: pulumi.Input; /** * The trigger frequency. Valid values include `Minute`, `Hour`, `Day`, `Week`, `Month`. Defaults to `Minute`. */ frequency?: pulumi.Input; /** * The interval for how often the trigger occurs. This defaults to `1`. */ interval?: pulumi.Input; /** * Specifies the name of the Data Factory Schedule Trigger. Changing this forces a new resource to be created. Must be globally unique. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions. */ name?: pulumi.Input; /** * The Data Factory Pipeline name that the trigger will act on. */ pipelineName?: pulumi.Input; /** * The pipeline parameters that the trigger will act upon. */ pipelineParameters?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * A `pipeline` block as defined below. */ pipelines?: pulumi.Input[]>; /** * A `schedule` block as defined below, which further specifies the recurrence schedule for the trigger. A schedule is capable of limiting or increasing the number of trigger executions specified by the `frequency` and `interval` properties. */ schedule?: pulumi.Input; /** * The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC. */ startTime?: pulumi.Input; /** * The timezone of the start/end time. */ timeZone?: pulumi.Input; } /** * The set of arguments for constructing a TriggerSchedule resource. */ export interface TriggerScheduleArgs { /** * Specifies if the Data Factory Schedule Trigger is activated. Defaults to `true`. */ activated?: pulumi.Input; /** * List of tags that can be used for describing the Data Factory Schedule Trigger. */ annotations?: pulumi.Input[]>; /** * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. */ dataFactoryId: pulumi.Input; /** * The Schedule Trigger's description. */ description?: pulumi.Input; /** * The time the Schedule Trigger should end. The time will be represented in UTC. */ endTime?: pulumi.Input; /** * The trigger frequency. Valid values include `Minute`, `Hour`, `Day`, `Week`, `Month`. Defaults to `Minute`. */ frequency?: pulumi.Input; /** * The interval for how often the trigger occurs. This defaults to `1`. */ interval?: pulumi.Input; /** * Specifies the name of the Data Factory Schedule Trigger. Changing this forces a new resource to be created. Must be globally unique. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions. */ name?: pulumi.Input; /** * The Data Factory Pipeline name that the trigger will act on. */ pipelineName?: pulumi.Input; /** * The pipeline parameters that the trigger will act upon. */ pipelineParameters?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * A `pipeline` block as defined below. */ pipelines?: pulumi.Input[]>; /** * A `schedule` block as defined below, which further specifies the recurrence schedule for the trigger. A schedule is capable of limiting or increasing the number of trigger executions specified by the `frequency` and `interval` properties. */ schedule?: pulumi.Input; /** * The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC. */ startTime?: pulumi.Input; /** * The timezone of the start/end time. */ timeZone?: pulumi.Input; }