Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. datafactory
  5. getTriggerSchedule

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.datafactory.getTriggerSchedule

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Use this data source to access information about a trigger schedule in Azure Data Factory.

Example Usage

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

const example = azure.datafactory.getTriggerSchedule({
    name: "example_trigger",
    dataFactoryId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DataFactory/factories/datafactory1",
});
export const id = example.then(example => example.id);
Copy
import pulumi
import pulumi_azure as azure

example = azure.datafactory.get_trigger_schedule(name="example_trigger",
    data_factory_id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DataFactory/factories/datafactory1")
pulumi.export("id", example.id)
Copy
package main

import (
	"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 := datafactory.LookupTriggerSchedule(ctx, &datafactory.LookupTriggerScheduleArgs{
			Name:          "example_trigger",
			DataFactoryId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DataFactory/factories/datafactory1",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.DataFactory.GetTriggerSchedule.Invoke(new()
    {
        Name = "example_trigger",
        DataFactoryId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DataFactory/factories/datafactory1",
    });

    return new Dictionary<string, object?>
    {
        ["id"] = example.Apply(getTriggerScheduleResult => getTriggerScheduleResult.Id),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.datafactory.DatafactoryFunctions;
import com.pulumi.azure.datafactory.inputs.GetTriggerScheduleArgs;
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) {
        final var example = DatafactoryFunctions.getTriggerSchedule(GetTriggerScheduleArgs.builder()
            .name("example_trigger")
            .dataFactoryId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DataFactory/factories/datafactory1")
            .build());

        ctx.export("id", example.applyValue(getTriggerScheduleResult -> getTriggerScheduleResult.id()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azure:datafactory:getTriggerSchedule
      arguments:
        name: example_trigger
        dataFactoryId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DataFactory/factories/datafactory1
outputs:
  id: ${example.id}
Copy

Using getTriggerSchedule

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTriggerSchedule(args: GetTriggerScheduleArgs, opts?: InvokeOptions): Promise<GetTriggerScheduleResult>
function getTriggerScheduleOutput(args: GetTriggerScheduleOutputArgs, opts?: InvokeOptions): Output<GetTriggerScheduleResult>
Copy
def get_trigger_schedule(data_factory_id: Optional[str] = None,
                         name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetTriggerScheduleResult
def get_trigger_schedule_output(data_factory_id: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetTriggerScheduleResult]
Copy
func LookupTriggerSchedule(ctx *Context, args *LookupTriggerScheduleArgs, opts ...InvokeOption) (*LookupTriggerScheduleResult, error)
func LookupTriggerScheduleOutput(ctx *Context, args *LookupTriggerScheduleOutputArgs, opts ...InvokeOption) LookupTriggerScheduleResultOutput
Copy

> Note: This function is named LookupTriggerSchedule in the Go SDK.

public static class GetTriggerSchedule 
{
    public static Task<GetTriggerScheduleResult> InvokeAsync(GetTriggerScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetTriggerScheduleResult> Invoke(GetTriggerScheduleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTriggerScheduleResult> getTriggerSchedule(GetTriggerScheduleArgs args, InvokeOptions options)
public static Output<GetTriggerScheduleResult> getTriggerSchedule(GetTriggerScheduleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:datafactory/getTriggerSchedule:getTriggerSchedule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DataFactoryId This property is required. string
The ID of the Azure Data Factory to fetch trigger schedule from.
Name This property is required. string
The name of the trigger schedule.
DataFactoryId This property is required. string
The ID of the Azure Data Factory to fetch trigger schedule from.
Name This property is required. string
The name of the trigger schedule.
dataFactoryId This property is required. String
The ID of the Azure Data Factory to fetch trigger schedule from.
name This property is required. String
The name of the trigger schedule.
dataFactoryId This property is required. string
The ID of the Azure Data Factory to fetch trigger schedule from.
name This property is required. string
The name of the trigger schedule.
data_factory_id This property is required. str
The ID of the Azure Data Factory to fetch trigger schedule from.
name This property is required. str
The name of the trigger schedule.
dataFactoryId This property is required. String
The ID of the Azure Data Factory to fetch trigger schedule from.
name This property is required. String
The name of the trigger schedule.

getTriggerSchedule Result

The following output properties are available:

Activated bool
Specifies if the Data Factory Schedule Trigger is activated.
Annotations List<string>
List of tags that can be used for describing the Data Factory Schedule Trigger.
DataFactoryId string
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.
Id string
The provider-assigned unique ID for this managed resource.
Interval int
The interval for how often the trigger occurs.
Name string
PipelineName string
The Data Factory Pipeline name that the trigger will act on.
Schedules List<GetTriggerScheduleSchedule>
A schedule block as described below, which further specifies the recurrence schedule for the trigger.
StartTime string
The time the Schedule Trigger will start. 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.
Annotations []string
List of tags that can be used for describing the Data Factory Schedule Trigger.
DataFactoryId string
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.
Id string
The provider-assigned unique ID for this managed resource.
Interval int
The interval for how often the trigger occurs.
Name string
PipelineName string
The Data Factory Pipeline name that the trigger will act on.
Schedules []GetTriggerScheduleSchedule
A schedule block as described below, which further specifies the recurrence schedule for the trigger.
StartTime string
The time the Schedule Trigger will start. 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.
annotations List<String>
List of tags that can be used for describing the Data Factory Schedule Trigger.
dataFactoryId String
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.
id String
The provider-assigned unique ID for this managed resource.
interval Integer
The interval for how often the trigger occurs.
name String
pipelineName String
The Data Factory Pipeline name that the trigger will act on.
schedules List<GetTriggerScheduleSchedule>
A schedule block as described below, which further specifies the recurrence schedule for the trigger.
startTime String
The time the Schedule Trigger will start. 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.
annotations string[]
List of tags that can be used for describing the Data Factory Schedule Trigger.
dataFactoryId string
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.
id string
The provider-assigned unique ID for this managed resource.
interval number
The interval for how often the trigger occurs.
name string
pipelineName string
The Data Factory Pipeline name that the trigger will act on.
schedules GetTriggerScheduleSchedule[]
A schedule block as described below, which further specifies the recurrence schedule for the trigger.
startTime string
The time the Schedule Trigger will start. 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.
annotations Sequence[str]
List of tags that can be used for describing the Data Factory Schedule Trigger.
data_factory_id str
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.
id str
The provider-assigned unique ID for this managed resource.
interval int
The interval for how often the trigger occurs.
name str
pipeline_name str
The Data Factory Pipeline name that the trigger will act on.
schedules Sequence[GetTriggerScheduleSchedule]
A schedule block as described below, which further specifies the recurrence schedule for the trigger.
start_time str
The time the Schedule Trigger will start. 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.
annotations List<String>
List of tags that can be used for describing the Data Factory Schedule Trigger.
dataFactoryId String
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.
id String
The provider-assigned unique ID for this managed resource.
interval Number
The interval for how often the trigger occurs.
name String
pipelineName String
The Data Factory Pipeline name that the trigger will act on.
schedules List<Property Map>
A schedule block as described below, which further specifies the recurrence schedule for the trigger.
startTime String
The time the Schedule Trigger will start. The time will be represented in UTC.
timeZone String
The timezone of the start/end time.

Supporting Types

GetTriggerScheduleSchedule

DaysOfMonths This property is required. List<int>
Day(s) of the month on which the trigger is scheduled.
DaysOfWeeks This property is required. List<string>
Day(s) of the week on which the trigger is scheduled.
Hours This property is required. List<int>
Hours of the day on which the trigger is scheduled.
Minutes This property is required. List<int>
Minutes of the hour on which the trigger is scheduled.
Monthlies This property is required. List<GetTriggerScheduleScheduleMonthly>
A monthly block as documented below, which specifies the days of the month on which the trigger is scheduled.
DaysOfMonths This property is required. []int
Day(s) of the month on which the trigger is scheduled.
DaysOfWeeks This property is required. []string
Day(s) of the week on which the trigger is scheduled.
Hours This property is required. []int
Hours of the day on which the trigger is scheduled.
Minutes This property is required. []int
Minutes of the hour on which the trigger is scheduled.
Monthlies This property is required. []GetTriggerScheduleScheduleMonthly
A monthly block as documented below, which specifies the days of the month on which the trigger is scheduled.
daysOfMonths This property is required. List<Integer>
Day(s) of the month on which the trigger is scheduled.
daysOfWeeks This property is required. List<String>
Day(s) of the week on which the trigger is scheduled.
hours This property is required. List<Integer>
Hours of the day on which the trigger is scheduled.
minutes This property is required. List<Integer>
Minutes of the hour on which the trigger is scheduled.
monthlies This property is required. List<GetTriggerScheduleScheduleMonthly>
A monthly block as documented below, which specifies the days of the month on which the trigger is scheduled.
daysOfMonths This property is required. number[]
Day(s) of the month on which the trigger is scheduled.
daysOfWeeks This property is required. string[]
Day(s) of the week on which the trigger is scheduled.
hours This property is required. number[]
Hours of the day on which the trigger is scheduled.
minutes This property is required. number[]
Minutes of the hour on which the trigger is scheduled.
monthlies This property is required. GetTriggerScheduleScheduleMonthly[]
A monthly block as documented below, which specifies the days of the month on which the trigger is scheduled.
days_of_months This property is required. Sequence[int]
Day(s) of the month on which the trigger is scheduled.
days_of_weeks This property is required. Sequence[str]
Day(s) of the week on which the trigger is scheduled.
hours This property is required. Sequence[int]
Hours of the day on which the trigger is scheduled.
minutes This property is required. Sequence[int]
Minutes of the hour on which the trigger is scheduled.
monthlies This property is required. Sequence[GetTriggerScheduleScheduleMonthly]
A monthly block as documented below, which specifies the days of the month on which the trigger is scheduled.
daysOfMonths This property is required. List<Number>
Day(s) of the month on which the trigger is scheduled.
daysOfWeeks This property is required. List<String>
Day(s) of the week on which the trigger is scheduled.
hours This property is required. List<Number>
Hours of the day on which the trigger is scheduled.
minutes This property is required. List<Number>
Minutes of the hour on which the trigger is scheduled.
monthlies This property is required. List<Property Map>
A monthly block as documented below, which specifies the days of the month on which the trigger is scheduled.

GetTriggerScheduleScheduleMonthly

Week This property is required. int
The occurrence of the specified day during the month.
Weekday This property is required. string
The day of the week on which the trigger runs.
Week This property is required. int
The occurrence of the specified day during the month.
Weekday This property is required. string
The day of the week on which the trigger runs.
week This property is required. Integer
The occurrence of the specified day during the month.
weekday This property is required. String
The day of the week on which the trigger runs.
week This property is required. number
The occurrence of the specified day during the month.
weekday This property is required. string
The day of the week on which the trigger runs.
week This property is required. int
The occurrence of the specified day during the month.
weekday This property is required. str
The day of the week on which the trigger runs.
week This property is required. Number
The occurrence of the specified day during the month.
weekday This property is required. String
The day of the week on which the trigger runs.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure