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

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.datafactory.TriggerCustomEvent

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Custom Event Trigger inside an 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 exampleTopic = new azure.eventgrid.Topic("example", {
    name: "example-topic",
    location: example.location,
    resourceGroupName: example.name,
});
const exampleTriggerCustomEvent = new azure.datafactory.TriggerCustomEvent("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    eventgridTopicId: exampleTopic.id,
    events: [
        "event1",
        "event2",
    ],
    subjectBeginsWith: "abc",
    subjectEndsWith: "xyz",
    annotations: [
        "example1",
        "example2",
        "example3",
    ],
    description: "example description",
    pipelines: [{
        name: examplePipeline.name,
        parameters: {
            Env: "Prod",
        },
    }],
    additionalProperties: {
        foo: "foo1",
        bar: "bar2",
    },
});
Copy
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_topic = azure.eventgrid.Topic("example",
    name="example-topic",
    location=example.location,
    resource_group_name=example.name)
example_trigger_custom_event = azure.datafactory.TriggerCustomEvent("example",
    name="example",
    data_factory_id=example_factory.id,
    eventgrid_topic_id=example_topic.id,
    events=[
        "event1",
        "event2",
    ],
    subject_begins_with="abc",
    subject_ends_with="xyz",
    annotations=[
        "example1",
        "example2",
        "example3",
    ],
    description="example description",
    pipelines=[{
        "name": example_pipeline.name,
        "parameters": {
            "Env": "Prod",
        },
    }],
    additional_properties={
        "foo": "foo1",
        "bar": "bar2",
    })
Copy
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-azure/sdk/v6/go/azure/eventgrid"
	"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
		}
		exampleTopic, err := eventgrid.NewTopic(ctx, "example", &eventgrid.TopicArgs{
			Name:              pulumi.String("example-topic"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewTriggerCustomEvent(ctx, "example", &datafactory.TriggerCustomEventArgs{
			Name:             pulumi.String("example"),
			DataFactoryId:    exampleFactory.ID(),
			EventgridTopicId: exampleTopic.ID(),
			Events: pulumi.StringArray{
				pulumi.String("event1"),
				pulumi.String("event2"),
			},
			SubjectBeginsWith: pulumi.String("abc"),
			SubjectEndsWith:   pulumi.String("xyz"),
			Annotations: pulumi.StringArray{
				pulumi.String("example1"),
				pulumi.String("example2"),
				pulumi.String("example3"),
			},
			Description: pulumi.String("example description"),
			Pipelines: datafactory.TriggerCustomEventPipelineArray{
				&datafactory.TriggerCustomEventPipelineArgs{
					Name: examplePipeline.Name,
					Parameters: pulumi.StringMap{
						"Env": pulumi.String("Prod"),
					},
				},
			},
			AdditionalProperties: pulumi.StringMap{
				"foo": pulumi.String("foo1"),
				"bar": pulumi.String("bar2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 exampleTopic = new Azure.EventGrid.Topic("example", new()
    {
        Name = "example-topic",
        Location = example.Location,
        ResourceGroupName = example.Name,
    });

    var exampleTriggerCustomEvent = new Azure.DataFactory.TriggerCustomEvent("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        EventgridTopicId = exampleTopic.Id,
        Events = new[]
        {
            "event1",
            "event2",
        },
        SubjectBeginsWith = "abc",
        SubjectEndsWith = "xyz",
        Annotations = new[]
        {
            "example1",
            "example2",
            "example3",
        },
        Description = "example description",
        Pipelines = new[]
        {
            new Azure.DataFactory.Inputs.TriggerCustomEventPipelineArgs
            {
                Name = examplePipeline.Name,
                Parameters = 
                {
                    { "Env", "Prod" },
                },
            },
        },
        AdditionalProperties = 
        {
            { "foo", "foo1" },
            { "bar", "bar2" },
        },
    });

});
Copy
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.eventgrid.Topic;
import com.pulumi.azure.eventgrid.TopicArgs;
import com.pulumi.azure.datafactory.TriggerCustomEvent;
import com.pulumi.azure.datafactory.TriggerCustomEventArgs;
import com.pulumi.azure.datafactory.inputs.TriggerCustomEventPipelineArgs;
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 exampleTopic = new Topic("exampleTopic", TopicArgs.builder()
            .name("example-topic")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());

        var exampleTriggerCustomEvent = new TriggerCustomEvent("exampleTriggerCustomEvent", TriggerCustomEventArgs.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .eventgridTopicId(exampleTopic.id())
            .events(            
                "event1",
                "event2")
            .subjectBeginsWith("abc")
            .subjectEndsWith("xyz")
            .annotations(            
                "example1",
                "example2",
                "example3")
            .description("example description")
            .pipelines(TriggerCustomEventPipelineArgs.builder()
                .name(examplePipeline.name())
                .parameters(Map.of("Env", "Prod"))
                .build())
            .additionalProperties(Map.ofEntries(
                Map.entry("foo", "foo1"),
                Map.entry("bar", "bar2")
            ))
            .build());

    }
}
Copy
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}
  exampleTopic:
    type: azure:eventgrid:Topic
    name: example
    properties:
      name: example-topic
      location: ${example.location}
      resourceGroupName: ${example.name}
  exampleTriggerCustomEvent:
    type: azure:datafactory:TriggerCustomEvent
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      eventgridTopicId: ${exampleTopic.id}
      events:
        - event1
        - event2
      subjectBeginsWith: abc
      subjectEndsWith: xyz
      annotations:
        - example1
        - example2
        - example3
      description: example description
      pipelines:
        - name: ${examplePipeline.name}
          parameters:
            Env: Prod
      additionalProperties:
        foo: foo1
        bar: bar2
