Azure Data Factory Linked Service Data Lake Storage Gen2
This page shows how to write Terraform and Azure Resource Manager for Data Factory Linked Service Data Lake Storage Gen2 and write them securely.
azurerm_data_factory_linked_service_data_lake_storage_gen2 (Terraform)
The Linked Service Data Lake Storage Gen2 in Data Factory can be configured in Terraform with the resource name azurerm_data_factory_linked_service_data_lake_storage_gen2
. The following sections describe 10 examples of how to use the resource and its parameters.
Example Usage from GitHub
resource "azurerm_data_factory_linked_service_data_lake_storage_gen2" "adf_adlsg2_linkedservice" {
name = "adlsgen2_linked_service"
resource_group_name = azurerm_resource_group.synapse-experiments-rg.name
data_factory_name = azurerm_data_factory.azure-data-factory.name
service_principal_id = data.azurerm_client_config.current.client_id
service_principal_key = "exampleKey"
resource "azurerm_data_factory_linked_service_data_lake_storage_gen2" "linked_service_data_lake_storage_gen2" {
name = var.name
resource_group_name = var.resource_group_name
data_factory_name = var.data_factory_name
description = try(var.description, null)
integration_runtime_name = try(var.integration_runtime_name, null)
resource "azurerm_data_factory_linked_service_data_lake_storage_gen2" "gen2" {
name = "storage"
resource_group_name = azurerm_resource_group.final_task.name
data_factory_name = azurerm_data_factory.pipeline.name
url = "https://finalterraform.dfs.core.windows.net/"
storage_account_key = ""
resource "azurerm_data_factory_linked_service_data_lake_storage_gen2" "linked_service_data_lake_storage_gen2" {
name = var.name
resource_group_name = var.resource_group_name
data_factory_name = var.data_factory_name
description = try(var.description, null)
integration_runtime_name = try(var.integration_runtime_name, null)
resource "azurerm_data_factory_linked_service_data_lake_storage_gen2" "this" {
additional_properties = var.additional_properties
annotations = var.annotations
data_factory_name = var.data_factory_name
description = var.description
integration_runtime_name = var.integration_runtime_name
resource "azurerm_data_factory_linked_service_data_lake_storage_gen2" "this" {
additional_properties = var.additional_properties
annotations = var.annotations
data_factory_name = var.data_factory_name
description = var.description
integration_runtime_name = var.integration_runtime_name
resource "azurerm_data_factory_linked_service_data_lake_storage_gen2" "linked_service_data_lake_storage_gen2" {
name = azurecaf_name.dataset.name
resource_group_name = var.resource_group_name
data_factory_name = var.data_factory_name
description = try(var.description, null)
integration_runtime_name = try(var.integration_runtime_name, null)
resource "azurerm_data_factory_linked_service_data_lake_storage_gen2" "storage" {
name = "sharedstorage"
resource_group_name = azurerm_resource_group.deploy.name
data_factory_name = local.azurerm_data_factory_name
service_principal_id = data.azurerm_client_config.current.client_id
service_principal_key = "exampleKey"
resource "azurerm_data_factory_linked_service_data_lake_storage_gen2" "linked_service_data_lake_storage_gen2" {
name = var.name
resource_group_name = var.resource_group_name
data_factory_name = var.data_factory_name
description = try(var.description, null)
integration_runtime_name = try(var.integration_runtime_name, null)
resource "azurerm_data_factory_linked_service_data_lake_storage_gen2" "df-to-dl" {
name = "datalakestorageacct"
resource_group_name = azurerm_resource_group.rg.name
data_factory_name = azurerm_data_factory.df.name
service_principal_id = data.azurerm_client_config.current.client_id
service_principal_key = "exampleKey"
Parameters
-
additional_properties
optional - map from string to string -
annotations
optional - list of string -
data_factory_name
required - string -
description
optional - string -
id
optional computed - string -
integration_runtime_name
optional - string -
name
required - string -
parameters
optional - map from string to string -
resource_group_name
required - string -
service_principal_id
optional - string -
service_principal_key
optional - string -
tenant
optional - string -
url
required - string -
use_managed_identity
optional - bool -
timeouts
single block
Explanation in Terraform Registry
Manages a Linked Service (connection) between Data Lake Storage Gen2 and Azure Data Factory.
Note: All arguments including the
service_principal_key
will be stored in the raw state as plain-text. Read more about sensitive data in state.
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/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 - stringname
required - stringThe linked service 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 linked service.
connectVia
optionalparameters
optional - objectAn object mapping parameter names to argument values.
referenceName
required - stringReference integration runtime name.
type
required - stringType of integration runtime.
description
optional - stringLinked service description.
parameters
optional - undefinedDefinition of all parameters for an entity.
type
required - string
Frequently asked questions
What is Azure Data Factory Linked Service Data Lake Storage Gen2?
Azure Data Factory Linked Service Data Lake Storage Gen2 is a resource for Data Factory of Microsoft Azure. Settings can be wrote in Terraform.
Where can I find the example code for the Azure Data Factory Linked Service Data Lake Storage Gen2?
For Terraform, the ajith-ramanath/SynapseExperiments, anmoltoppo/Terraform and AbraMyrk/ITechArt_lab source code examples are useful. See the Terraform Example section for further details.