TriggerSchedule

Manages a Trigger Schedule inside a Azure Data Factory.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "northeurope",
        });
        var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new Azure.DataFactory.FactoryArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
        var testPipeline = new Azure.DataFactory.Pipeline("testPipeline", new Azure.DataFactory.PipelineArgs
        {
            ResourceGroupName = azurerm_resource_group.Test.Name,
            DataFactoryName = azurerm_data_factory.Test.Name,
        });
        var testTriggerSchedule = new Azure.DataFactory.TriggerSchedule("testTriggerSchedule", new Azure.DataFactory.TriggerScheduleArgs
        {
            DataFactoryName = azurerm_data_factory.Test.Name,
            ResourceGroupName = azurerm_resource_group.Test.Name,
            PipelineName = testPipeline.Name,
            Interval = 5,
            Frequency = "Day",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/datafactory"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("northeurope"),
        })
        if err != nil {
            return err
        }
        _, err = datafactory.NewFactory(ctx, "exampleFactory", &datafactory.FactoryArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
        })
        if err != nil {
            return err
        }
        testPipeline, err := datafactory.NewPipeline(ctx, "testPipeline", &datafactory.PipelineArgs{
            ResourceGroupName: pulumi.String(azurerm_resource_group.Test.Name),
            DataFactoryName:   pulumi.String(azurerm_data_factory.Test.Name),
        })
        if err != nil {
            return err
        }
        _, err = datafactory.NewTriggerSchedule(ctx, "testTriggerSchedule", &datafactory.TriggerScheduleArgs{
            DataFactoryName:   pulumi.String(azurerm_data_factory.Test.Name),
            ResourceGroupName: pulumi.String(azurerm_resource_group.Test.Name),
            PipelineName:      testPipeline.Name,
            Interval:          pulumi.Int(5),
            Frequency:         pulumi.String("Day"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
test_pipeline = azure.datafactory.Pipeline("testPipeline",
    resource_group_name=azurerm_resource_group["test"]["name"],
    data_factory_name=azurerm_data_factory["test"]["name"])
test_trigger_schedule = azure.datafactory.TriggerSchedule("testTriggerSchedule",
    data_factory_name=azurerm_data_factory["test"]["name"],
    resource_group_name=azurerm_resource_group["test"]["name"],
    pipeline_name=test_pipeline.name,
    interval=5,
    frequency="Day")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "northeurope"});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const testPipeline = new azure.datafactory.Pipeline("testPipeline", {
    resourceGroupName: azurerm_resource_group.test.name,
    dataFactoryName: azurerm_data_factory.test.name,
});
const testTriggerSchedule = new azure.datafactory.TriggerSchedule("testTriggerSchedule", {
    dataFactoryName: azurerm_data_factory.test.name,
    resourceGroupName: azurerm_resource_group.test.name,
    pipelineName: testPipeline.name,
    interval: 5,
    frequency: "Day",
});

Create a TriggerSchedule Resource

new TriggerSchedule(name: string, args: TriggerScheduleArgs, opts?: CustomResourceOptions);

def TriggerSchedule(resource_name, opts=None, annotations=None, data_factory_name=None, end_time=None, frequency=None, interval=None, name=None, pipeline_name=None, pipeline_parameters=None, resource_group_name=None, start_time=None, __props__=None);

func NewTriggerSchedule(ctx *Context, name string, args TriggerScheduleArgs, opts ...ResourceOption) (*TriggerSchedule, error)

public TriggerSchedule(string name, TriggerScheduleArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args TriggerScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TriggerScheduleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TriggerScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

TriggerSchedule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The TriggerSchedule resource accepts the following input properties:

DataFactoryName string: The Data Factory name in which to associate the Schedule Trigger with. Changing this forces a new resource.
PipelineName string: The Data Factory Pipeline name that the trigger will act on.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Schedule Trigger. Changing this forces a new resource
Annotations List<string>: List of tags that can be used for describing the Data Factory Schedule Trigger.
EndTime string: The time the Schedule Trigger should end. The time will be represented in UTC.
Frequency string: The trigger freqency. Valid values include Minute, Hour, Day, Week, Month. Defaults to Minute.
Interval int: The interval for how often the trigger occurs. This defaults to 1.
Name string: 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.
PipelineParameters Dictionary<string, string>: The pipeline parameters that the trigger will act upon.
StartTime string: The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.

DataFactoryName string: The Data Factory name in which to associate the Schedule Trigger with. Changing this forces a new resource.
PipelineName string: The Data Factory Pipeline name that the trigger will act on.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Schedule Trigger. Changing this forces a new resource
Annotations []string: List of tags that can be used for describing the Data Factory Schedule Trigger.
EndTime string: The time the Schedule Trigger should end. The time will be represented in UTC.
Frequency string: The trigger freqency. Valid values include Minute, Hour, Day, Week, Month. Defaults to Minute.
Interval int: The interval for how often the trigger occurs. This defaults to 1.
Name string: 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.
PipelineParameters map[string]string: The pipeline parameters that the trigger will act upon.
StartTime string: The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.

dataFactoryName string: The Data Factory name in which to associate the Schedule Trigger with. Changing this forces a new resource.
pipelineName string: The Data Factory Pipeline name that the trigger will act on.
resourceGroupName string: The name of the resource group in which to create the Data Factory Schedule Trigger. Changing this forces a new resource
annotations string[]: List of tags that can be used for describing the Data Factory Schedule Trigger.
endTime string: The time the Schedule Trigger should end. The time will be represented in UTC.
frequency string: The trigger freqency. Valid values include Minute, Hour, Day, Week, Month. Defaults to Minute.
interval number: The interval for how often the trigger occurs. This defaults to 1.
name string: 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.
pipelineParameters {[key: string]: string}: The pipeline parameters that the trigger will act upon.
startTime string: The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.

data_factory_name str: The Data Factory name in which to associate the Schedule Trigger with. Changing this forces a new resource.
pipeline_name str: The Data Factory Pipeline name that the trigger will act on.
resource_group_name str: The name of the resource group in which to create the Data Factory Schedule Trigger. Changing this forces a new resource
annotations List[str]: List of tags that can be used for describing the Data Factory Schedule Trigger.
end_time str: The time the Schedule Trigger should end. The time will be represented in UTC.
frequency str: The trigger freqency. Valid values include Minute, Hour, Day, Week, Month. Defaults to Minute.
interval float: The interval for how often the trigger occurs. This defaults to 1.
name str: 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.
pipeline_parameters Dict[str, str]: The pipeline parameters that the trigger will act upon.
start_time str: The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.

Outputs

All input properties are implicitly available as output properties. Additionally, the TriggerSchedule resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing TriggerSchedule Resource

Get an existing TriggerSchedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TriggerScheduleState, opts?: CustomResourceOptions): TriggerSchedule

static get(resource_name, id, opts=None, annotations=None, data_factory_name=None, end_time=None, frequency=None, interval=None, name=None, pipeline_name=None, pipeline_parameters=None, resource_group_name=None, start_time=None, __props__=None);

func GetTriggerSchedule(ctx *Context, name string, id IDInput, state *TriggerScheduleState, opts ...ResourceOption) (*TriggerSchedule, error)

public static TriggerSchedule Get(string name, Input<string> id, TriggerScheduleState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Annotations List<string>: List of tags that can be used for describing the Data Factory Schedule Trigger.
DataFactoryName string: The Data Factory name in which to associate the Schedule Trigger with. Changing this forces a new resource.
EndTime string: The time the Schedule Trigger should end. The time will be represented in UTC.
Frequency string: The trigger freqency. Valid values include Minute, Hour, Day, Week, Month. Defaults to Minute.
Interval int: The interval for how often the trigger occurs. This defaults to 1.
Name string: 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.
PipelineName string: The Data Factory Pipeline name that the trigger will act on.
PipelineParameters Dictionary<string, string>: The pipeline parameters that the trigger will act upon.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Schedule Trigger. Changing this forces a new resource
StartTime string: The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.

Annotations []string: List of tags that can be used for describing the Data Factory Schedule Trigger.
DataFactoryName string: The Data Factory name in which to associate the Schedule Trigger with. Changing this forces a new resource.
EndTime string: The time the Schedule Trigger should end. The time will be represented in UTC.
Frequency string: The trigger freqency. Valid values include Minute, Hour, Day, Week, Month. Defaults to Minute.
Interval int: The interval for how often the trigger occurs. This defaults to 1.
Name string: 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.
PipelineName string: The Data Factory Pipeline name that the trigger will act on.
PipelineParameters map[string]string: The pipeline parameters that the trigger will act upon.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Schedule Trigger. Changing this forces a new resource
StartTime string: The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.

annotations string[]: List of tags that can be used for describing the Data Factory Schedule Trigger.
dataFactoryName string: The Data Factory name in which to associate the Schedule Trigger with. Changing this forces a new resource.
endTime string: The time the Schedule Trigger should end. The time will be represented in UTC.
frequency string: The trigger freqency. Valid values include Minute, Hour, Day, Week, Month. Defaults to Minute.
interval number: The interval for how often the trigger occurs. This defaults to 1.
name string: 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.
pipelineName string: The Data Factory Pipeline name that the trigger will act on.
pipelineParameters {[key: string]: string}: The pipeline parameters that the trigger will act upon.
resourceGroupName string: The name of the resource group in which to create the Data Factory Schedule Trigger. Changing this forces a new resource
startTime string: The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.

annotations List[str]: List of tags that can be used for describing the Data Factory Schedule Trigger.
data_factory_name str: The Data Factory name in which to associate the Schedule Trigger with. Changing this forces a new resource.
end_time str: The time the Schedule Trigger should end. The time will be represented in UTC.
frequency str: The trigger freqency. Valid values include Minute, Hour, Day, Week, Month. Defaults to Minute.
interval float: The interval for how often the trigger occurs. This defaults to 1.
name str: 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.
pipeline_name str: The Data Factory Pipeline name that the trigger will act on.
pipeline_parameters Dict[str, str]: The pipeline parameters that the trigger will act upon.
resource_group_name str: The name of the resource group in which to create the Data Factory Schedule Trigger. Changing this forces a new resource
start_time str: The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud