All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.datafactory.kotlin.LinkedServiceAzureSearch.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 6.15.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.datafactory.kotlin

import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map

/**
 * Builder for [LinkedServiceAzureSearch].
 */
@PulumiTagMarker
public class LinkedServiceAzureSearchResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: LinkedServiceAzureSearchArgs = LinkedServiceAzureSearchArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend LinkedServiceAzureSearchArgsBuilder.() -> Unit) {
        val builder = LinkedServiceAzureSearchArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): LinkedServiceAzureSearch {
        val builtJavaResource =
            com.pulumi.azure.datafactory.LinkedServiceAzureSearch(
                this.name,
                this.args.toJava(),
                this.opts.toJava(),
            )
        return LinkedServiceAzureSearch(builtJavaResource)
    }
}

/**
 * Manages a Linked Service (connection) between Azure Search Service and Azure Data Factory.
 * ## Example Usage
 * 
 * ```typescript
 * 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,
 * });
 * ```
 * ```python
 * 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)
 * ```
 * ```csharp
 * 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,
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/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
 * 	})
 * }
 * ```
 * ```java
 * 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());
 *     }
 * }
 * ```
 * ```yaml
 * 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.
 * ```sh
 * $ pulumi import azure:datafactory/linkedServiceAzureSearch:LinkedServiceAzureSearch example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example
 * ```
 */
public class LinkedServiceAzureSearch internal constructor(
    override val javaResource: com.pulumi.azure.datafactory.LinkedServiceAzureSearch,
) : KotlinCustomResource(javaResource, LinkedServiceAzureSearchMapper) {
    /**
     * A map of additional properties to associate with the Data Factory Linked Service.
     * The following supported arguments are specific to Azure Search Linked Service:
     */
    public val additionalProperties: Output>?
        get() = javaResource.additionalProperties().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 -> args0.key.to(args0.value) }).toMap()
            }).orElse(null)
        })

    /**
     * List of tags that can be used for describing the Data Factory Linked Service.
     */
    public val annotations: Output>?
        get() = javaResource.annotations().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0
                })
            }).orElse(null)
        })

    /**
     * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
     */
    public val dataFactoryId: Output
        get() = javaResource.dataFactoryId().applyValue({ args0 -> args0 })

    /**
     * The description for the Data Factory Linked Service.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The encrypted credential to connect to Azure Search Service.
     */
    public val encryptedCredential: Output
        get() = javaResource.encryptedCredential().applyValue({ args0 -> args0 })

    /**
     * The integration runtime reference to associate with the Data Factory Linked Service.
     */
    public val integrationRuntimeName: Output?
        get() = javaResource.integrationRuntimeName().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(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](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * A map of parameters to associate with the Data Factory Linked Service.
     */
    public val parameters: Output>?
        get() = javaResource.parameters().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }).orElse(null)
        })

    /**
     * The key of the Azure Search Service.
     */
    public val searchServiceKey: Output
        get() = javaResource.searchServiceKey().applyValue({ args0 -> args0 })

    /**
     * The URL of the Search Service endpoint (e.g. ).
     */
    public val url: Output
        get() = javaResource.url().applyValue({ args0 -> args0 })
}

public object LinkedServiceAzureSearchMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.datafactory.LinkedServiceAzureSearch::class == javaResource::class

    override fun map(javaResource: Resource): LinkedServiceAzureSearch =
        LinkedServiceAzureSearch(
            javaResource as
                com.pulumi.azure.datafactory.LinkedServiceAzureSearch,
        )
}

/**
 * @see [LinkedServiceAzureSearch].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [LinkedServiceAzureSearch].
 */
public suspend fun linkedServiceAzureSearch(
    name: String,
    block: suspend LinkedServiceAzureSearchResourceBuilder.() -> Unit,
): LinkedServiceAzureSearch {
    val builder = LinkedServiceAzureSearchResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [LinkedServiceAzureSearch].
 * @param name The _unique_ name of the resulting resource.
 */
public fun linkedServiceAzureSearch(name: String): LinkedServiceAzureSearch {
    val builder = LinkedServiceAzureSearchResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy