pulumi-azure-kotlin/com.pulumi.azure.datafactory.kotlin/TriggerScheduleArgs

TriggerScheduleArgs

data class TriggerScheduleArgs(val activated: Output<Boolean>? = null, val annotations: Output<List<String>>? = null, val dataFactoryId: Output<String>? = null, val description: Output<String>? = null, val endTime: Output<String>? = null, val frequency: Output<String>? = null, val interval: Output<Int>? = null, val name: Output<String>? = null, val pipelineName: Output<String>? = null, val pipelineParameters: Output<Map<String, String>>? = null, val pipelines: Output<List<TriggerSchedulePipelineArgs>>? = null, val schedule: Output<TriggerScheduleScheduleArgs>? = null, val startTime: Output<String>? = null, val timeZone: Output<String>? = null) : ConvertibleToJava<TriggerScheduleArgs>

Manages a Trigger Schedule inside a Azure Data Factory.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.datafactory.Factory;
import com.pulumi.azure.datafactory.FactoryArgs;
import com.pulumi.azure.datafactory.Pipeline;
import com.pulumi.azure.datafactory.PipelineArgs;
import com.pulumi.azure.datafactory.TriggerSchedule;
import com.pulumi.azure.datafactory.TriggerScheduleArgs;
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) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());
        var examplePipeline = new Pipeline("examplePipeline", PipelineArgs.builder()
            .dataFactoryId(exampleFactory.id())
            .build());
        var exampleTriggerSchedule = new TriggerSchedule("exampleTriggerSchedule", TriggerScheduleArgs.builder()
            .dataFactoryId(exampleFactory.id())
            .pipelineName(examplePipeline.name())
            .interval(5)
            .frequency("Day")
            .build());
    }
}
Content copied to clipboard

Import

Data Factory Schedule Trigger can be imported using the resource id, e.g.

$ pulumi import azure:datafactory/triggerSchedule:TriggerSchedule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/triggers/example
Content copied to clipboard

Constructors

Link copied to clipboard
fun TriggerScheduleArgs(activated: Output<Boolean>? = null, annotations: Output<List<String>>? = null, dataFactoryId: Output<String>? = null, description: Output<String>? = null, endTime: Output<String>? = null, frequency: Output<String>? = null, interval: Output<Int>? = null, name: Output<String>? = null, pipelineName: Output<String>? = null, pipelineParameters: Output<Map<String, String>>? = null, pipelines: Output<List<TriggerSchedulePipelineArgs>>? = null, schedule: Output<TriggerScheduleScheduleArgs>? = null, startTime: Output<String>? = null, timeZone: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): TriggerScheduleArgs

Properties

Link copied to clipboard
val activated: Output<Boolean>? = null

Specifies if the Data Factory Schedule Trigger is activated. Defaults to true.

Link copied to clipboard
val annotations: Output<List<String>>? = null

List of tags that can be used for describing the Data Factory Schedule Trigger.

Link copied to clipboard
val dataFactoryId: Output<String>? = null

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

Link copied to clipboard
val description: Output<String>? = null

The Schedule Trigger's description.

Link copied to clipboard
val endTime: Output<String>? = null

The time the Schedule Trigger should end. The time will be represented in UTC.

Link copied to clipboard
val frequency: Output<String>? = null

The trigger frequency. Valid values include Minute, Hour, Day, Week, Month. Defaults to Minute.

Link copied to clipboard
val interval: Output<Int>? = null

The interval for how often the trigger occurs. This defaults to 1.

Link copied to clipboard
val name: Output<String>? = null

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 for all restrictions.

Link copied to clipboard
val pipelineName: Output<String>? = null

The Data Factory Pipeline name that the trigger will act on.

Link copied to clipboard
val pipelineParameters: Output<Map<String, String>>? = null

The pipeline parameters that the trigger will act upon.

Link copied to clipboard
val pipelines: Output<List<TriggerSchedulePipelineArgs>>? = null

block as defined below.

Link copied to clipboard
val schedule: Output<TriggerScheduleScheduleArgs>? = null

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.

Link copied to clipboard
val startTime: Output<String>? = null

The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.

Link copied to clipboard
val timeZone: Output<String>? = null

The timezone of the start/end time.