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

Azure Data Factory Linked Service Cosmosdb

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

The Linked Service Cosmosdb in Data Factory can be configured in Terraform with the resource name azurerm_data_factory_linked_service_cosmosdb. The following sections describe 7 examples of how to use the resource and its parameters.

Example Usage from GitHub

main.tf#L1
resource "azurerm_data_factory_linked_service_cosmosdb" "cosmosdb_linkedsvc" {
  name                = var.service_settings.name
  resource_group_name = var.context.resource_group_name
  data_factory_name   = var.service_settings.data_factory_name
  connection_string   = var.service_settings.connection_string
}
main.tf#L1
resource "azurerm_data_factory_linked_service_cosmosdb" "cosmosdb_linkedsvc" {
  name                = var.service_settings.name
  resource_group_name = var.context.resource_group_name
  data_factory_name   = var.service_settings.data_factory_name
  connection_string   = var.service_settings.connection_string
}
module.tf#L1
resource "azurerm_data_factory_linked_service_cosmosdb" "linked_service_cosmosdb" {
  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)
module.tf#L1
resource "azurerm_data_factory_linked_service_cosmosdb" "linked_service_cosmosdb" {
  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)
module.tf#L10
resource "azurerm_data_factory_linked_service_cosmosdb" "linked_service_cosmosdb" {
  name                     = azurecaf_name.linked_service_cosmosdb.result
  resource_group_name      = var.resource_group_name
  data_factory_name        = var.data_factory_name
  description              = try(var.settings.description, null)
  integration_runtime_name = try(var.settings.integration_runtime_name, null)
module.tf#L1
resource "azurerm_data_factory_linked_service_cosmosdb" "linked_service_cosmosdb" {
  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)
machine_learning.tf#L94
resource "azurerm_data_factory_linked_service_cosmosdb" "airq-df-cdb" {
  name                = "airq-df-cdb"
  resource_group_name = azurerm_resource_group.airq-rg.name
  data_factory_name   = azurerm_data_factory.airq-df.name
  account_endpoint    = azurerm_cosmosdb_account.airq-cosmos.endpoint
  account_key         = azurerm_cosmosdb_account.airq-cosmos.primary_key

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

>> from Terraform Registry

Explanation in Terraform Registry

Manages a Linked Service (connection) between a CosmosDB and Azure Data Factory using SQL API.

Note: All arguments including the client secret will be stored in the raw state as plain-text. Read more about sensitive data in state.

>> 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 Service Cosmosdb?

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

For Terraform, the aadi555/azurerm, persistentsystems/terraform-azurerm and anmoltoppo/Terraform source code examples are useful. See the Terraform Example section for further details.

security-icon

Automate config file reviews on your commits

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

Table of Contents