Azure Data Factory Trigger Custom Event
This page shows how to write Terraform and Azure Resource Manager for Data Factory Trigger Custom Event and write them securely.
azurerm_data_factory_trigger_custom_event (Terraform)
The Trigger Custom Event in Data Factory can be configured in Terraform with the resource name azurerm_data_factory_trigger_custom_event
. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
The following arguments are supported:
name
- (Required) Specifies the name of the Data Factory Custom Event Trigger. Changing this forces a new resource to be created.data_factory_id
- (Required) The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.eventgrid_topic_id
- (Required) The ID of Event Grid Topic in which event will be listened. Changing this forces a new resource.events
- (Required) List of events that will fire this trigger. At least one event must be specified.pipeline
- (Required) One or morepipeline
blocks as defined below.activated
- (Optional) Specifies if the Data Factory Custom Event Trigger is activated. Defaults totrue
.additional_properties
- (Optional) A map of additional properties to associate with the Data Factory Custom Event Trigger.annotations
- (Optional) List of tags that can be used for describing the Data Factory Custom Event Trigger.description
- (Optional) The description for the Data Factory Custom Event Trigger.subject_begins_with
- (Optional) The pattern that event subject starts with for trigger to fire.subject_ends_with
- (Optional) The pattern that event subject ends with for trigger to fire.
Note: At least one of
subject_begins_with
andsubject_ends_with
must be set.
A pipeline
block supports the following:
name
- (Required) The Data Factory Pipeline name that the trigger will act on.parameters
- (Optional) The Data Factory Pipeline parameters that the trigger will act on.
The following attributes are exported:
id
- The ID of the Data Factory Custom Event Trigger.
Explanation in Terraform Registry
Manages a Custom Event Trigger inside an Azure Data Factory.
Tips: Best Practices for The Other Azure Data Factory Resources
In addition to the azurerm_data_factory, Azure Data Factory has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.
azurerm_data_factory
Ensure to disable public access
It is better to disable public access for Data Factory, which is enabled as default.
Microsoft.DataFactory/factories/triggers (Azure Resource Manager)
The factories/triggers in Microsoft.DataFactory can be configured in Azure Resource Manager with the resource name Microsoft.DataFactory/factories/triggers
. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
apiVersion
required - stringname
required - stringThe trigger name.
properties
requiredadditionalProperties
optional - objectUnmatched properties from the message are deserialized this collection
annotations
optional - arrayList of tags that can be used for describing the trigger.
description
optional - stringTrigger description.
type
required - string