Class 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",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

TriggerSchedule

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.DataFactory

Assembly: Pulumi.Azure.dll

Syntax

public class TriggerSchedule : CustomResource

Constructors

TriggerSchedule(String, TriggerScheduleArgs, CustomResourceOptions)

Create a TriggerSchedule resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
TriggerScheduleArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Annotations

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

Declaration

public Output<ImmutableArray<string>> Annotations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

DataFactoryName

The Data Factory name in which to associate the Schedule Trigger with. Changing this forces a new resource.

Declaration

public Output<string> DataFactoryName { get; }

Property Value

Type	Description
Output<System.String>

EndTime

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

Declaration

public Output<string> EndTime { get; }

Property Value

Type	Description
Output<System.String>

Frequency

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

Declaration

public Output<string> Frequency { get; }

Property Value

Type	Description
Output<System.String>

Interval

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

Declaration

public Output<int?> Interval { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Name

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.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

PipelineName

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

Declaration

public Output<string> PipelineName { get; }

Property Value

Type	Description
Output<System.String>

PipelineParameters

The pipeline parameters that the trigger will act upon.

Declaration

public Output<ImmutableDictionary<string, string>> PipelineParameters { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

ResourceGroupName

The name of the resource group in which to create the Data Factory Schedule Trigger. Changing this forces a new resource

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

StartTime

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

Declaration

public Output<string> StartTime { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, TriggerScheduleState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
TriggerScheduleState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
TriggerSchedule