Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. datafactory
  5. LinkedServiceAzureSearch

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.datafactory.LinkedServiceAzureSearch

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as std from "@pulumi/std";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleFactory = new azure.datafactory.Factory("example", {
    name: "example",
    location: example.location,
    resourceGroupName: example.name,
});
const exampleService = new azure.search.Service("example", {
    name: "example-search-service",
    resourceGroupName: example.name,
    location: example.location,
    sku: "standard",
});
const test = new azure.datafactory.LinkedServiceAzureSearch("test", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    url: std.joinOutput({
        separator: "",
        input: [
            "https://",
            exampleService.name,
            ".search.windows.net",
        ],
    }).apply(invoke => invoke.result),
    searchServiceKey: exampleService.primaryKey,
});
Copy
import pulumi
import pulumi_azure as azure
import pulumi_std as std

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_factory = azure.datafactory.Factory("example",
    name="example",
    location=example.location,
    resource_group_name=example.name)
example_service = azure.search.Service("example",
    name="example-search-service",
    resource_group_name=example.name,
    location=example.location,
    sku="standard")
test = azure.datafactory.LinkedServiceAzureSearch("test",
    name="example",
    data_factory_id=example_factory.id,
    url=std.join_output(separator="",
        input=[
            "https://",
            example_service.name,
            ".search.windows.net",
        ]).apply(lambda invoke: invoke.result),
    search_service_key=example_service.primary_key)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/datafactory"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/search"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
			Name:              pulumi.String("example"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		exampleService, err := search.NewService(ctx, "example", &search.ServiceArgs{
			Name:              pulumi.String("example-search-service"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			Sku:               pulumi.String("standard"),
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewLinkedServiceAzureSearch(ctx, "test", &datafactory.LinkedServiceAzureSearchArgs{
			Name:          pulumi.String("example"),
			DataFactoryId: exampleFactory.ID(),
			Url: pulumi.String(std.JoinOutput(ctx, std.JoinOutputArgs{
				Separator: pulumi.String(""),
				Input: pulumi.StringArray{
					pulumi.String("https://"),
					exampleService.Name,
					pulumi.String(".search.windows.net"),
				},
			}, nil).ApplyT(func(invoke std.JoinResult) (*string, error) {
				return invoke.Result, nil
			}).(pulumi.StringPtrOutput)),
			SearchServiceKey: exampleService.PrimaryKey,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleFactory = new Azure.DataFactory.Factory("example", new()
    {
        Name = "example",
        Location = example.Location,
        ResourceGroupName = example.Name,
    });

    var exampleService = new Azure.Search.Service("example", new()
    {
        Name = "example-search-service",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Sku = "standard",
    });

    var test = new Azure.DataFactory.LinkedServiceAzureSearch("test", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        Url = Std.Join.Invoke(new()
        {
            Separator = "",
            Input = new[]
            {
                "https://",
                exampleService.Name,
                ".search.windows.net",
            },
        }).Apply(invoke => invoke.Result),
        SearchServiceKey = exampleService.PrimaryKey,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.datafactory.Factory;
import com.pulumi.azure.datafactory.FactoryArgs;
import com.pulumi.azure.search.Service;
import com.pulumi.azure.search.ServiceArgs;
import com.pulumi.azure.datafactory.LinkedServiceAzureSearch;
import com.pulumi.azure.datafactory.LinkedServiceAzureSearchArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
            .name("example")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-search-service")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku("standard")
            .build());

        var test = new LinkedServiceAzureSearch("test", LinkedServiceAzureSearchArgs.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .url(StdFunctions.join().applyValue(invoke -> invoke.result()))
            .searchServiceKey(exampleService.primaryKey())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    name: example
    properties:
      name: example
      location: ${example.location}
      resourceGroupName: ${example.name}
  exampleService:
    type: azure:search:Service
    name: example
    properties:
      name: example-search-service
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku: standard
  test:
    type: azure:datafactory:LinkedServiceAzureSearch
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      url:
        fn::invoke:
          function: std:join
          arguments:
            separator: ""
            input:
              - https://
              - ${exampleService.name}
              - .search.windows.net
          return: result
      searchServiceKey: ${exampleService.primaryKey}
Copy

Create LinkedServiceAzureSearch Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new LinkedServiceAzureSearch(name: string, args: LinkedServiceAzureSearchArgs, opts?: CustomResourceOptions);
@overload
def LinkedServiceAzureSearch(resource_name: str,
                             args: LinkedServiceAzureSearchArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def LinkedServiceAzureSearch(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             data_factory_id: Optional[str] = None,
                             search_service_key: Optional[str] = None,
                             url: Optional[str] = None,
                             additional_properties: Optional[Mapping[str, str]] = None,
                             annotations: Optional[Sequence[str]] = None,
                             description: Optional[str] = None,
                             integration_runtime_name: Optional[str] = None,
                             name: Optional[str] = None,
                             parameters: Optional[Mapping[str, str]] = None)
func NewLinkedServiceAzureSearch(ctx *Context, name string, args LinkedServiceAzureSearchArgs, opts ...ResourceOption) (*LinkedServiceAzureSearch, error)
public LinkedServiceAzureSearch(string name, LinkedServiceAzureSearchArgs args, CustomResourceOptions? opts = null)
public LinkedServiceAzureSearch(String name, LinkedServiceAzureSearchArgs args)
public LinkedServiceAzureSearch(String name, LinkedServiceAzureSearchArgs args, CustomResourceOptions options)

type: azure:datafactory:LinkedServiceAzureSearch
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LinkedServiceAzureSearchArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LinkedServiceAzureSearchArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LinkedServiceAzureSearchArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LinkedServiceAzureSearchArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LinkedServiceAzureSearchArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var linkedServiceAzureSearchResource = new Azure.DataFactory.LinkedServiceAzureSearch("linkedServiceAzureSearchResource", new()
{
    DataFactoryId = "string",
    SearchServiceKey = "string",
    Url = "string",
    AdditionalProperties = 
    {
        { "string", "string" },
    },
    Annotations = new[]
    {
        "string",
    },
    Description = "string",
    IntegrationRuntimeName = "string",
    Name = "string",
    Parameters = 
    {
        { "string", "string" },
    },
});
Copy
example, err := datafactory.NewLinkedServiceAzureSearch(ctx, "linkedServiceAzureSearchResource", &datafactory.LinkedServiceAzureSearchArgs{
	DataFactoryId:    pulumi.String("string"),
	SearchServiceKey: pulumi.String("string"),
	Url:              pulumi.String("string"),
	AdditionalProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Annotations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:            pulumi.String("string"),
	IntegrationRuntimeName: pulumi.String("string"),
	Name:                   pulumi.String("string"),
	Parameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var linkedServiceAzureSearchResource = new LinkedServiceAzureSearch("linkedServiceAzureSearchResource", LinkedServiceAzureSearchArgs.builder()
    .dataFactoryId("string")
    .searchServiceKey("string")
    .url("string")
    .additionalProperties(Map.of("string", "string"))
    .annotations("string")
    .description("string")
    .integrationRuntimeName("string")
    .name("string")
    .parameters(Map.of("string", "string"))
    .build());
Copy
linked_service_azure_search_resource = azure.datafactory.LinkedServiceAzureSearch("linkedServiceAzureSearchResource",
    data_factory_id="string",
    search_service_key="string",
    url="string",
    additional_properties={
        "string": "string",
    },
    annotations=["string"],
    description="string",
    integration_runtime_name="string",
    name="string",
    parameters={
        "string": "string",
    })
Copy
const linkedServiceAzureSearchResource = new azure.datafactory.LinkedServiceAzureSearch("linkedServiceAzureSearchResource", {
    dataFactoryId: "string",
    searchServiceKey: "string",
    url: "string",
    additionalProperties: {
        string: "string",
    },
    annotations: ["string"],
    description: "string",
    integrationRuntimeName: "string",
    name: "string",
    parameters: {
        string: "string",
    },
});
Copy
type: azure:datafactory:LinkedServiceAzureSearch
properties:
    additionalProperties:
        string: string
    annotations:
        - string
    dataFactoryId: string
    description: string
    integrationRuntimeName: string
    name: string
    parameters:
        string: string
    searchServiceKey: string
    url: string
Copy

LinkedServiceAzureSearch Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The LinkedServiceAzureSearch resource accepts the following input properties:

DataFactoryId
This property is required.
Changes to this property will trigger replacement.
string
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
SearchServiceKey This property is required. string
The key of the Azure Search Service.
Url This property is required. string
The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).
AdditionalProperties Dictionary<string, string>

A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure Search Linked Service:

Annotations List<string>
List of tags that can be used for describing the Data Factory Linked Service.
Description string
The description for the Data Factory Linked Service.
IntegrationRuntimeName string
The integration runtime reference to associate with the Data Factory Linked Service.
Name Changes to this property will trigger replacement. string
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.
Parameters Dictionary<string, string>
A map of parameters to associate with the Data Factory Linked Service.
DataFactoryId
This property is required.
Changes to this property will trigger replacement.
string
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
SearchServiceKey This property is required. string
The key of the Azure Search Service.
Url This property is required. string
The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).
AdditionalProperties map[string]string

A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure Search Linked Service:

Annotations []string
List of tags that can be used for describing the Data Factory Linked Service.
Description string
The description for the Data Factory Linked Service.
IntegrationRuntimeName string
The integration runtime reference to associate with the Data Factory Linked Service.
Name Changes to this property will trigger replacement. string
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.
Parameters map[string]string
A map of parameters to associate with the Data Factory Linked Service.
dataFactoryId
This property is required.
Changes to this property will trigger replacement.
String
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
searchServiceKey This property is required. String
The key of the Azure Search Service.
url This property is required. String
The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).
additionalProperties Map<String,String>

A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure Search Linked Service:

annotations List<String>
List of tags that can be used for describing the Data Factory Linked Service.
description String
The description for the Data Factory Linked Service.
integrationRuntimeName String
The integration runtime reference to associate with the Data Factory Linked Service.
name Changes to this property will trigger replacement. String
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.
parameters Map<String,String>
A map of parameters to associate with the Data Factory Linked Service.
dataFactoryId
This property is required.
Changes to this property will trigger replacement.
string
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
searchServiceKey This property is required. string
The key of the Azure Search Service.
url This property is required. string
The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).
additionalProperties {[key: string]: string}

A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure Search Linked Service:

annotations string[]
List of tags that can be used for describing the Data Factory Linked Service.
description string
The description for the Data Factory Linked Service.
integrationRuntimeName string
The integration runtime reference to associate with the Data Factory Linked Service.
name Changes to this property will trigger replacement. string
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.
parameters {[key: string]: string}
A map of parameters to associate with the Data Factory Linked Service.
data_factory_id
This property is required.
Changes to this property will trigger replacement.
str
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
search_service_key This property is required. str
The key of the Azure Search Service.
url This property is required. str
The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).
additional_properties Mapping[str, str]

A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure Search Linked Service:

annotations Sequence[str]
List of tags that can be used for describing the Data Factory Linked Service.
description str
The description for the Data Factory Linked Service.
integration_runtime_name str
The integration runtime reference to associate with the Data Factory Linked Service.
name Changes to this property will trigger replacement. str
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.
parameters Mapping[str, str]
A map of parameters to associate with the Data Factory Linked Service.
dataFactoryId
This property is required.
Changes to this property will trigger replacement.
String
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
searchServiceKey This property is required. String
The key of the Azure Search Service.
url This property is required. String
The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).
additionalProperties Map<String>

A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure Search Linked Service:

annotations List<String>
List of tags that can be used for describing the Data Factory Linked Service.
description String
The description for the Data Factory Linked Service.
integrationRuntimeName String
The integration runtime reference to associate with the Data Factory Linked Service.
name Changes to this property will trigger replacement. String
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.
parameters Map<String>
A map of parameters to associate with the Data Factory Linked Service.

Outputs

All input properties are implicitly available as output properties. Additionally, the LinkedServiceAzureSearch resource produces the following output properties:

EncryptedCredential string
The encrypted credential to connect to Azure Search Service.
Id string
The provider-assigned unique ID for this managed resource.
EncryptedCredential string
The encrypted credential to connect to Azure Search Service.
Id string
The provider-assigned unique ID for this managed resource.
encryptedCredential String
The encrypted credential to connect to Azure Search Service.
id String
The provider-assigned unique ID for this managed resource.
encryptedCredential string
The encrypted credential to connect to Azure Search Service.
id string
The provider-assigned unique ID for this managed resource.
encrypted_credential str
The encrypted credential to connect to Azure Search Service.
id str
The provider-assigned unique ID for this managed resource.
encryptedCredential String
The encrypted credential to connect to Azure Search Service.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing LinkedServiceAzureSearch Resource

Get an existing LinkedServiceAzureSearch resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LinkedServiceAzureSearchState, opts?: CustomResourceOptions): LinkedServiceAzureSearch
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_properties: Optional[Mapping[str, str]] = None,
        annotations: Optional[Sequence[str]] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        encrypted_credential: Optional[str] = None,
        integration_runtime_name: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        search_service_key: Optional[str] = None,
        url: Optional[str] = None) -> LinkedServiceAzureSearch
func GetLinkedServiceAzureSearch(ctx *Context, name string, id IDInput, state *LinkedServiceAzureSearchState, opts ...ResourceOption) (*LinkedServiceAzureSearch, error)
public static LinkedServiceAzureSearch Get(string name, Input<string> id, LinkedServiceAzureSearchState? state, CustomResourceOptions? opts = null)
public static LinkedServiceAzureSearch get(String name, Output<String> id, LinkedServiceAzureSearchState state, CustomResourceOptions options)
resources:  _:    type: azure:datafactory:LinkedServiceAzureSearch    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AdditionalProperties Dictionary<string, string>

A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure Search Linked Service:

Annotations List<string>
List of tags that can be used for describing the Data Factory Linked Service.
DataFactoryId Changes to this property will trigger replacement. string
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
Description string
The description for the Data Factory Linked Service.
EncryptedCredential string
The encrypted credential to connect to Azure Search Service.
IntegrationRuntimeName string
The integration runtime reference to associate with the Data Factory Linked Service.
Name Changes to this property will trigger replacement. string
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.
Parameters Dictionary<string, string>
A map of parameters to associate with the Data Factory Linked Service.
SearchServiceKey string
The key of the Azure Search Service.
Url string
The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).
AdditionalProperties map[string]string

A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure Search Linked Service:

Annotations []string
List of tags that can be used for describing the Data Factory Linked Service.
DataFactoryId Changes to this property will trigger replacement. string
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
Description string
The description for the Data Factory Linked Service.
EncryptedCredential string
The encrypted credential to connect to Azure Search Service.
IntegrationRuntimeName string
The integration runtime reference to associate with the Data Factory Linked Service.
Name Changes to this property will trigger replacement. string
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.
Parameters map[string]string
A map of parameters to associate with the Data Factory Linked Service.
SearchServiceKey string
The key of the Azure Search Service.
Url string
The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).
additionalProperties Map<String,String>

A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure Search Linked Service:

annotations List<String>
List of tags that can be used for describing the Data Factory Linked Service.
dataFactoryId Changes to this property will trigger replacement. String
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
description String
The description for the Data Factory Linked Service.
encryptedCredential String
The encrypted credential to connect to Azure Search Service.
integrationRuntimeName String
The integration runtime reference to associate with the Data Factory Linked Service.
name Changes to this property will trigger replacement. String
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.
parameters Map<String,String>
A map of parameters to associate with the Data Factory Linked Service.
searchServiceKey String
The key of the Azure Search Service.
url String
The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).
additionalProperties {[key: string]: string}

A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure Search Linked Service:

annotations string[]
List of tags that can be used for describing the Data Factory Linked Service.
dataFactoryId Changes to this property will trigger replacement. string
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
description string
The description for the Data Factory Linked Service.
encryptedCredential string
The encrypted credential to connect to Azure Search Service.
integrationRuntimeName string
The integration runtime reference to associate with the Data Factory Linked Service.
name Changes to this property will trigger replacement. string
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.
parameters {[key: string]: string}
A map of parameters to associate with the Data Factory Linked Service.
searchServiceKey string
The key of the Azure Search Service.
url string
The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).
additional_properties Mapping[str, str]

A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure Search Linked Service:

annotations Sequence[str]
List of tags that can be used for describing the Data Factory Linked Service.
data_factory_id Changes to this property will trigger replacement. str
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
description str
The description for the Data Factory Linked Service.
encrypted_credential str
The encrypted credential to connect to Azure Search Service.
integration_runtime_name str
The integration runtime reference to associate with the Data Factory Linked Service.
name Changes to this property will trigger replacement. str
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.
parameters Mapping[str, str]
A map of parameters to associate with the Data Factory Linked Service.
search_service_key str
The key of the Azure Search Service.
url str
The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).
additionalProperties Map<String>

A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure Search Linked Service:

annotations List<String>
List of tags that can be used for describing the Data Factory Linked Service.
dataFactoryId Changes to this property will trigger replacement. String
The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
description String
The description for the Data Factory Linked Service.
encryptedCredential String
The encrypted credential to connect to Azure Search Service.
integrationRuntimeName String
The integration runtime reference to associate with the Data Factory Linked Service.
name Changes to this property will trigger replacement. String
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.
parameters Map<String>
A map of parameters to associate with the Data Factory Linked Service.
searchServiceKey String
The key of the Azure Search Service.
url String
The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

Import

Data Factory Linked Service’s can be imported using the resource id, e.g.

$ pulumi import azure:datafactory/linkedServiceAzureSearch:LinkedServiceAzureSearch example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure