LinkedServiceAzureSearchArgs

data class LinkedServiceAzureSearchArgs(val additionalProperties: Output<Map<String, String>>? = null, val annotations: Output<List<String>>? = null, val dataFactoryId: Output<String>? = null, val description: Output<String>? = null, val integrationRuntimeName: Output<String>? = null, val name: Output<String>? = null, val parameters: Output<Map<String, String>>? = null, val searchServiceKey: Output<String>? = null, val url: Output<String>? = null) : ConvertibleToJava<LinkedServiceAzureSearchArgs>

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,
});
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)
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,
});
});
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
})
}
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 com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.JoinArgs;
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(JoinArgs.builder()
.separator("")
.input(
"https://",
exampleService.name(),
".search.windows.net")
.build()).applyValue(_invoke -> _invoke.result()))
.searchServiceKey(exampleService.primaryKey())
.build());
}
}
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}

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

Constructors

Link copied to clipboard
constructor(additionalProperties: Output<Map<String, String>>? = null, annotations: Output<List<String>>? = null, dataFactoryId: Output<String>? = null, description: Output<String>? = null, integrationRuntimeName: Output<String>? = null, name: Output<String>? = null, parameters: Output<Map<String, String>>? = null, searchServiceKey: Output<String>? = null, url: Output<String>? = null)

Properties

Link copied to clipboard
val additionalProperties: Output<Map<String, String>>? = null

A map of additional properties to associate with the Data Factory Linked Service. The following supported arguments are specific to Azure Search Linked Service:

Link copied to clipboard
val annotations: Output<List<String>>? = null

List of tags that can be used for describing the Data Factory Linked Service.

Link copied to clipboard
val dataFactoryId: Output<String>? = null

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

Link copied to clipboard
val description: Output<String>? = null

The description for the Data Factory Linked Service.

Link copied to clipboard
val integrationRuntimeName: Output<String>? = null

The integration runtime reference to associate with the Data Factory Linked Service.

Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard
val parameters: Output<Map<String, String>>? = null

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

Link copied to clipboard
val searchServiceKey: Output<String>? = null

The key of the Azure Search Service.

Link copied to clipboard
val url: Output<String>? = null

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

Functions

Link copied to clipboard
open override fun toJava(): LinkedServiceAzureSearchArgs