Top / Microsoft Azure / Azure Data Factory / Linked Custom Service

Azure Data Factory Linked Custom Service

This page shows how to write Terraform and Azure Resource Manager for Data Factory Linked Custom Service 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_linked_custom_service (Terraform)

The Linked Custom Service in Data Factory can be configured in Terraform with the resource name azurerm_data_factory_linked_custom_service. 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

  • name - (Required) Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

  • data_factory_id - (Required) The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

  • type - (Required) The type of data stores that will be connected to Data Factory. For full list of supported data stores, please refer to Azure Data Factory connector.

  • type_properties_json - (Required) A JSON object that contains the properties of the Data Factory Linked Service.

  • additional_properties - (Optional) A map of additional properties to associate with the Data Factory Linked Service.

  • annotations - (Optional) List of tags that can be used for describing the Data Factory Linked Service.

  • description - (Optional) The description for the Data Factory Linked Service.

  • integration_runtime - (Optional) An integration_runtime block as defined below.

  • parameters - (Optional) A map of parameters to associate with the Data Factory Linked Service.

An integration_runtime supports the following:

  • name - (Required) The integration runtime reference to associate with the Data Factory Linked Service.

  • parameters - (Optional) A map of parameters to associate with the integration runtime.

The following attributes are exported:

  • id - The ID of the Data Factory Linked Service.

>> from Terraform Registry

Explanation in Terraform Registry

Manages a Linked Service (connection) between a resource and Azure Data Factory. This is a generic resource that supports all different Linked Service Types.

>> 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/linkedservices (Azure Resource Manager)

The factories/linkedservices in Microsoft.DataFactory can be configured in Azure Resource Manager with the resource name Microsoft.DataFactory/factories/linkedservices. 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 linked service 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 linked service.

      • connectVia optional
          • parameters optional - object

            An object mapping parameter names to argument values.

          • referenceName required - string

            Reference integration runtime name.

          • type required - string

            Type of integration runtime.

      • description optional - string

        Linked service description.

      • parameters optional - undefined

        Definition of all parameters for an entity.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure Data Factory Resources

Frequently asked questions

What is Azure Data Factory Linked Custom Service?

Azure Data Factory Linked Custom Service 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