Top / Microsoft Azure / Azure Data Factory / Trigger Custom Event

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.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

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.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

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 more pipeline blocks as defined below.

  • activated - (Optional) Specifies if the Data Factory Custom Event Trigger is activated. Defaults to true.

  • 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 and subject_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.

>> from Terraform Registry

Explanation in Terraform Registry

Manages a Custom Event Trigger inside an Azure Data Factory.

>> from Terraform Registry

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.

risk-label

azurerm_data_factory

Ensure to disable public access

It is better to disable public access for Data Factory, which is enabled as default.

Review your Azure Data Factory settings

In addition to the above, there are other security points you should be aware of making sure that your .tf files are protected in Shisho Cloud.

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 - string
  • name required - string

    The trigger name.

  • properties required
      • additionalProperties optional - object

        Unmatched properties from the message are deserialized this collection

      • annotations optional - array

        List of tags that can be used for describing the trigger.

      • description optional - string

        Trigger description.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure Data Factory Resources

Frequently asked questions

What is Azure Data Factory Trigger Custom Event?

Azure Data Factory Trigger Custom Event is a resource for Data Factory of Microsoft Azure. Settings can be wrote in Terraform.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents