azurermDataFactoryLinkedServiceAzureSearch
Manages a Linked Service (connection) between Azure Search Service and Azure Data Factory.
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 azurermSearchServiceExample = new azurerm.searchService.SearchService(
this,
"example_1",
{
location: azurermResourceGroupExample.location,
name: "example-search-service",
resource_group_name: azurermResourceGroupExample.name,
sku: "standard",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermSearchServiceExample.overrideLogicalId("example");
const azurermDataFactoryExample = new azurerm.dataFactory.DataFactory(
this,
"example_2",
{
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");
new azurerm.dataFactoryLinkedServiceAzureSearch.DataFactoryLinkedServiceAzureSearch(
this,
"test",
{
data_factory_id: azurermDataFactoryExample.id,
name: "example",
search_service_key: azurermSearchServiceExample.primaryKey,
url: `\${join("", ["https://", ${azurermSearchServiceExample.name}, ".search.windows.net"])}`,
}
);
Argument Reference
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. -
dataFactoryId- (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. -
integrationRuntimeName- (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. -
additionalProperties- (Optional) A map of additional properties to associate with the Data Factory Linked Service.
The following supported arguments are specific to Azure Search Linked Service:
-
url- (Required) The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net). -
searchServiceKey- (Required) The key of the Azure Search Service.
Attributes Reference
The following attributes are exported:
-
id- The ID of the Data Factory Linked Service. -
encryptedCredential- The encrypted credential to connect to Azure Search 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.