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

com.pulumi.azure.datafactory.kotlin.LinkedServiceOdbcArgs.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.14.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.datafactory.kotlin

import com.pulumi.azure.datafactory.LinkedServiceOdbcArgs.builder
import com.pulumi.azure.datafactory.kotlin.inputs.LinkedServiceOdbcBasicAuthenticationArgs
import com.pulumi.azure.datafactory.kotlin.inputs.LinkedServiceOdbcBasicAuthenticationArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName

/**
 * Manages a Linked Service (connection) between a Database and Azure Data Factory through ODBC protocol.
 * > **Note:** All arguments including the connection_string will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html).
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * 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 anonymous = new azure.datafactory.LinkedServiceOdbc("anonymous", {
 *     name: "anonymous",
 *     dataFactoryId: exampleFactory.id,
 *     connectionString: "Driver={SQL Server};Server=test;Database=test;Uid=test;Pwd=test;",
 * });
 * const basicAuth = new azure.datafactory.LinkedServiceOdbc("basic_auth", {
 *     name: "basic_auth",
 *     dataFactoryId: exampleFactory.id,
 *     connectionString: "Driver={SQL Server};Server=test;Database=test;Uid=test;Pwd=test;",
 *     basicAuthentication: {
 *         username: "onrylmz",
 *         password: "Ch4ngeM3!",
 *     },
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * 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)
 * anonymous = azure.datafactory.LinkedServiceOdbc("anonymous",
 *     name="anonymous",
 *     data_factory_id=example_factory.id,
 *     connection_string="Driver={SQL Server};Server=test;Database=test;Uid=test;Pwd=test;")
 * basic_auth = azure.datafactory.LinkedServiceOdbc("basic_auth",
 *     name="basic_auth",
 *     data_factory_id=example_factory.id,
 *     connection_string="Driver={SQL Server};Server=test;Database=test;Uid=test;Pwd=test;",
 *     basic_authentication=azure.datafactory.LinkedServiceOdbcBasicAuthenticationArgs(
 *         username="onrylmz",
 *         password="Ch4ngeM3!",
 *     ))
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * 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 anonymous = new Azure.DataFactory.LinkedServiceOdbc("anonymous", new()
 *     {
 *         Name = "anonymous",
 *         DataFactoryId = exampleFactory.Id,
 *         ConnectionString = "Driver={SQL Server};Server=test;Database=test;Uid=test;Pwd=test;",
 *     });
 *     var basicAuth = new Azure.DataFactory.LinkedServiceOdbc("basic_auth", new()
 *     {
 *         Name = "basic_auth",
 *         DataFactoryId = exampleFactory.Id,
 *         ConnectionString = "Driver={SQL Server};Server=test;Database=test;Uid=test;Pwd=test;",
 *         BasicAuthentication = new Azure.DataFactory.Inputs.LinkedServiceOdbcBasicAuthenticationArgs
 *         {
 *             Username = "onrylmz",
 *             Password = "Ch4ngeM3!",
 *         },
 *     });
 * });
 * ```
 * ```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/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
 * 		}
 * 		_, err = datafactory.NewLinkedServiceOdbc(ctx, "anonymous", &datafactory.LinkedServiceOdbcArgs{
 * 			Name:             pulumi.String("anonymous"),
 * 			DataFactoryId:    exampleFactory.ID(),
 * 			ConnectionString: pulumi.String("Driver={SQL Server};Server=test;Database=test;Uid=test;Pwd=test;"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = datafactory.NewLinkedServiceOdbc(ctx, "basic_auth", &datafactory.LinkedServiceOdbcArgs{
 * 			Name:             pulumi.String("basic_auth"),
 * 			DataFactoryId:    exampleFactory.ID(),
 * 			ConnectionString: pulumi.String("Driver={SQL Server};Server=test;Database=test;Uid=test;Pwd=test;"),
 * 			BasicAuthentication: &datafactory.LinkedServiceOdbcBasicAuthenticationArgs{
 * 				Username: pulumi.String("onrylmz"),
 * 				Password: pulumi.String("Ch4ngeM3!"),
 * 			},
 * 		})
 * 		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.datafactory.LinkedServiceOdbc;
 * import com.pulumi.azure.datafactory.LinkedServiceOdbcArgs;
 * import com.pulumi.azure.datafactory.inputs.LinkedServiceOdbcBasicAuthenticationArgs;
 * 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 anonymous = new LinkedServiceOdbc("anonymous", LinkedServiceOdbcArgs.builder()
 *             .name("anonymous")
 *             .dataFactoryId(exampleFactory.id())
 *             .connectionString("Driver={SQL Server};Server=test;Database=test;Uid=test;Pwd=test;")
 *             .build());
 *         var basicAuth = new LinkedServiceOdbc("basicAuth", LinkedServiceOdbcArgs.builder()
 *             .name("basic_auth")
 *             .dataFactoryId(exampleFactory.id())
 *             .connectionString("Driver={SQL Server};Server=test;Database=test;Uid=test;Pwd=test;")
 *             .basicAuthentication(LinkedServiceOdbcBasicAuthenticationArgs.builder()
 *                 .username("onrylmz")
 *                 .password("Ch4ngeM3!")
 *                 .build())
 *             .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}
 *   anonymous:
 *     type: azure:datafactory:LinkedServiceOdbc
 *     properties:
 *       name: anonymous
 *       dataFactoryId: ${exampleFactory.id}
 *       connectionString: Driver={SQL Server};Server=test;Database=test;Uid=test;Pwd=test;
 *   basicAuth:
 *     type: azure:datafactory:LinkedServiceOdbc
 *     name: basic_auth
 *     properties:
 *       name: basic_auth
 *       dataFactoryId: ${exampleFactory.id}
 *       connectionString: Driver={SQL Server};Server=test;Database=test;Uid=test;Pwd=test;
 *       basicAuthentication:
 *         username: onrylmz
 *         password: Ch4ngeM3!
 * ```
 * 
 * ## Import
 * Data Factory ODBC Linked Service's can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:datafactory/linkedServiceOdbc:LinkedServiceOdbc example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example
 * ```
 * @property additionalProperties A map of additional properties to associate with the Data Factory Linked Service ODBC.
 * @property annotations List of tags that can be used for describing the Data Factory Linked Service ODBC.
 * @property basicAuthentication A `basic_authentication` block as defined below.
 * @property connectionString The connection string in which to authenticate with ODBC.
 * @property dataFactoryId The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
 * @property description The description for the Data Factory Linked Service ODBC.
 * @property integrationRuntimeName The integration runtime reference to associate with the Data Factory Linked Service ODBC.
 * @property name Specifies the name of the Data Factory Linked Service ODBC. 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.
 * @property parameters A map of parameters to associate with the Data Factory Linked Service ODBC.
 */
public data class LinkedServiceOdbcArgs(
    public val additionalProperties: Output>? = null,
    public val annotations: Output>? = null,
    public val basicAuthentication: Output? = null,
    public val connectionString: Output? = null,
    public val dataFactoryId: Output? = null,
    public val description: Output? = null,
    public val integrationRuntimeName: Output? = null,
    public val name: Output? = null,
    public val parameters: Output>? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.datafactory.LinkedServiceOdbcArgs =
        com.pulumi.azure.datafactory.LinkedServiceOdbcArgs.builder()
            .additionalProperties(
                additionalProperties?.applyValue({ args0 ->
                    args0.map({ args0 ->
                        args0.key.to(args0.value)
                    }).toMap()
                }),
            )
            .annotations(annotations?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
            .basicAuthentication(
                basicAuthentication?.applyValue({ args0 ->
                    args0.let({ args0 ->
                        args0.toJava()
                    })
                }),
            )
            .connectionString(connectionString?.applyValue({ args0 -> args0 }))
            .dataFactoryId(dataFactoryId?.applyValue({ args0 -> args0 }))
            .description(description?.applyValue({ args0 -> args0 }))
            .integrationRuntimeName(integrationRuntimeName?.applyValue({ args0 -> args0 }))
            .name(name?.applyValue({ args0 -> args0 }))
            .parameters(
                parameters?.applyValue({ args0 ->
                    args0.map({ args0 ->
                        args0.key.to(args0.value)
                    }).toMap()
                }),
            ).build()
}

/**
 * Builder for [LinkedServiceOdbcArgs].
 */
@PulumiTagMarker
public class LinkedServiceOdbcArgsBuilder internal constructor() {
    private var additionalProperties: Output>? = null

    private var annotations: Output>? = null

    private var basicAuthentication: Output? = null

    private var connectionString: Output? = null

    private var dataFactoryId: Output? = null

    private var description: Output? = null

    private var integrationRuntimeName: Output? = null

    private var name: Output? = null

    private var parameters: Output>? = null

    /**
     * @param value A map of additional properties to associate with the Data Factory Linked Service ODBC.
     */
    @JvmName("hslckdcmylaydagr")
    public suspend fun additionalProperties(`value`: Output>) {
        this.additionalProperties = value
    }

    /**
     * @param value List of tags that can be used for describing the Data Factory Linked Service ODBC.
     */
    @JvmName("rmyouhvbigujkmrd")
    public suspend fun annotations(`value`: Output>) {
        this.annotations = value
    }

    @JvmName("nbnhdduhmpqoocbe")
    public suspend fun annotations(vararg values: Output) {
        this.annotations = Output.all(values.asList())
    }

    /**
     * @param values List of tags that can be used for describing the Data Factory Linked Service ODBC.
     */
    @JvmName("pwyiiecibdbwpvjd")
    public suspend fun annotations(values: List>) {
        this.annotations = Output.all(values)
    }

    /**
     * @param value A `basic_authentication` block as defined below.
     */
    @JvmName("rwtlrumkdciwnour")
    public suspend
    fun basicAuthentication(`value`: Output) {
        this.basicAuthentication = value
    }

    /**
     * @param value The connection string in which to authenticate with ODBC.
     */
    @JvmName("nhefgusmqgdcfosd")
    public suspend fun connectionString(`value`: Output) {
        this.connectionString = value
    }

    /**
     * @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
     */
    @JvmName("xwhhdpaagulipjox")
    public suspend fun dataFactoryId(`value`: Output) {
        this.dataFactoryId = value
    }

    /**
     * @param value The description for the Data Factory Linked Service ODBC.
     */
    @JvmName("tvrwwyxrqljstsxh")
    public suspend fun description(`value`: Output) {
        this.description = value
    }

    /**
     * @param value The integration runtime reference to associate with the Data Factory Linked Service ODBC.
     */
    @JvmName("hxckxvnmurodkirs")
    public suspend fun integrationRuntimeName(`value`: Output) {
        this.integrationRuntimeName = value
    }

    /**
     * @param value Specifies the name of the Data Factory Linked Service ODBC. 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.
     */
    @JvmName("uptvmlsavtnnvtei")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value A map of parameters to associate with the Data Factory Linked Service ODBC.
     */
    @JvmName("syphukppjkilvaru")
    public suspend fun parameters(`value`: Output>) {
        this.parameters = value
    }

    /**
     * @param value A map of additional properties to associate with the Data Factory Linked Service ODBC.
     */
    @JvmName("nmeeyyhtbigdbowi")
    public suspend fun additionalProperties(`value`: Map?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.additionalProperties = mapped
    }

    /**
     * @param values A map of additional properties to associate with the Data Factory Linked Service ODBC.
     */
    @JvmName("ebajdbnkkgopgofo")
    public fun additionalProperties(vararg values: Pair) {
        val toBeMapped = values.toMap()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.additionalProperties = mapped
    }

    /**
     * @param value List of tags that can be used for describing the Data Factory Linked Service ODBC.
     */
    @JvmName("dgsrkhiivxrgpuaa")
    public suspend fun annotations(`value`: List?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.annotations = mapped
    }

    /**
     * @param values List of tags that can be used for describing the Data Factory Linked Service ODBC.
     */
    @JvmName("usicqyoitailauvy")
    public suspend fun annotations(vararg values: String) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.annotations = mapped
    }

    /**
     * @param value A `basic_authentication` block as defined below.
     */
    @JvmName("embbkbyvxspruwpw")
    public suspend fun basicAuthentication(`value`: LinkedServiceOdbcBasicAuthenticationArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.basicAuthentication = mapped
    }

    /**
     * @param argument A `basic_authentication` block as defined below.
     */
    @JvmName("uwgpiaobtodlhdjq")
    public suspend
    fun basicAuthentication(argument: suspend LinkedServiceOdbcBasicAuthenticationArgsBuilder.() -> Unit) {
        val toBeMapped = LinkedServiceOdbcBasicAuthenticationArgsBuilder().applySuspend {
            argument()
        }.build()
        val mapped = of(toBeMapped)
        this.basicAuthentication = mapped
    }

    /**
     * @param value The connection string in which to authenticate with ODBC.
     */
    @JvmName("btklhvkxtdroryhh")
    public suspend fun connectionString(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.connectionString = mapped
    }

    /**
     * @param value The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
     */
    @JvmName("klhctiegpqqqxhjy")
    public suspend fun dataFactoryId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.dataFactoryId = mapped
    }

    /**
     * @param value The description for the Data Factory Linked Service ODBC.
     */
    @JvmName("umvsocysvpdsiwqq")
    public suspend fun description(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.description = mapped
    }

    /**
     * @param value The integration runtime reference to associate with the Data Factory Linked Service ODBC.
     */
    @JvmName("rfgsedktfpchxnvl")
    public suspend fun integrationRuntimeName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.integrationRuntimeName = mapped
    }

    /**
     * @param value Specifies the name of the Data Factory Linked Service ODBC. 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.
     */
    @JvmName("jcrfoquonhgfxafb")
    public suspend fun name(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.name = mapped
    }

    /**
     * @param value A map of parameters to associate with the Data Factory Linked Service ODBC.
     */
    @JvmName("fgxwvwanvvcuddrn")
    public suspend fun parameters(`value`: Map?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.parameters = mapped
    }

    /**
     * @param values A map of parameters to associate with the Data Factory Linked Service ODBC.
     */
    @JvmName("egvjursfoxvqhlre")
    public fun parameters(vararg values: Pair) {
        val toBeMapped = values.toMap()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.parameters = mapped
    }

    internal fun build(): LinkedServiceOdbcArgs = LinkedServiceOdbcArgs(
        additionalProperties = additionalProperties,
        annotations = annotations,
        basicAuthentication = basicAuthentication,
        connectionString = connectionString,
        dataFactoryId = dataFactoryId,
        description = description,
        integrationRuntimeName = integrationRuntimeName,
        name = name,
        parameters = parameters,
    )
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy