Azure Classic

v5.24.0 published on Wednesday, Nov 9, 2022 by Pulumi

TriggerSchedule

Manages a Trigger Schedule inside a Azure Data Factory.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var examplePipeline = new Azure.DataFactory.Pipeline("examplePipeline", new()
    {
        DataFactoryId = exampleFactory.Id,
    });

    var exampleTriggerSchedule = new Azure.DataFactory.TriggerSchedule("exampleTriggerSchedule", new()
    {
        DataFactoryId = exampleFactory.Id,
        PipelineName = examplePipeline.Name,
        Interval = 5,
        Frequency = "Day",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleFactory, err := datafactory.NewFactory(ctx, "exampleFactory", &datafactory.FactoryArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		examplePipeline, err := datafactory.NewPipeline(ctx, "examplePipeline", &datafactory.PipelineArgs{
			DataFactoryId: exampleFactory.ID(),
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewTriggerSchedule(ctx, "exampleTriggerSchedule", &datafactory.TriggerScheduleArgs{
			DataFactoryId: exampleFactory.ID(),
			PipelineName:  examplePipeline.Name,
			Interval:      pulumi.Int(5),
			Frequency:     pulumi.String("Day"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_pipeline = azure.datafactory.Pipeline("examplePipeline", data_factory_id=example_factory.id)
example_trigger_schedule = azure.datafactory.TriggerSchedule("exampleTriggerSchedule",
    data_factory_id=example_factory.id,
    pipeline_name=example_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: "West Europe"});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const examplePipeline = new azure.datafactory.Pipeline("examplePipeline", {dataFactoryId: exampleFactory.id});
const exampleTriggerSchedule = new azure.datafactory.TriggerSchedule("exampleTriggerSchedule", {
    dataFactoryId: exampleFactory.id,
    pipelineName: examplePipeline.name,
    interval: 5,
    frequency: "Day",
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  examplePipeline:
    type: azure:datafactory:Pipeline
    properties:
      dataFactoryId: ${exampleFactory.id}
  exampleTriggerSchedule:
    type: azure:datafactory:TriggerSchedule
    properties:
      dataFactoryId: ${exampleFactory.id}
      pipelineName: ${examplePipeline.name}
      interval: 5
      frequency: Day

Create TriggerSchedule Resource

new TriggerSchedule(name: string, args: TriggerScheduleArgs, opts?: CustomResourceOptions);
@overload
def TriggerSchedule(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    activated: Optional[bool] = None,
                    annotations: Optional[Sequence[str]] = None,
                    data_factory_id: Optional[str] = None,
                    description: Optional[str] = None,
                    end_time: Optional[str] = None,
                    frequency: Optional[str] = None,
                    interval: Optional[int] = None,
                    name: Optional[str] = None,
                    pipeline_name: Optional[str] = None,
                    pipeline_parameters: Optional[Mapping[str, str]] = None,
                    pipelines: Optional[Sequence[TriggerSchedulePipelineArgs]] = None,
                    schedule: Optional[TriggerScheduleScheduleArgs] = None,
                    start_time: Optional[str] = None,
                    time_zone: Optional[str] = None)
@overload
def TriggerSchedule(resource_name: str,
                    args: TriggerScheduleArgs,
                    opts: Optional[ResourceOptions] = None)
func NewTriggerSchedule(ctx *Context, name string, args TriggerScheduleArgs, opts ...ResourceOption) (*TriggerSchedule, error)
public TriggerSchedule(string name, TriggerScheduleArgs args, CustomResourceOptions? opts = null)
public TriggerSchedule(String name, TriggerScheduleArgs args)
public TriggerSchedule(String name, TriggerScheduleArgs args, CustomResourceOptions options)
type: azure:datafactory:TriggerSchedule
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args TriggerScheduleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control 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.
name String
The unique name of the resource.
args TriggerScheduleArgs
The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The TriggerSchedule resource accepts the following input properties:

DataFactoryId string

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

Activated bool

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

Annotations List<string>

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

Description string

The Schedule Trigger's description.

EndTime string

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

Frequency string

The trigger frequency. 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.

Pipelines List<TriggerSchedulePipelineArgs>

block as defined below.

Schedule TriggerScheduleScheduleArgs

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.

StartTime string

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

TimeZone string

The timezone of the start/end time.

DataFactoryId string

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

Activated bool

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

Annotations []string

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

Description string

The Schedule Trigger's description.

EndTime string

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

Frequency string

The trigger frequency. 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.

Pipelines []TriggerSchedulePipelineArgs

block as defined below.

Schedule TriggerScheduleScheduleArgs

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.

StartTime string

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

TimeZone string

The timezone of the start/end time.

dataFactoryId String

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

activated Boolean

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

annotations List<String>

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

description String

The Schedule Trigger's description.

endTime String

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

frequency String

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

interval Integer

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.

pipelines List<TriggerSchedulePipelineArgs>

block as defined below.

schedule TriggerScheduleScheduleArgs

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.

startTime String

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

timeZone String

The timezone of the start/end time.

dataFactoryId string

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

activated boolean

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

annotations string[]

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

description string

The Schedule Trigger's description.

endTime string

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

frequency string

The trigger frequency. 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.

pipelines TriggerSchedulePipelineArgs[]

block as defined below.

schedule TriggerScheduleScheduleArgs

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.

startTime string

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

timeZone string

The timezone of the start/end time.

data_factory_id str

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

activated bool

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

annotations Sequence[str]

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

description str

The Schedule Trigger's description.

end_time str

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

frequency str

The trigger frequency. 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 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 Mapping[str, str]

The pipeline parameters that the trigger will act upon.

pipelines Sequence[TriggerSchedulePipelineArgs]

block as defined below.

schedule TriggerScheduleScheduleArgs

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.

start_time str

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

time_zone str

The timezone of the start/end time.

dataFactoryId String

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

activated Boolean

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

annotations List<String>

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

description String

The Schedule Trigger's description.

endTime String

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

frequency String

The trigger frequency. 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 Map<String>

The pipeline parameters that the trigger will act upon.

pipelines List<Property Map>

block as defined below.

schedule Property Map

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.

startTime String

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

timeZone String

The timezone of the start/end time.

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 string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up 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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activated: Optional[bool] = None,
        annotations: Optional[Sequence[str]] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        end_time: Optional[str] = None,
        frequency: Optional[str] = None,
        interval: Optional[int] = None,
        name: Optional[str] = None,
        pipeline_name: Optional[str] = None,
        pipeline_parameters: Optional[Mapping[str, str]] = None,
        pipelines: Optional[Sequence[TriggerSchedulePipelineArgs]] = None,
        schedule: Optional[TriggerScheduleScheduleArgs] = None,
        start_time: Optional[str] = None,
        time_zone: Optional[str] = None) -> TriggerSchedule
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)
public static TriggerSchedule get(String name, Output<String> id, TriggerScheduleState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
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:
Activated bool

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

Annotations List<string>

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

DataFactoryId string

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

Description string

The Schedule Trigger's description.

EndTime string

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

Frequency string

The trigger frequency. 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.

Pipelines List<TriggerSchedulePipelineArgs>

block as defined below.

Schedule TriggerScheduleScheduleArgs

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.

StartTime string

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

TimeZone string

The timezone of the start/end time.

Activated bool

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

Annotations []string

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

DataFactoryId string

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

Description string

The Schedule Trigger's description.

EndTime string

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

Frequency string

The trigger frequency. 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.

Pipelines []TriggerSchedulePipelineArgs

block as defined below.

Schedule TriggerScheduleScheduleArgs

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.

StartTime string

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

TimeZone string

The timezone of the start/end time.

activated Boolean

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

annotations List<String>

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

dataFactoryId String

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

description String

The Schedule Trigger's description.

endTime String

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

frequency String

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

interval Integer

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.

pipelines List<TriggerSchedulePipelineArgs>

block as defined below.

schedule TriggerScheduleScheduleArgs

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.

startTime String

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

timeZone String

The timezone of the start/end time.

activated boolean

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

annotations string[]

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

dataFactoryId string

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

description string

The Schedule Trigger's description.

endTime string

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

frequency string

The trigger frequency. 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.

pipelines TriggerSchedulePipelineArgs[]

block as defined below.

schedule TriggerScheduleScheduleArgs

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.

startTime string

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

timeZone string

The timezone of the start/end time.

activated bool

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

annotations Sequence[str]

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

data_factory_id str

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

description str

The Schedule Trigger's description.

end_time str

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

frequency str

The trigger frequency. 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 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 Mapping[str, str]

The pipeline parameters that the trigger will act upon.

pipelines Sequence[TriggerSchedulePipelineArgs]

block as defined below.

schedule TriggerScheduleScheduleArgs

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.

start_time str

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

time_zone str

The timezone of the start/end time.

activated Boolean

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

annotations List<String>

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

dataFactoryId String

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

description String

The Schedule Trigger's description.

endTime String

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

frequency String

The trigger frequency. 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 Map<String>

The pipeline parameters that the trigger will act upon.

pipelines List<Property Map>

block as defined below.

schedule Property Map

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.

startTime String

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

timeZone String

The timezone of the start/end time.

Supporting Types

TriggerSchedulePipeline

Name string

Reference pipeline name.

Parameters Dictionary<string, string>

The pipeline parameters that the trigger will act upon.

Name string

Reference pipeline name.

Parameters map[string]string

The pipeline parameters that the trigger will act upon.

name String

Reference pipeline name.

parameters Map<String,String>

The pipeline parameters that the trigger will act upon.

name string

Reference pipeline name.

parameters {[key: string]: string}

The pipeline parameters that the trigger will act upon.

name str

Reference pipeline name.

parameters Mapping[str, str]

The pipeline parameters that the trigger will act upon.

name String

Reference pipeline name.

parameters Map<String>

The pipeline parameters that the trigger will act upon.

TriggerScheduleSchedule

DaysOfMonths List<int>

Day(s) of the month on which the trigger is scheduled. This value can be specified with a monthly frequency only.

DaysOfWeeks List<string>

Days of the week on which the trigger is scheduled. This value can be specified only with a weekly frequency.

Hours List<int>

Hours of the day on which the trigger is scheduled.

Minutes List<int>

Minutes of the hour on which the trigger is scheduled.

Monthlies List<TriggerScheduleScheduleMonthly>

A monthly block as documented below, which specifies the days of the month on which the trigger is scheduled. The value can be specified only with a monthly frequency.

DaysOfMonths []int

Day(s) of the month on which the trigger is scheduled. This value can be specified with a monthly frequency only.

DaysOfWeeks []string

Days of the week on which the trigger is scheduled. This value can be specified only with a weekly frequency.

Hours []int

Hours of the day on which the trigger is scheduled.

Minutes []int

Minutes of the hour on which the trigger is scheduled.

Monthlies []TriggerScheduleScheduleMonthly

A monthly block as documented below, which specifies the days of the month on which the trigger is scheduled. The value can be specified only with a monthly frequency.

daysOfMonths List<Integer>

Day(s) of the month on which the trigger is scheduled. This value can be specified with a monthly frequency only.

daysOfWeeks List<String>

Days of the week on which the trigger is scheduled. This value can be specified only with a weekly frequency.

hours List<Integer>

Hours of the day on which the trigger is scheduled.

minutes List<Integer>

Minutes of the hour on which the trigger is scheduled.

monthlies List<TriggerScheduleScheduleMonthly>

A monthly block as documented below, which specifies the days of the month on which the trigger is scheduled. The value can be specified only with a monthly frequency.

daysOfMonths number[]

Day(s) of the month on which the trigger is scheduled. This value can be specified with a monthly frequency only.

daysOfWeeks string[]

Days of the week on which the trigger is scheduled. This value can be specified only with a weekly frequency.

hours number[]

Hours of the day on which the trigger is scheduled.

minutes number[]

Minutes of the hour on which the trigger is scheduled.

monthlies TriggerScheduleScheduleMonthly[]

A monthly block as documented below, which specifies the days of the month on which the trigger is scheduled. The value can be specified only with a monthly frequency.

days_of_months Sequence[int]

Day(s) of the month on which the trigger is scheduled. This value can be specified with a monthly frequency only.

days_of_weeks Sequence[str]

Days of the week on which the trigger is scheduled. This value can be specified only with a weekly frequency.

hours Sequence[int]

Hours of the day on which the trigger is scheduled.

minutes Sequence[int]

Minutes of the hour on which the trigger is scheduled.

monthlies Sequence[TriggerScheduleScheduleMonthly]

A monthly block as documented below, which specifies the days of the month on which the trigger is scheduled. The value can be specified only with a monthly frequency.

daysOfMonths List<Number>

Day(s) of the month on which the trigger is scheduled. This value can be specified with a monthly frequency only.

daysOfWeeks List<String>

Days of the week on which the trigger is scheduled. This value can be specified only with a weekly frequency.

hours List<Number>

Hours of the day on which the trigger is scheduled.

minutes List<Number>

Minutes of the hour on which the trigger is scheduled.

monthlies List<Property Map>

A monthly block as documented below, which specifies the days of the month on which the trigger is scheduled. The value can be specified only with a monthly frequency.

TriggerScheduleScheduleMonthly

Weekday string

The day of the week on which the trigger runs. For example, a monthly property with a weekday value of Sunday means every Sunday of the month.

Week int

The occurrence of the specified day during the month. For example, a monthly property with weekday and week values of Sunday, -1 means the last Sunday of the month.

Weekday string

The day of the week on which the trigger runs. For example, a monthly property with a weekday value of Sunday means every Sunday of the month.

Week int

The occurrence of the specified day during the month. For example, a monthly property with weekday and week values of Sunday, -1 means the last Sunday of the month.

weekday String

The day of the week on which the trigger runs. For example, a monthly property with a weekday value of Sunday means every Sunday of the month.

week Integer

The occurrence of the specified day during the month. For example, a monthly property with weekday and week values of Sunday, -1 means the last Sunday of the month.

weekday string

The day of the week on which the trigger runs. For example, a monthly property with a weekday value of Sunday means every Sunday of the month.

week number

The occurrence of the specified day during the month. For example, a monthly property with weekday and week values of Sunday, -1 means the last Sunday of the month.

weekday str

The day of the week on which the trigger runs. For example, a monthly property with a weekday value of Sunday means every Sunday of the month.

week int

The occurrence of the specified day during the month. For example, a monthly property with weekday and week values of Sunday, -1 means the last Sunday of the month.

weekday String

The day of the week on which the trigger runs. For example, a monthly property with a weekday value of Sunday means every Sunday of the month.

week Number

The occurrence of the specified day during the month. For example, a monthly property with weekday and week values of Sunday, -1 means the last Sunday of the month.

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.