azurermDataFactoryLinkedCustomService
Manages a Linked Service (connection) between a resource and Azure Data Factory. This is a generic resource that supports all different Linked Service Types.
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 azurermStorageAccountExample = new azurerm.storageAccount.StorageAccount(
this,
"example_1",
{
account_kind: "BlobStorage",
account_replication_type: "LRS",
account_tier: "Standard",
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.*/
azurermStorageAccountExample.overrideLogicalId("example");
const azurermDataFactoryExample = new azurerm.dataFactory.DataFactory(
this,
"example_2",
{
identity: [
{
type: "SystemAssigned",
},
],
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 azurermDataFactoryLinkedCustomServiceExample =
new azurerm.dataFactoryLinkedCustomService.DataFactoryLinkedCustomService(
this,
"example_3",
{
annotations: ["test1", "test2", "test3"],
data_factory_id: azurermDataFactoryExample.id,
description: "test description",
name: "example",
parameters: [
{
Env: "Test",
foo: "bar",
},
],
type: "AzureBlobStorage",
type_properties_json: `{
"connectionString":"\${${azurermStorageAccountExample.primaryConnectionString}}"
}
`,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermDataFactoryLinkedCustomServiceExample.overrideLogicalId("example");
Argument Reference
-
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. -
dataFactoryId- (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. Changing this forces a new resource to be created. -
typePropertiesJson- (Required) A JSON object that contains the properties of the Data Factory Linked Service. -
additionalProperties- (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. -
integrationRuntime- (Optional) AnintegrationRuntimeblock as defined below. -
parameters- (Optional) A map of parameters to associate with the Data Factory Linked Service.
An integrationRuntime block 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.
Attributes Reference
The following attributes are exported:
id- The ID of the Data Factory 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 Linked Service.update- (Defaults to 30 minutes) Used when updating the Data Factory Linked Service.read- (Defaults to 5 minutes) Used when retrieving the Data Factory Linked Service.delete- (Defaults to 30 minutes) Used when deleting the Data Factory Linked Service.
Import
Data Factory Linked Service's can be imported using the resourceId, e.g.