Azure Data Factory Linked Service Azure Search
This page shows how to write Terraform and Azure Resource Manager for Data Factory Linked Service Azure Search and write them securely.
azurerm_data_factory_linked_service_azure_search (Terraform)
The Linked Service Azure Search in Data Factory can be configured in Terraform with the resource name azurerm_data_factory_linked_service_azure_search
. 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
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 Azure Search Linked Service:
url
- (Required) The URL of the Search Service endpoint (e.g. https://[searchServiceName].search.windows.net).search_service_key
- (Required) The key of the Azure Search Service.
The following attributes are exported:
id
- The ID of the Data Factory Linked Service.encrypted_credential
- The encrypted credential to connect to Azure Search Service.
Explanation in Terraform Registry
Manages a Linked Service (connection) between Azure Search Service and Azure Data Factory.
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.
azurerm_data_factory
Ensure to disable public access
It is better to disable public access for Data Factory, which is enabled as default.
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 - stringname
required - stringThe linked service name.
properties
requiredadditionalProperties
optional - objectUnmatched properties from the message are deserialized this collection
annotations
optional - arrayList of tags that can be used for describing the linked service.
connectVia
optionalparameters
optional - objectAn object mapping parameter names to argument values.
referenceName
required - stringReference integration runtime name.
type
required - stringType of integration runtime.
description
optional - stringLinked service description.
parameters
optional - undefinedDefinition of all parameters for an entity.
type
required - string