Manages a Linked Service (connection) between a CosmosDB and Azure Data Factory using SQL API.
resource "azurerm_resource_group" "example" {
name = "example-resources"
location = "West Europe"
}
data "azurerm_cosmosdb_account" "example" {
name = "tfex-cosmosdb-account"
resource_group_name = "tfex-cosmosdb-account-rg"
}
resource "azurerm_data_factory" "example" {
name = "example"
location = azurerm_resource_group.example.location
resource_group_name = azurerm_resource_group.example.name
}
resource "azurerm_data_factory_linked_service_cosmosdb" "example" {
name = "example"
data_factory_id = azurerm_data_factory.example.id
account_endpoint = data.azurerm_cosmosdb_account.example.endpoint
account_key = data.azurerm_cosmosdb_account.example.primary_key
database = "foo"
}
The following supported arguments are common across all Azure Data Factory Linked Services:
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.
description
- (Optional) The description for the Data Factory Linked Service.
integration_runtime_name
- (Optional) The integration runtime reference to associate with the Data Factory Linked Service.
annotations
- (Optional) List of tags that can be used for describing the Data Factory Linked Service.
parameters
- (Optional) A map of parameters to associate with the Data Factory Linked Service.
additional_properties
- (Optional) A map of additional properties to associate with the Data Factory Linked Service.
The following supported arguments are specific to CosmosDB Linked Service:
account_endpoint
- (Optional) The endpoint of the Azure CosmosDB account. Required if connection_string
is unspecified.
account_key
- (Optional) The account key of the Azure Cosmos DB account. Required if connection_string
is unspecified.
database
- (Optional) The name of the database. Required if connection_string
is unspecified.
connection_string
- (Optional) The connection string. Required if account_endpoint
, account_key
, and database
are unspecified.
In addition to the Arguments listed above - the following Attributes are exported:
id
- The ID of the Data Factory Linked Service.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.Data Factory Linked Service's can be imported using the resource id
, e.g.
terraform import azurerm_data_factory_linked_service_cosmosdb.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example