Trigger
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
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",
});Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_factory = azure.datafactory.Factory("example",
name="example",
location=example.location,
resource_group_name=example.name)
example_pipeline = azure.datafactory.Pipeline("example",
name="example",
data_factory_id=example_factory.id)
example_trigger_schedule = azure.datafactory.TriggerSchedule("example",
name="example",
data_factory_id=example_factory.id,
pipeline_name=example_pipeline.name,
interval=5,
frequency="Day")Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleFactory = new Azure.DataFactory.Factory("example", new()
{
Name = "example",
Location = example.Location,
ResourceGroupName = example.Name,
});
var examplePipeline = new Azure.DataFactory.Pipeline("example", new()
{
Name = "example",
DataFactoryId = exampleFactory.Id,
});
var exampleTriggerSchedule = new Azure.DataFactory.TriggerSchedule("example", new()
{
Name = "example",
DataFactoryId = exampleFactory.Id,
PipelineName = examplePipeline.Name,
Interval = 5,
Frequency = "Day",
});
});Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/datafactory"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
Name: pulumi.String("example"),
Location: example.Location,
ResourceGroupName: example.Name,
})
if err != nil {
return err
}
examplePipeline, err := datafactory.NewPipeline(ctx, "example", &datafactory.PipelineArgs{
Name: pulumi.String("example"),
DataFactoryId: exampleFactory.ID(),
})
if err != nil {
return err
}
_, err = datafactory.NewTriggerSchedule(ctx, "example", &datafactory.TriggerScheduleArgs{
Name: pulumi.String("example"),
DataFactoryId: exampleFactory.ID(),
PipelineName: examplePipeline.Name,
Interval: pulumi.Int(5),
Frequency: pulumi.String("Day"),
})
if err != nil {
return err
}
return nil
})
}Content copied to clipboard
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
.name("example")
.location(example.location())
.resourceGroupName(example.name())
.build());
var examplePipeline = new Pipeline("examplePipeline", PipelineArgs.builder()
.name("example")
.dataFactoryId(exampleFactory.id())
.build());
var exampleTriggerSchedule = new TriggerSchedule("exampleTriggerSchedule", TriggerScheduleArgs.builder()
.name("example")
.dataFactoryId(exampleFactory.id())
.pipelineName(examplePipeline.name())
.interval(5)
.frequency("Day")
.build());
}
}Content copied to clipboard
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleFactory:
type: azure:datafactory:Factory
name: example
properties:
name: example
location: ${example.location}
resourceGroupName: ${example.name}
examplePipeline:
type: azure:datafactory:Pipeline
name: example
properties:
name: example
dataFactoryId: ${exampleFactory.id}
exampleTriggerSchedule:
type: azure:datafactory:TriggerSchedule
name: example
properties:
name: example
dataFactoryId: ${exampleFactory.id}
pipelineName: ${examplePipeline.name}
interval: 5
frequency: DayContent 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/exampleContent copied to clipboard
Constructors
Link copied to clipboard
constructor(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)
Properties
Link copied to clipboard
List of tags that can be used for describing the Data Factory Schedule Trigger.
Link copied to clipboard
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
Link copied to clipboard
The Schedule Trigger's description.
Link copied to clipboard
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
The Data Factory Pipeline name that the trigger will act on.
Link copied to clipboard
The pipeline parameters that the trigger will act upon.
Link copied to clipboard
A pipeline block as defined below.
Link copied to clipboard
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.