Skip to content

azurermDataFactoryLinkedServiceMysql

Manages a Linked Service (connection) between MySQL and Azure Data Factory.

\~> Note: All arguments including the connection_string will be stored in the raw state as plain-text. Read more about sensitive data in state.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
  this,
  "example",
  {
    location: "West Europe",
    name: "example-resources",
  }
);
const azurermDataFactoryExample = new azurerm.dataFactory.DataFactory(
  this,
  "example_1",
  {
    location: azurermResourceGroupExample.location,
    name: "example",
    resource_group_name: azurermResourceGroupExample.name,
  }
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermDataFactoryExample.overrideLogicalId("example");
const azurermDataFactoryLinkedServiceMysqlExample =
  new azurerm.dataFactoryLinkedServiceMysql.DataFactoryLinkedServiceMysql(
    this,
    "example_2",
    {
      connection_string:
        "Server=test;Port=3306;Database=test;User=test;SSLMode=1;UseSystemTrustStore=0;Password=test",
      data_factory_id: azurermDataFactoryExample.id,
      name: "example",
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermDataFactoryLinkedServiceMysqlExample.overrideLogicalId("example");

Argument Reference

The following arguments are supported:

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

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

  • connectionString - (Required) The connection string in which to authenticate with MySQL.

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

  • integrationRuntimeName - (Optional) The integration runtime reference to associate with the Data Factory Linked Service MySQL.

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

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

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

Attributes Reference

The following attributes are exported:

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

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 30 minutes) Used when creating the Data Factory MySQL Linked Service.
  • update - (Defaults to 30 minutes) Used when updating the Data Factory MySQL Linked Service.
  • read - (Defaults to 5 minutes) Used when retrieving the Data Factory MySQL Linked Service.
  • delete - (Defaults to 30 minutes) Used when deleting the Data Factory MySQL Linked Service.

Import

Data Factory MySQL Linked Service's can be imported using the resourceId, e.g.

terraform import azurerm_data_factory_linked_service_mysql.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example