Copy

Create TriggerCustomEvent Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new TriggerCustomEvent(name: string, args: TriggerCustomEventArgs, opts?: CustomResourceOptions);
@overload
def TriggerCustomEvent(resource_name: str,
                       args: TriggerCustomEventArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def TriggerCustomEvent(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       data_factory_id: Optional[str] = None,
                       eventgrid_topic_id: Optional[str] = None,
                       events: Optional[Sequence[str]] = None,
                       pipelines: Optional[Sequence[TriggerCustomEventPipelineArgs]] = None,
                       activated: Optional[bool] = None,
                       additional_properties: Optional[Mapping[str, str]] = None,
                       annotations: Optional[Sequence[str]] = None,
                       description: Optional[str] = None,
                       name: Optional[str] = None,
                       subject_begins_with: Optional[str] = None,
                       subject_ends_with: Optional[str] = None)
func NewTriggerCustomEvent(ctx *Context, name string, args TriggerCustomEventArgs, opts ...ResourceOption) (*TriggerCustomEvent, error)
public TriggerCustomEvent(string name, TriggerCustomEventArgs args, CustomResourceOptions? opts = null)
public TriggerCustomEvent(String name, TriggerCustomEventArgs args)
public TriggerCustomEvent(String name, TriggerCustomEventArgs args, CustomResourceOptions options)

type: azure:datafactory:TriggerCustomEvent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TriggerCustomEventArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TriggerCustomEventArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TriggerCustomEventArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TriggerCustomEventArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TriggerCustomEventArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var triggerCustomEventResource = new Azure.DataFactory.TriggerCustomEvent("triggerCustomEventResource", new()
{
    DataFactoryId = "string",
    EventgridTopicId = "string",
    Events = new[]
    {
        "string",
    },
    Pipelines = new[]
    {
        new Azure.DataFactory.Inputs.TriggerCustomEventPipelineArgs
        {
            Name = "string",
            Parameters = 
            {
                { "string", "string" },
            },
        },
    },
    Activated = false,
    AdditionalProperties = 
    {
        { "string", "string" },
    },
    Annotations = new[]
    {
        "string",
    },
    Description = "string",
    Name = "string",
    SubjectBeginsWith = "string",
    SubjectEndsWith = "string",
});
Copy
example, err := datafactory.NewTriggerCustomEvent(ctx, "triggerCustomEventResource", &datafactory.TriggerCustomEventArgs{
	DataFactoryId:    pulumi.String("string"),
	EventgridTopicId: pulumi.String("string"),
	Events: pulumi.StringArray{
		pulumi.String("string"),
	},
	Pipelines: datafactory.TriggerCustomEventPipelineArray{
		&datafactory.TriggerCustomEventPipelineArgs{
			Name: pulumi.String("string"),
			Parameters: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
	Activated: pulumi.Bool(false),
	AdditionalProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Annotations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:       pulumi.String("string"),
	Name:              pulumi.String("string"),
	SubjectBeginsWith: pulumi.String("string"),
	SubjectEndsWith:   pulumi.String("string"),
})
Copy
var triggerCustomEventResource = new TriggerCustomEvent("triggerCustomEventResource", TriggerCustomEventArgs.builder()
    .dataFactoryId("string")
    .eventgridTopicId("string")
    .events("string")
    .pipelines(TriggerCustomEventPipelineArgs.builder()
        .name("string")
        .parameters(Map.of("string", "string"))
        .build())
    .activated(false)
    .additionalProperties(Map.of("string", "string"))
    .annotations("string")
    .description("string")
    .name("string")
    .subjectBeginsWith("string")
    .subjectEndsWith("string")
    .build());
Copy
trigger_custom_event_resource = azure.datafactory.TriggerCustomEvent("triggerCustomEventResource",
    data_factory_id="string",
    eventgrid_topic_id="string",
    events=["string"],
    pipelines=[{
        "name": "string",
        "parameters": {
            "string": "string",
        },
    }],
    activated=False,
    additional_properties={
        "string": "string",
    },
    annotations=["string"],
    description="string",
    name="string",
    subject_begins_with="string",
    subject_ends_with="string")
Copy
const triggerCustomEventResource = new azure.datafactory.TriggerCustomEvent("triggerCustomEventResource", {
    dataFactoryId: "string",
    eventgridTopicId: "string",
    events: ["string"],
    pipelines: [{
        name: "string",
        parameters: {
            string: "string",
        },
    }],
    activated: false,
    additionalProperties: {
        string: "string",
    },
    annotations: ["string"],
    description: "string",
    name: "string",
    subjectBeginsWith: "string",
    subjectEndsWith: "string",
});
Copy
type: azure:datafactory:TriggerCustomEvent
properties:
    activated: false
    additionalProperties:
        string: string
    annotations:
        - string
    dataFactoryId: string
    description: string
    eventgridTopicId: string
    events:
        - string
    name: string
    pipelines:
        - name: string
          parameters:
            string: string
    subjectBeginsWith: string
    subjectEndsWith: string
Copy

TriggerCustomEvent Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TriggerCustomEvent resource accepts the following input properties:

DataFactoryId
This property is required.
Changes to this property will trigger replacement.
string
The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
EventgridTopicId
This property is required.
Changes to this property will trigger replacement.
string
The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.
Events This property is required. List<string>
List of events that will fire this trigger. At least one event must be specified.
Pipelines This property is required. List<TriggerCustomEventPipeline>
One or more pipeline blocks as defined below.
Activated bool
Specifies if the Data Factory Custom Event Trigger is activated. Defaults to true.
AdditionalProperties Dictionary<string, string>
A map of additional properties to associate with the Data Factory Custom Event Trigger.
Annotations List<string>
List of tags that can be used for describing the Data Factory Custom Event Trigger.
Description string
The description for the Data Factory Custom Event Trigger.
Name Changes to this property will trigger replacement. string
Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.
SubjectBeginsWith string
The pattern that event subject starts with for trigger to fire.
SubjectEndsWith string
The pattern that event subject ends with for trigger to fire.
DataFactoryId
This property is required.
Changes to this property will trigger replacement.
string
The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
EventgridTopicId
This property is required.
Changes to this property will trigger replacement.
string
The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.
Events This property is required. []string
List of events that will fire this trigger. At least one event must be specified.
Pipelines This property is required. []TriggerCustomEventPipelineArgs
One or more pipeline blocks as defined below.
Activated bool
Specifies if the Data Factory Custom Event Trigger is activated. Defaults to true.
AdditionalProperties map[string]string
A map of additional properties to associate with the Data Factory Custom Event Trigger.
Annotations []string
List of tags that can be used for describing the Data Factory Custom Event Trigger.
Description string
The description for the Data Factory Custom Event Trigger.
Name Changes to this property will trigger replacement. string
Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.
SubjectBeginsWith string
The pattern that event subject starts with for trigger to fire.
SubjectEndsWith string
The pattern that event subject ends with for trigger to fire.
dataFactoryId
This property is required.
Changes to this property will trigger replacement.
String
The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
eventgridTopicId
This property is required.
Changes to this property will trigger replacement.
String
The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.
events This property is required. List<String>
List of events that will fire this trigger. At least one event must be specified.
pipelines This property is required. List<TriggerCustomEventPipeline>
One or more pipeline blocks as defined below.
activated Boolean
Specifies if the Data Factory Custom Event Trigger is activated. Defaults to true.
additionalProperties Map<String,String>
A map of additional properties to associate with the Data Factory Custom Event Trigger.
annotations List<String>
List of tags that can be used for describing the Data Factory Custom Event Trigger.
description String
The description for the Data Factory Custom Event Trigger.
name Changes to this property will trigger replacement. String
Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.
subjectBeginsWith String
The pattern that event subject starts with for trigger to fire.
subjectEndsWith String
The pattern that event subject ends with for trigger to fire.
dataFactoryId
This property is required.
Changes to this property will trigger replacement.
string
The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
eventgridTopicId
This property is required.
Changes to this property will trigger replacement.
string
The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.
events This property is required. string[]
List of events that will fire this trigger. At least one event must be specified.
pipelines This property is required. TriggerCustomEventPipeline[]
One or more pipeline blocks as defined below.
activated boolean
Specifies if the Data Factory Custom Event Trigger is activated. Defaults to true.
additionalProperties {[key: string]: string}
A map of additional properties to associate with the Data Factory Custom Event Trigger.
annotations string[]
List of tags that can be used for describing the Data Factory Custom Event Trigger.
description string
The description for the Data Factory Custom Event Trigger.
name Changes to this property will trigger replacement. string
Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.
subjectBeginsWith string
The pattern that event subject starts with for trigger to fire.
subjectEndsWith string
The pattern that event subject ends with for trigger to fire.
data_factory_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
eventgrid_topic_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.
events This property is required. Sequence[str]
List of events that will fire this trigger. At least one event must be specified.
pipelines This property is required. Sequence[TriggerCustomEventPipelineArgs]
One or more pipeline blocks as defined below.
activated bool
Specifies if the Data Factory Custom Event Trigger is activated. Defaults to true.
additional_properties Mapping[str, str]
A map of additional properties to associate with the Data Factory Custom Event Trigger.
annotations Sequence[str]
List of tags that can be used for describing the Data Factory Custom Event Trigger.
description str
The description for the Data Factory Custom Event Trigger.
name Changes to this property will trigger replacement. str
Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.
subject_begins_with str
The pattern that event subject starts with for trigger to fire.
subject_ends_with str
The pattern that event subject ends with for trigger to fire.
dataFactoryId
This property is required.
Changes to this property will trigger replacement.
String
The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
eventgridTopicId
This property is required.
Changes to this property will trigger replacement.
String
The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.
events This property is required. List<String>
List of events that will fire this trigger. At least one event must be specified.
pipelines This property is required. List<Property Map>
One or more pipeline blocks as defined below.
activated Boolean
Specifies if the Data Factory Custom Event Trigger is activated. Defaults to true.
additionalProperties Map<String>
A map of additional properties to associate with the Data Factory Custom Event Trigger.
annotations List<String>
List of tags that can be used for describing the Data Factory Custom Event Trigger.
description String
The description for the Data Factory Custom Event Trigger.
name Changes to this property will trigger replacement. String
Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.
subjectBeginsWith String
The pattern that event subject starts with for trigger to fire.
subjectEndsWith String
The pattern that event subject ends with for trigger to fire.

Outputs

All input properties are implicitly available as output properties. Additionally, the TriggerCustomEvent 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 TriggerCustomEvent Resource

Get an existing TriggerCustomEvent 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?: TriggerCustomEventState, opts?: CustomResourceOptions): TriggerCustomEvent
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activated: Optional[bool] = None,
        additional_properties: Optional[Mapping[str, str]] = None,
        annotations: Optional[Sequence[str]] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        eventgrid_topic_id: Optional[str] = None,
        events: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        pipelines: Optional[Sequence[TriggerCustomEventPipelineArgs]] = None,
        subject_begins_with: Optional[str] = None,
        subject_ends_with: Optional[str] = None) -> TriggerCustomEvent
func GetTriggerCustomEvent(ctx *Context, name string, id IDInput, state *TriggerCustomEventState, opts ...ResourceOption) (*TriggerCustomEvent, error)
public static TriggerCustomEvent Get(string name, Input<string> id, TriggerCustomEventState? state, CustomResourceOptions? opts = null)
public static TriggerCustomEvent get(String name, Output<String> id, TriggerCustomEventState state, CustomResourceOptions options)
resources:  _:    type: azure:datafactory:TriggerCustomEvent    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Custom Event Trigger is activated. Defaults to true.
AdditionalProperties Dictionary<string, string>
A map of additional properties to associate with the Data Factory Custom Event Trigger.
Annotations List<string>
List of tags that can be used for describing the Data Factory Custom Event Trigger.
DataFactoryId Changes to this property will trigger replacement. string
The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
Description string
The description for the Data Factory Custom Event Trigger.
EventgridTopicId Changes to this property will trigger replacement. string
The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.
Events List<string>
List of events that will fire this trigger. At least one event must be specified.
Name Changes to this property will trigger replacement. string
Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.
Pipelines List<TriggerCustomEventPipeline>
One or more pipeline blocks as defined below.
SubjectBeginsWith string
The pattern that event subject starts with for trigger to fire.
SubjectEndsWith string
The pattern that event subject ends with for trigger to fire.
Activated bool
Specifies if the Data Factory Custom Event Trigger is activated. Defaults to true.
AdditionalProperties map[string]string
A map of additional properties to associate with the Data Factory Custom Event Trigger.
Annotations []string
List of tags that can be used for describing the Data Factory Custom Event Trigger.
DataFactoryId Changes to this property will trigger replacement. string
The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
Description string
The description for the Data Factory Custom Event Trigger.
EventgridTopicId Changes to this property will trigger replacement. string
The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.
Events []string
List of events that will fire this trigger. At least one event must be specified.
Name Changes to this property will trigger replacement. string
Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.
Pipelines []TriggerCustomEventPipelineArgs
One or more pipeline blocks as defined below.
SubjectBeginsWith string
The pattern that event subject starts with for trigger to fire.
SubjectEndsWith string
The pattern that event subject ends with for trigger to fire.
activated Boolean
Specifies if the Data Factory Custom Event Trigger is activated. Defaults to true.
additionalProperties Map<String,String>
A map of additional properties to associate with the Data Factory Custom Event Trigger.
annotations List<String>
List of tags that can be used for describing the Data Factory Custom Event Trigger.
dataFactoryId Changes to this property will trigger replacement. String
The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
description String
The description for the Data Factory Custom Event Trigger.
eventgridTopicId Changes to this property will trigger replacement. String
The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.
events List<String>
List of events that will fire this trigger. At least one event must be specified.
name Changes to this property will trigger replacement. String
Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.
pipelines List<TriggerCustomEventPipeline>
One or more pipeline blocks as defined below.
subjectBeginsWith String
The pattern that event subject starts with for trigger to fire.
subjectEndsWith String
The pattern that event subject ends with for trigger to fire.
activated boolean
Specifies if the Data Factory Custom Event Trigger is activated. Defaults to true.
additionalProperties {[key: string]: string}
A map of additional properties to associate with the Data Factory Custom Event Trigger.
annotations string[]
List of tags that can be used for describing the Data Factory Custom Event Trigger.
dataFactoryId Changes to this property will trigger replacement. string
The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
description string
The description for the Data Factory Custom Event Trigger.
eventgridTopicId Changes to this property will trigger replacement. string
The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.
events string[]
List of events that will fire this trigger. At least one event must be specified.
name Changes to this property will trigger replacement. string
Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.
pipelines TriggerCustomEventPipeline[]
One or more pipeline blocks as defined below.
subjectBeginsWith string
The pattern that event subject starts with for trigger to fire.
subjectEndsWith string
The pattern that event subject ends with for trigger to fire.
activated bool
Specifies if the Data Factory Custom Event Trigger is activated. Defaults to true.
additional_properties Mapping[str, str]
A map of additional properties to associate with the Data Factory Custom Event Trigger.
annotations Sequence[str]
List of tags that can be used for describing the Data Factory Custom Event Trigger.
data_factory_id Changes to this property will trigger replacement. str
The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
description str
The description for the Data Factory Custom Event Trigger.
eventgrid_topic_id Changes to this property will trigger replacement. str
The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.
events Sequence[str]
List of events that will fire this trigger. At least one event must be specified.
name Changes to this property will trigger replacement. str
Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.
pipelines Sequence[TriggerCustomEventPipelineArgs]
One or more pipeline blocks as defined below.
subject_begins_with str
The pattern that event subject starts with for trigger to fire.
subject_ends_with str
The pattern that event subject ends with for trigger to fire.
activated Boolean
Specifies if the Data Factory Custom Event Trigger is activated. Defaults to true.
additionalProperties Map<String>
A map of additional properties to associate with the Data Factory Custom Event Trigger.
annotations List<String>
List of tags that can be used for describing the Data Factory Custom Event Trigger.
dataFactoryId Changes to this property will trigger replacement. String
The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
description String
The description for the Data Factory Custom Event Trigger.
eventgridTopicId Changes to this property will trigger replacement. String
The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.
events List<String>
List of events that will fire this trigger. At least one event must be specified.
name Changes to this property will trigger replacement. String
Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.
pipelines List<Property Map>
One or more pipeline blocks as defined below.
subjectBeginsWith String
The pattern that event subject starts with for trigger to fire.
subjectEndsWith String
The pattern that event subject ends with for trigger to fire.

Supporting Types

TriggerCustomEventPipeline
, TriggerCustomEventPipelineArgs

Name This property is required. string
The Data Factory Pipeline name that the trigger will act on.
Parameters Dictionary<string, string>
The Data Factory Pipeline parameters that the trigger will act on.
Name This property is required. string
The Data Factory Pipeline name that the trigger will act on.
Parameters map[string]string
The Data Factory Pipeline parameters that the trigger will act on.
name This property is required. String
The Data Factory Pipeline name that the trigger will act on.
parameters Map<String,String>
The Data Factory Pipeline parameters that the trigger will act on.
name This property is required. string
The Data Factory Pipeline name that the trigger will act on.
parameters {[key: string]: string}
The Data Factory Pipeline parameters that the trigger will act on.
name This property is required. str
The Data Factory Pipeline name that the trigger will act on.
parameters Mapping[str, str]
The Data Factory Pipeline parameters that the trigger will act on.
name This property is required. String
The Data Factory Pipeline name that the trigger will act on.
parameters Map<String>
The Data Factory Pipeline parameters that the trigger will act on.

Import

Data Factory Custom Event Trigger can be imported using the resource id, e.g.

$ pulumi import azure:datafactory/triggerCustomEvent:TriggerCustomEvent example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/triggers/example
Copy

To learn more about importing existing cloud resources, see Importing resources.

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.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure